diff --git a/src/frontend/config/aspire-versions.mjs b/src/frontend/config/aspire-versions.mjs
index d040055168..f7b6145a04 100644
--- a/src/frontend/config/aspire-versions.mjs
+++ b/src/frontend/config/aspire-versions.mjs
@@ -1,8 +1,8 @@
-export const currentAspireMajorMinorVersion = '13.6';
-export const currentAspireVersion = '13.6.0';
+export const currentAspireMajorMinorVersion = '17.0';
+export const currentAspireVersion = '17.0.0';
// Release date (YYYY-MM-DD) of currentAspireVersion; update together with the version.
-export const currentAspireReleaseDate = '2026-09-29';
-export const currentAspirePreviewVersion = '13.6.0-preview.1.26479.8';
+export const currentAspireReleaseDate = '2026-11-17';
+export const currentAspirePreviewVersion = '17.0.0-preview.1.26480.6';
export const aspireVersionPlaceholders = Object.freeze({
'%ASPIRE_VERSION_MAJOR_MINOR%': currentAspireMajorMinorVersion,
diff --git a/src/frontend/src/components/live-status.ts b/src/frontend/src/components/live-status.ts
index 7bc3c5fb0a..01ab844a06 100644
--- a/src/frontend/src/components/live-status.ts
+++ b/src/frontend/src/components/live-status.ts
@@ -112,10 +112,9 @@ function syncDom(): void {
btn.dataset.pipOpen = pipOpen ? 'true' : 'false';
btn.dataset.liveDismissed = notificationDismissed ? 'true' : 'false';
btn.dataset.source = sourceAttr;
- btn.setAttribute(
- 'aria-label',
- current.isLive ? 'Aspire is live β watch now' : 'Watch Aspire live streams'
- );
+ const label = current.isLive ? 'Aspire is live β watch now' : 'Watch Aspire live streams';
+ btn.setAttribute('aria-label', label);
+ btn.setAttribute('title', label);
});
}
diff --git a/src/frontend/src/components/starlight/Header.astro b/src/frontend/src/components/starlight/Header.astro
index eb0e028e62..e31558e71b 100644
--- a/src/frontend/src/components/starlight/Header.astro
+++ b/src/frontend/src/components/starlight/Header.astro
@@ -44,6 +44,7 @@ const tryLabel = t('header.try' as any);
data-tour-target="install-cli"
data-tour-step="install-cli"
aria-label="Open install Aspire CLI dialog"
+ title="Install Aspire CLI"
>
Install Aspire CLI
@@ -55,6 +56,7 @@ const tryLabel = t('header.try' as any);
data-source="none"
data-tour-target="live-status"
aria-label="Watch Aspire live streams"
+ title="Watch Aspire live streams"
aria-current={Astro.url.pathname === '/community/videos/' ? 'page' : undefined}
>
Watch Aspire live streams
@@ -71,6 +73,7 @@ const tryLabel = t('header.try' as any);
data-tour-target="cookie-preferences"
data-tour-step="cookie-preferences"
aria-label="Open cookie preferences dialog"
+ title="Cookie preferences"
>
Cookie Preferences
diff --git a/src/frontend/src/content/docs/app-host/configuration.mdx b/src/frontend/src/content/docs/app-host/configuration.mdx
index 026f681f5f..b70cb77388 100644
--- a/src/frontend/src/content/docs/app-host/configuration.mdx
+++ b/src/frontend/src/content/docs/app-host/configuration.mdx
@@ -134,7 +134,8 @@ In Go AppHosts, profiles live in `aspire.config.json`:
| Option | Default value | Description |
| ---------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ASPIRE_ALLOW_UNSECURED_TRANSPORT` | `false` | Allows communication with the AppHost without https. `ASPNETCORE_URLS` (dashboard address) and `ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL` (AppHost resource service address) must be secured with HTTPS unless true. |
-| `ASPIRE_CONTAINER_RUNTIME` | Auto-detected | Selects the runtime for container resources. Supported values are `docker`, `podman`, and `wslc`. WSLc is supported only on Windows and only for local development. Publish and deploy are not yet supported. See [container runtime prerequisites](/get-started/prerequisites/#install-an-oci-compliant-container-runtime). |
+| `ASPIRE_CONTAINER_RUNTIME` | Auto-detected | Selects the runtime for container resources. Supported values are `docker`, `podman`, and `wslc`. WSLc is supported only on Windows and has limited publishing support; Docker Compose deployment isn't supported. See [container runtime prerequisites](/get-started/prerequisites/#install-an-oci-compliant-container-runtime). |
+| `ASPIRE_CONTAINER_TUNNEL_BASE_IMAGE` | `null` | Overrides the base image used to build the [container tunnel](/fundamentals/container-networking/) proxy image, such as a mirrored copy for networks that can't reach the default image. `DcpPublisher:ContainerTunnelBaseImage` and the `--dcp-container-tunnel-base-image` AppHost argument take precedence. The Aspire CLI sets this variable from the `containerTunnel.baseImage` setting when it isn't already set. |
| `ASPIRE_DCP_USE_DEVELOPER_CERTIFICATE` | `true` | When `true` (the default), Aspire uses the ASP.NET Core developer certificate to secure the internal DCP server instead of an ephemeral certificate generated by DCP. On Windows, Aspire passes the certificate thumbprint to DCP. On macOS and Linux, Aspire passes the certificate and private key file paths (plus the thumbprint) so DCP can verify the loaded certificate. Set to `false` to opt out and use DCP's default ephemeral certificate. If no trusted developer certificate is found, Aspire automatically falls back to the ephemeral certificate. For more information, see [Certificate configuration](/app-host/certificate-configuration/). |
| `ASPIRE_ENVIRONMENT` | `null` | Configures the AppHost environment when no higher-priority environment source is set. If no environment is configured, the AppHost uses `Production`. |
| `ASPIRE_VERSION_CHECK_DISABLED` | `false` | When set to `true`, Aspire doesn't check for newer versions on startup. |
@@ -187,7 +188,26 @@ By default, the dashboard is automatically started by the AppHost. The dashboard
| `ASPIRE_DASHBOARD_API_ENABLED` | `true` | Enables the dashboard [telemetry API](/dashboard/configuration/#api) (`/api/telemetry/*`) endpoints. The AppHost always sets this to `true`. |
| `ASPIRE_DASHBOARD_FORWARDEDHEADERS_ENABLED` | `false` | Enables the Forwarded headers middleware that replaces the scheme and host values on the Request context with the values coming from the `X-Forwarded-Proto` and `X-Forwarded-Host` headers. |
| `ASPIRE_DASHBOARD_PERSISTENCE_MODE` | `Run` | Configures [dashboard data persistence](/dashboard/data-persistence/). Valid values are `None`, `Run`, and `Resume`. The AppHost automatically sets this value to `Run`. |
-| `ASPIRE_DASHBOARD_DATA_DIRECTORY` | `/dashboard` | Configures the root directory for persistent dashboard data. The directory must be writable by the account running the dashboard and have restrictive file-system permissions because it can contain sensitive data. |
+| `ASPIRE_DASHBOARD_DATA_DIRECTORY` | `/dashboard` | Configures the root directory for persistent dashboard data. The directory must be writable by the account running the dashboard and have restrictive file-system permissions because it can contain sensitive data. A relative path is resolved against the AppHost directory. |
+
+## DCP API timeouts
+
+The AppHost communicates with the Developer Control Plane (DCP) through a local Kubernetes-style API. If DCP responds slowly, such as on resource-constrained CI agents or heavily loaded machines, increase these timeouts. Set them as environment variables in your launch profile, or in any other AppHost configuration source. Values use the `hh:mm:ss` format.
+
+```json title="JSON β Launch profile environment variables"
+{
+ "environmentVariables": {
+ "DcpPublisher__KubernetesApiTimeout": "00:01:00",
+ "DcpPublisher__KubernetesCreateRecoveryTimeout": "00:03:00"
+ }
+}
+```
+
+| Option | Default value | Description |
+| --------------------------------------------------------- | ------------- | ----------- |
+| `DcpPublisher:KubernetesApiTimeout` | `00:00:40` | Time budget for a single API operation, such as connecting to DCP or sending a request. Doesn't limit the lifetime of established watch and log streams. Valid values range from one second to ten minutes. |
+| `DcpPublisher:KubernetesInitializationAdditionalTimeout` | `00:00:20` | Extra time added to `KubernetesApiTimeout` until the first API operation succeeds, to cover one-time client setup. Can be zero. The combined value can't exceed ten minutes. |
+| `DcpPublisher:KubernetesCreateRecoveryTimeout` | `00:02:00` | Total time budget for creating a resource in DCP, including client setup, retries, and recovery. If a create request times out or returns HTTP 504, the AppHost checks whether DCP already created the resource before retrying, instead of failing the resource immediately. Valid values range from one second to ten minutes. |
## Internal
diff --git a/src/frontend/src/content/docs/app-host/console-apps.mdx b/src/frontend/src/content/docs/app-host/console-apps.mdx
index 0a3a81af17..3288f3be0a 100644
--- a/src/frontend/src/content/docs/app-host/console-apps.mdx
+++ b/src/frontend/src/content/docs/app-host/console-apps.mdx
@@ -741,11 +741,7 @@ With `WithExplicitStart`, the resource appears in the Aspire dashboard but doesn
user input to the process's stdin.
-Aspire builds that include the experimental `WithTerminal` API support interactive terminal user interfaces (TUIs) and shell-based experiences that need a live, bidirectional session, separately from the dashboard's console log viewer.
-
-:::caution[Experimental API]
-`WithTerminal` is reported under diagnostic ID `ASPIRETERMINAL001`. Using it in C# requires suppressing that diagnostic, and its API surface and behavior may change. This API might not be present in your installed release; use compatible hosting packages and a CLI build that includes it.
-:::
+Use the `WithTerminal` API for interactive terminal user interfaces (TUIs) and shell-based experiences that need a live, bidirectional session, separately from the dashboard's console log viewer. For more information, see [Attach a terminal to a resource](/app-host/with-terminal/).
## Viewing console output
diff --git a/src/frontend/src/content/docs/app-host/go-apphost-conventions.mdx b/src/frontend/src/content/docs/app-host/go-apphost-conventions.mdx
index 98798d978a..8c2662fca1 100644
--- a/src/frontend/src/content/docs/app-host/go-apphost-conventions.mdx
+++ b/src/frontend/src/content/docs/app-host/go-apphost-conventions.mdx
@@ -10,8 +10,25 @@ The Aspire CLI generates the Go SDK from the integrations in your `aspire.config
Every integration adds its methods to the `aspire` package, and method names are PascalCase. The TypeScript method `addRedis` is `AddRedis` in Go.
+Numeric parameters and fields use the Go type that matches the .NET type, such as `int` for a port and `int64` for a file size. Methods and properties that are marked obsolete in .NET aren't generated.
+
Methods that add a resource, such as `AddRedis` and `AddGoApp`, return a _handle_. A handle is a Go interface that stands for the resource in the app model, for example `aspire.RedisResource`. Methods that configure a resource return the same handle type, so calls chain. Errors are reported when you call `Build`, as described in [Errors](#errors).
+### Pass derived resource handles
+
+Go interfaces don't support covariant return types, so the handle for a derived resource type doesn't satisfy the handle interface of its base type. When other resource types derive from a type, the SDK also generates an `Any` interface that accepts a handle of that type or of any type derived from it. Parameters that take such a resource use this interface. For example, `WithNodePool` takes an `aspire.AnyKubernetesNodePoolResource`, so it accepts the `aspire.AksNodePoolResource` handle that `AddNodePool` returns:
+
+```go title="apphost.go"
+aks := builder.AddAzureKubernetesEnvironment("aks")
+pool := aks.AddNodePool("workload", func(config *aspire.AksNodePoolConfig) {
+ config.MaxCount = 5
+})
+
+builder.AddContainer("api", "nginx").WithNodePool(pool)
+```
+
+The compiler rejects a handle of an unrelated resource type. Methods still return the receiver's own handle type, so chained calls keep their type.
+
## Optional parameters
Optional parameters go in a trailing variadic options argument. Leave it out to use the defaults, or pass typed option values for the settings you want to change. You don't need an options struct or pointer helpers:
@@ -41,7 +58,7 @@ The [`WithHttpEndpoint` API reference](/reference/api/go/aspire.hosting/withhttp
The SDK reports errors in two ways.
-Methods that add or configure a resource return a handle instead of an error, so you can add many resources without checking each call. The SDK aggregates the errors and reports them when you call `Build`:
+Methods that add or configure a resource return a handle instead of an error, so you can add many resources without checking each call. A failed resource doesn't stop you from adding other resources. The SDK collects the error from every failed handle and `Build` returns them together, joined with `errors.Join`:
```go title="apphost.go"
cache := builder.AddRedis("cache")
@@ -53,6 +70,8 @@ if err != nil {
}
```
+Each failure is reported once, even when it passes through a chain of calls. To check for errors before you call `Build`, call `builder.Err()`, which returns the same combined error. To check a single resource, call the `Err()` method on its handle, which returns the first error recorded for that resource.
+
Methods that return a value return a `(T, error)` pair, and `Build` and `Run` return an `error`:
```go title="apphost.go"
@@ -64,7 +83,9 @@ if err != nil {
log.Println("AppHost directory:", dir)
```
-`aspire.FormatError` turns an error into a message that is ready to log. When the AppHost server returns an error for a call, the error is an `*aspire.CapabilityError`, and `FormatError` adds its error code and the capability that failed. Use `errors.As` and the `Code`, `Message`, and `Capability` methods to read these values yourself. For any other error, `FormatError` returns `err.Error()`.
+`aspire.FormatError` turns an error into a message that is ready to log. When the AppHost server returns an error for a call, the error is an `*aspire.CapabilityError`, and `FormatError` adds its error code and the capability that failed. Use `errors.As` and the `Code`, `Message`, and `Capability` methods to read these values yourself. When the error combines several errors, such as the error that `Build` returns, `FormatError` formats each one on its own line. For any other error, `FormatError` returns `err.Error()`.
+
+If a callback that you pass to an SDK method panics, the AppHost process keeps running. The SDK recovers the panic and fails only the call that invoked the callback.
## Cancellation
diff --git a/src/frontend/src/content/docs/app-host/with-terminal.mdx b/src/frontend/src/content/docs/app-host/with-terminal.mdx
index 14268aeac8..e5773732ab 100644
--- a/src/frontend/src/content/docs/app-host/with-terminal.mdx
+++ b/src/frontend/src/content/docs/app-host/with-terminal.mdx
@@ -16,10 +16,6 @@ If you have a terminal user interface (TUI) application or a shell-based experie
For an introduction to the resource Terminal view, terminal dock, and detached windows, start with [Dashboard terminals](/dashboard/terminals/).
-:::caution[Aspire 17.0 preview]
-This page describes resource-terminal behavior and defaults for Aspire 17.0 preview. Use matching AppHost, dashboard, and CLI builds.
-:::
-
## Prerequisites
Start with a [TypeScript or C# AppHost](/get-started/app-host/) and an installed interactive program. Resource terminals support executable and project processes on Windows, macOS, and Linux, as well as container processes through the container runtime. Containers require a [supported container runtime](/get-started/prerequisites/).
@@ -58,7 +54,7 @@ builder.Build().Run();
-Start the app with `aspire run`, select `repl` on the dashboard's **Console logs** page, and switch to **Terminal** if needed. At the Python prompt, enter `print("Hello from Aspire")`. You can also run `aspire terminal attach repl` after [enabling the CLI commands](#work-with-terminals-from-the-cli).
+Start the app with `aspire run`, select `repl` on the dashboard's **Console logs** page, and switch to **Terminal** if needed. At the Python prompt, enter `print("Hello from Aspire")`. You can also use [`aspire terminal attach repl`](#work-with-terminals-from-the-cli).
## When to use WithTerminal
@@ -105,11 +101,20 @@ The terminal session is described by a set of options with sensible defaults:
| `Columns` | `132` | The initial number of columns for the terminal grid. |
| `Rows` | `50` | The initial number of rows for the terminal grid. |
+On the resource **Terminal** page, the dashboard automatically fits the terminal grid to the view when you open the terminal unless you set `Columns` or `Rows`. Setting either dimension, even to its default value, turns off automatic fitting on that page until you request a resize. A configuration callback that doesn't set either dimension keeps automatic fitting. The terminal dock still automatically fits its resource-terminal pane when it opens, even if you set dimensions.
+
+
+
+
+
## Display messages
There are several ways to display messages to the user:
diff --git a/src/frontend/src/content/docs/fundamentals/container-networking.mdx b/src/frontend/src/content/docs/fundamentals/container-networking.mdx
index 6aba3a10b2..9924fb4526 100644
--- a/src/frontend/src/content/docs/fundamentals/container-networking.mdx
+++ b/src/frontend/src/content/docs/fundamentals/container-networking.mdx
@@ -177,6 +177,16 @@ aspire run
When the tunnel is disabled, containers fall back to platform-specific mechanisms (such as `host.docker.internal`) to reach host-based services.
+## Use a custom tunnel base image
+
+DCP builds the tunnel proxy image from a base image. If your environment can't reach the default image, such as on an isolated network, or requires a mirrored or customized image, override the base image with the Aspire CLI:
+
+```bash title="Set the container tunnel base image"
+aspire config set containerTunnel.baseImage myregistry.example.com/aspire-tunnel:1.0
+```
+
+The CLI passes this value to the AppHost as the `ASPIRE_CONTAINER_TUNNEL_BASE_IMAGE` environment variable. You can also set that environment variable directly, the `DcpPublisher:ContainerTunnelBaseImage` AppHost configuration value, or the `--dcp-container-tunnel-base-image` AppHost argument. The AppHost configuration value and argument take precedence over the environment variable, and an existing environment variable takes precedence over the `containerTunnel.baseImage` setting.
+
## When to use the container tunnel
The container tunnel is useful whenever containers need to communicate with host-based services. Common scenarios include:
diff --git a/src/frontend/src/content/docs/fundamentals/networking-overview.mdx b/src/frontend/src/content/docs/fundamentals/networking-overview.mdx
index 8e24b15c5a..6c79b55dd4 100644
--- a/src/frontend/src/content/docs/fundamentals/networking-overview.mdx
+++ b/src/frontend/src/content/docs/fundamentals/networking-overview.mdx
@@ -729,6 +729,57 @@ builder.Build().Run();
+## Browser-facing origins
+
+The URL that a browser uses for a resource can differ from the endpoint's allocated address. For example, the dashboard might show a `*.dev.localhost` URL, a customized URL, or a GitHub Codespaces forwarding URL. Settings that must match what the browser sends, such as a CORS allow list or an authentication redirect URI, need that browser-facing origin rather than the service discovery address.
+
+Each endpoint reference exposes two deferred values for this purpose:
+
+- `PrimaryBrowserOrigin`: Resolves to a single preferred HTTP(S) origin.
+- `BrowserOrigins`: Resolves to a comma-separated list of distinct HTTP(S) origins.
+
+
+
+
+```typescript title="apphost.mts"
+const frontendEndpoint = await frontend.getEndpoint('https');
+
+await api.withEnvironment('FRONTEND_ORIGIN', await frontendEndpoint.primaryBrowserOrigin.get());
+await api.withEnvironment('ALLOWED_ORIGINS', await frontendEndpoint.browserOrigins.get());
+```
+
+
+
+
+```csharp title="AppHost.cs"
+var frontendEndpoint = frontend.GetEndpoint("https");
+
+api.WithEnvironment("FRONTEND_ORIGIN", frontendEndpoint.PrimaryBrowserOrigin);
+api.WithEnvironment("ALLOWED_ORIGINS", frontendEndpoint.BrowserOrigins);
+```
+
+
+
+
+These values don't change how resources reach each other through service discovery, and they resolve the same way regardless of whether the consuming resource runs on the host or in a container.
+
+During local runs, the origins come from the endpoint's final URLs, after URL customization and Codespaces forwarding are applied, in the same order the URLs are displayed. Each origin contains only the scheme, host, and port. The allocated HTTP(S) origin is always included after any customized origins, even if you remove its dashboard link. `PrimaryBrowserOrigin` is the first origin in that list. If the endpoint has no HTTP(S) origins, both values resolve to an empty string.
+
+When you publish, local URLs aren't deployment addresses, so each compute environment resolves the values from its deployed endpoints:
+
+| Compute environment | Behavior |
+| --- | --- |
+| Azure Container Apps and Azure App Service | Uses the public deployed HTTP(S) origins. Internal and non-HTTP(S) endpoints are rejected. |
+| Docker Compose | Uses deployment parameters. External HTTP(S) endpoints with an explicit published port default to `localhost` and that port. Provide a value when the published port isn't known. |
+| Kubernetes | Uses deployment parameters. Defaults come from matching literal Ingress or Gateway hostnames and their TLS configuration. Provide a value for hostless routes, wildcard hosts, or deferred hostnames. |
+| Radius | Uses required deployment parameters for external HTTP(S) endpoints. |
+
+Docker Compose, Kubernetes, and Radius use separate parameters for the two values. For example, the `web` resource's `http` endpoint reads `Parameters:web-http-PrimaryBrowserOrigin` for its single origin and `Parameters:web-http-BrowserOrigins` for its origin list.
+
+
+ For authentication redirects that use the same browser origin, see [Keep browser origins consistent](/integrations/security/microsoft-entra-id/redirect-uris-and-sign-in/#keep-browser-origins-consistent).
+
+
## Container-to-host networking
The DCP container tunnel is enabled by default and provides container-to-host connectivity for TCP endpoints when you use `WithReference`. With the tunnel enabled, references to host project or executable endpoints using another transport protocol aren't supported. Runtime-specific host gateway names such as `host.docker.internal` are fallbacks for when the tunnel is disabled.
diff --git a/src/frontend/src/content/docs/get-started/aspire-sdk.mdx b/src/frontend/src/content/docs/get-started/aspire-sdk.mdx
index 9eb8a62e7c..5d69323933 100644
--- a/src/frontend/src/content/docs/get-started/aspire-sdk.mdx
+++ b/src/frontend/src/content/docs/get-started/aspire-sdk.mdx
@@ -167,3 +167,5 @@ Set `AspireCliInvocationMode` in your AppHost `.csproj`:
:::note
`dotnet run` is noninteractive, so `dnx` restores and executes without prompting for confirmation and uses your configured NuGet sources. Restore or probe failures fail explicitly instead of falling back to an incomplete direct launch. If `dnx` can't be found on `PATH` when `Dnx` or `DnxPinned` mode is configured, the run preflight emits error `ASPIRE011` when it prepares the launch command. Install or use the .NET SDK 10.0 or later, set `AspireCliInvocationMode` to `Path` to use the global `aspire` command, or set `AspireCliPath` to an explicit Aspire CLI executable.
:::
+
+`dotnet run` hands the AppHost to `aspire run`, so use it only to run the AppHost locally. To generate deployment artifacts, use [`aspire publish`](/reference/cli/commands/aspire-publish/) instead of `dotnet run --operation publish`. An AppHost started in publish mode this way fails with an error that points you to `aspire publish`. For more information, see [`dotnet run --operation publish` fails in publish mode](/get-started/troubleshooting/#dotnet-run---operation-publish-fails-in-publish-mode).
diff --git a/src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx b/src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx
index 3937b64567..f618809aa6 100644
--- a/src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx
+++ b/src/frontend/src/content/docs/get-started/aspire-vscode-extension.mdx
@@ -136,7 +136,7 @@ The workspace must be trusted, and the VS Code host must support the language mo
When an AppHost is running, the extension paints live state directly into your editor.
-**CodeLens** appears above each resource definition in C# and TypeScript AppHosts. It shows the current state and health and exposes one-click `Start`, `Stop`, `Restart`, and `View Logs` actions in addition to any custom commands the resource publishes.
+**CodeLens** appears above each resource definition in C#, TypeScript, and Go AppHosts. It shows the current state and health and exposes one-click `Start`, `Stop`, `Restart`, and `View Logs` actions in addition to any custom commands the resource publishes.
**Editor title bar buttons** add **Run Aspire AppHost** and **Debug Aspire AppHost** actions next to the standard Run/Debug buttons whenever you have an AppHost file open.
@@ -191,7 +191,9 @@ Enable the **Aspire: Enable Aspire Cli Debug Logging** setting (`aspire.enableAs
**Aspire: Configure launch.json file** adds a minimal launch configuration `.vscode/launch.json` that supports AppHosts written in any language. AppHosts are discovered automatically in the workspace.
-Go AppHosts (`apphost.go`) run and debug the same way, using the [Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go)'s Delve debugger. If the Go extension isn't installed, the Aspire extension shows an error instead of starting the AppHost.
+Go AppHosts (`apphost.go`) run and debug the same way, using the [Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go)'s Delve debugger. If the Go extension isn't installed or is disabled when you start debugging, the Aspire extension prompts you to set up Go debugging instead of starting the AppHost. Select **Set Up** to install the required extension, or use **Run Without Debugging** to start the AppHost without a debugger. Java and Rust AppHosts use the same prompt when their debugger extensions are missing.
+
+The debugger uses the Go toolchain selected by the Go extension's settings, such as `go.goroot` and `go.alternateTools`, while the Aspire CLI uses the `go` command on its `PATH`. If you have more than one Go installation, keep these selections aligned.
To launch a specific AppHost, configure an [aspire.config.json](/reference/cli/configuration/) with an `appHost.path` property.
diff --git a/src/frontend/src/content/docs/get-started/deploy-first-app.mdx b/src/frontend/src/content/docs/get-started/deploy-first-app.mdx
index 4be4118ea9..e2297388d2 100644
--- a/src/frontend/src/content/docs/get-started/deploy-first-app.mdx
+++ b/src/frontend/src/content/docs/get-started/deploy-first-app.mdx
@@ -20,10 +20,6 @@ import csharpStarterPng from '@assets/get-started/csharp-starter.png';
import javascriptStarterDarkPng from '@assets/get-started/javascript-starter-dark.png';
import javascriptStarterLightPng from '@assets/get-started/javascript-starter-light.png';
-:::note[Dashboard image in these examples]
-The Docker Compose examples on this page intentionally select `mcr.microsoft.com/aspire/nightly/dashboard:latest`. This floating tag follows the latest nightly dashboard image; it isn't an immutable digest or a stable release. Your installed Aspire publisher can generate a different repository or pin a version-line tag, so these examples don't guarantee its default output. For image selection and compatibility guidance, see [Container image repositories and migration](/dashboard/standalone/#container-image-repositories-and-migration).
-:::
-
+
+ ```bash title="Aspire CLI - Deploy Go/React app with Docker Compose"
+ π οΈ Executing step deploy
+ 07:00:31 (validate-compute-environments) β Starting validate-compute-environments...
+ 07:00:31 (validate-compute-environments) β validate-compute-environments completed successfully
+ 07:00:31 (prepare-deployment-targets-env) β Starting prepare-deployment-targets-env...
+ 07:00:31 (prepare-deployment-targets-env) i [INF] Creating Docker Compose resource for env-dashboard
+ 07:00:31 (prepare-deployment-targets-env) i [INF] Creating Docker Compose resource for app
+ 07:00:31 (prepare-deployment-targets-env) β prepare-deployment-targets-env completed successfully
+ 07:00:31 (validate-docker-compose) β Starting validate-docker-compose...
+ 07:00:31 (validate-docker-compose) β validate-docker-compose completed successfully
+ 07:00:31 (pipeline-execution) β Starting pipeline-execution...
+ 07:00:31 (validate-go-dockerfile-package-path-app) β validate-go-dockerfile-package-path-app completed successfully
+ 07:00:31 (publish-env) i [INF] Generating Compose output
+ 07:00:31 (deploy-prereq) i [INF] Initializing deployment for environment 'Production'
+ 07:00:31 (deploy-prereq) i [INF] Setting default deploy tag 'aspire-deploy-20261117130031' for compute resource(s).
+ 07:00:31 (publish-env) β Docker Compose file written successfully to ./aspire-output/docker-compose.yaml. (0.0s)
+ 07:00:34 (check-container-runtime) β check-container-runtime completed successfully
+ 07:00:34 (build-frontend) i [INF] Building container image for resource frontend
+ 07:01:38 (build-frontend) β build-frontend completed successfully
+ 07:01:38 (build-app) i [INF] Building container image for resource app
+ 07:02:12 (build-app) β build-app completed successfully
+ 07:02:13 (push-app) β Successfully tagged app as app:aspire-deploy-20261117130031 (1.3s)
+ 07:02:13 (docker-compose-up-env) β Running compose up for env using Docker
+ 07:02:25 (docker-compose-up-env) β Service env is now running with Docker Compose locally (runtime: Docker) (12.0s)
+ 07:02:29 (print-env-dashboard-summary) i [INF] Successfully deployed env-dashboard to http://localhost:65415.
+ 07:02:29 (print-app-summary) i [INF] Successfully deployed app to http://localhost:65414.
+ 07:02:29 (deploy) β deploy completed successfully
+ 07:02:29 (pipeline-execution) β Completed successfully
+ ------------------------------------------------------------
+ β 25/25 steps succeeded β’ Total time: 1m 58s
+
+ Steps Summary:
+ Step timeline: 0s 1m 58s
+ βββββββββ¬βββββββ¬ββββββ¬ββββββββ
+ 1m 58s β pipeline-execution ββΆβββββββββββββββββββββββββββ΄β
+ 25.65ms β publish-env ββ΄ β
+ 1m 3s β build-frontend ββΆββββββββββββββββ΄ β
+ 33.67s β build-app β βΆββββββββ΄ β
+ 11.96s β docker-compose-up-env β βΆβββ΄ β
+ 4.45s β print-app-summary β βΆββ΄β
+ 4.11s β print-env-dashboard-summary β β΄ β
+ 1.32s β push-app β β΄ β
+ (remaining steps omitted)
+
+ β Pipeline succeeded
+
+ env-dashboard: http://localhost:65415
+ app: http://localhost:65414
+ ------------------------------------------------------------
+ ```
+
+
+
@@ -1077,7 +1131,51 @@ Now that you've added the deployment package and updated your AppHost, you can d
aspire deploy
```
- The Aspire CLI prompts for the Azure subscription, location, and resource group if they aren't already configured. The deploy builds one image for the `app` resource (the Go API with the bundled React frontend), pushes it to an Azure Container Registry, and deploys it to an Azure Container Apps environment.
+ The Aspire CLI prompts for the Azure subscription, location, and resource group if they aren't already configured. To avoid prompts (for example, in CI/CD), set the `Azure__SubscriptionId`, `Azure__Location`, and `Azure__ResourceGroup` environment variables. The deploy builds one image for the `app` resource (the Go API with the bundled React frontend), pushes it to an Azure Container Registry, and deploys it to an Azure Container Apps environment.
+
+ Consider the following example output:
+
+
+
+ ```bash title="Aspire CLI - Deploy Go/React app to Azure App Containers"
+ π οΈ Executing step deploy
+ 07:10:15 (prepare-azure-container-apps-env) i [INF] HTTP endpoints will use HTTPS (port 443) in Azure Container Apps: app:http. To opt out, use .WithHttpsUpgrade(false) on the container app environment.
+ 07:10:15 (pipeline-execution) β Starting pipeline-execution...
+ 07:10:15 (validate-go-dockerfile-package-path-app) β validate-go-dockerfile-package-path-app completed successfully
+ 07:10:15 (deploy-prereq) i [INF] Initializing deployment for environment 'Production'
+ 07:10:15 (deploy-prereq) i [INF] Setting default deploy tag 'aspire-deploy-20261117131015' for compute resource(s).
+ 07:10:18 (validate-azure-login) β Azure CLI authentication validated successfully
+ 07:10:18 (create-provisioning-context) i [INF] Using AzureCliCredential for provisioning.
+ 07:10:22 (create-provisioning-context) i [INF] Using existing resource group rg-aspire-go-first-app.
+ 07:10:24 (provision-env-acr) β Using existing deployment for env-acr (0.0s)
+ 07:10:24 (provision-env) β Using existing deployment for env (0.0s)
+ 07:10:30 (login-to-acr-env-acr) β Successfully logged in to envacr6u4w7ohoverv6.azurecr.io (6.3s)
+ 07:10:35 (build-frontend) β build-frontend completed successfully
+ 07:10:49 (build-app) β build-app completed successfully
+ 07:11:02 (push-app) β Successfully pushed app to envacr6u4w7ohoverv6.azurecr.io/app:aspire-deploy-20261117131015 (12.9s)
+ 07:11:02 (provision-app-containerapp) β Deploying app-containerapp
+ 07:11:46 (provision-app-containerapp) β Successfully provisioned app-containerapp (44.1s)
+ 07:11:46 (print-dashboard-url-env) β Dashboard available at https://aspire-dashboard.ext..westus3.azurecontainerapps.io
+ 07:11:46 (print-app-summary) i [INF] Successfully deployed app to https://app..westus3.azurecontainerapps.io
+ 07:11:46 (deploy) β deploy completed successfully
+ 07:11:46 (pipeline-execution) β Completed successfully
+ ------------------------------------------------------------
+ β 26/26 steps succeeded β’ Total time: 1m 31s
+
+ β Pipeline succeeded
+
+ βοΈ Target: Azure
+ π¦ Resource Group: rg-aspire-go-first-app
+ π Deployments: Azure Portal
+ π Subscription:
+ π Location: westus3
+ π Dashboard: https://aspire-dashboard.ext..westus3.azurecontainerapps.io
+ app: https://app..westus3.azurecontainerapps.io
+ ------------------------------------------------------------
+ ```
+
+
@@ -1301,7 +1399,68 @@ After a deployment, the Aspire CLI writes to the provided output path (or the de
- docker-compose.yaml
- The `aspire-output` directory contains the generated environment variables, an `app.Dockerfile`, and the Docker Compose configuration. These files are generated for you, so you don't need to write them yourself. The `app.Dockerfile` is a multi-stage Dockerfile that builds the Go API and includes the React frontend under `./static`, and the `docker-compose.yaml` file defines the `app` service alongside the Aspire dashboard.
+ The `aspire-output` directory contains the generated environment variables, an `app.Dockerfile`, and the Docker Compose configuration. These files are generated for you, so you don't need to write them yourself.
+
+ The `app.Dockerfile` is a multi-stage Dockerfile that builds the Go API and includes the React frontend under `./static`:
+
+ ```dockerfile title="./aspire-output/app.Dockerfile"
+ ARG FRONTEND_IMAGENAME=frontend:latest
+
+ FROM golang:1.26-alpine AS build
+ WORKDIR /app
+ ENV CGO_ENABLED=0
+ ENV GOOS=linux
+ COPY go.mod ./
+ COPY go.sum ./
+ RUN --mount=type=cache,target=/root/go/pkg/mod \
+ go mod download
+ COPY . .
+ RUN --mount=type=cache,target=/root/.cache/go-build --mount=type=cache,target=/root/go/pkg/mod \
+ go build -o /app/app .
+
+ FROM ${FRONTEND_IMAGENAME} AS frontend_stage
+
+ FROM alpine:latest
+ RUN apk --no-cache add ca-certificates tzdata
+ RUN addgroup -S app && adduser -S -G app app
+ WORKDIR /app
+ COPY --from=frontend_stage /app/dist /app/./static
+
+ COPY --from=build /app/app /app/app
+ USER app
+ ENTRYPOINT ["/app/app"]
+ ```
+
+ The `docker-compose.yaml` file defines the `app` service alongside the Aspire dashboard:
+
+ ```yaml title="./aspire-output/docker-compose.yaml"
+ services:
+ env-dashboard:
+ image: "mcr.microsoft.com/aspire/nightly/dashboard:latest"
+ ports:
+ - "18888"
+ expose:
+ - "18889"
+ - "18890"
+ networks:
+ - "aspire"
+ restart: "always"
+ app:
+ image: "${APP_IMAGE}"
+ environment:
+ HOST: "0.0.0.0"
+ PORT: "8000"
+ OTEL_EXPORTER_OTLP_ENDPOINT: "http://env-dashboard:18889"
+ OTEL_EXPORTER_OTLP_PROTOCOL: "grpc"
+ OTEL_SERVICE_NAME: "app"
+ ports:
+ - "8000"
+ networks:
+ - "aspire"
+ networks:
+ aspire:
+ driver: "bridge"
+ ```
@@ -1464,8 +1623,7 @@ To verify that your application is running as expected after deployment, follow
When deploying to Azure App Containers, you can verify that your Go/React application is running by navigating to the URL provided in the deployment output. Look for the `print-app-summary` step, which reports the URL for the `app` resource:
```bash title="Aspire CLI - Deployment summary"
- (print-app-summary) i [INF] Successfully deployed app to
- https://{NAME}.{LOCATION}.azurecontainerapps.io
+ (print-app-summary) i [INF] Successfully deployed app to https://app.{UNIQUE-ID}.{LOCATION}.azurecontainerapps.io
```
Open your web browser and navigate to the provided URL to see your deployed application.
diff --git a/src/frontend/src/content/docs/get-started/prerequisites.mdx b/src/frontend/src/content/docs/get-started/prerequisites.mdx
index 6bf27f85d5..a32f2b39e1 100644
--- a/src/frontend/src/content/docs/get-started/prerequisites.mdx
+++ b/src/frontend/src/content/docs/get-started/prerequisites.mdx
@@ -83,9 +83,9 @@ Ready to dive into Aspire? Before you begin, make sure your development environm
title: 'WSLc',
href: 'https://aka.ms/aspire/containers',
linkLabel: 'Set up WSLc',
- statusLabel: 'Windows local development only',
+ statusLabel: 'Windows only; limited publish support',
description:
- 'A supported container runtime for local development on Windows. Requires WSLc version 3.0.2.0 or later. Publishing and deployment are not supported yet.',
+ 'A supported container runtime on Windows. Requires WSLc version 3.0.4.0 or later. Publishing has limited support, and Docker Compose deployment is not supported.',
},
{
id: 'rancher',
@@ -112,8 +112,16 @@ Ready to dive into Aspire? Before you begin, make sure your development environm
:::note[WSLc on Windows]
`aspire doctor` auto-detects installed runtimes in Docker, Podman, WSLc priority order.
Set `ASPIRE_CONTAINER_RUNTIME=wslc` to select WSLc explicitly. WSLc isn't supported
- when Aspire runs inside a Linux WSL distribution. It is currently supported only
- for local development on Windows, not for publishing or deployment.
+ when Aspire runs inside a Linux WSL distribution.
+
+ WSLc has limited publishing support. It can build Dockerfile images for the host
+ platform, tag, remove, and push images, sign in to registries, and publish
+ single-platform .NET SDK container images to its local image store. Dockerfile
+ resources target `linux/amd64` by default when publishing, which WSLc can't select,
+ so set the target platform to `null` with `WithContainerBuildOptions` to build for the
+ WSLc host platform. Docker Compose deployment, multi-platform images in the local
+ image store, and manifest inspection aren't supported. Unsupported operations fail
+ with an error instead of falling back to another runtime.
:::
1. ## Install an integrated development environment (IDE)
diff --git a/src/frontend/src/content/docs/get-started/troubleshooting.mdx b/src/frontend/src/content/docs/get-started/troubleshooting.mdx
index defbed9f36..3c1597528c 100644
--- a/src/frontend/src/content/docs/get-started/troubleshooting.mdx
+++ b/src/frontend/src/content/docs/get-started/troubleshooting.mdx
@@ -170,6 +170,22 @@ Also verify:
[Service discovery](/fundamentals/service-discovery/).
+## `dotnet run --operation publish` fails in publish mode
+
+**Symptoms**: Running `dotnet run --operation publish` on an AppHost, or otherwise starting it with `dotnet run` in publish mode, fails with an error similar to:
+
+```text title="Output"
+The AppHost is in publish mode and cannot be started with 'aspire run'. Use 'aspire publish' instead.
+```
+
+**Cause**: When the AppHost uses the Aspire CLI bundle, [`dotnet run` hands the AppHost to `aspire run`](/get-started/aspire-sdk/#running-with-dotnet-run), which waits for the dashboard to become ready. Publish mode never starts the dashboard, so the AppHost rejects the request instead of waiting indefinitely.
+
+**Solution**: Use [`aspire publish`](/reference/cli/commands/aspire-publish/) to generate deployment artifacts:
+
+```bash title="Publish the AppHost"
+aspire publish --apphost ./MyApp.AppHost/MyApp.AppHost.csproj
+```
+
## `aspire add` finds no packages with an Azure Artifacts feed
**Symptoms**: When an authenticated Azure DevOps or Azure Artifacts NuGet feed is configured, `aspire add` reports that no packages were found or the Aspire CLI logs a `JsonReaderException`.
diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-agent-init.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-agent-init.mdx
index aee5daa4c9..b3bb82ae8b 100644
--- a/src/frontend/src/content/docs/reference/cli/commands/aspire-agent-init.mdx
+++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-agent-init.mdx
@@ -79,6 +79,8 @@ The following options are available:
Write agent settings and companion skill files at the project or user scope. Interactive setup prompts for a scope; non-interactive setup defaults to `project`.
+ Plugins, skills, and MCP configuration follow the selected scope. Telemetry hooks for GitHub Copilot and Claude Code are always written to user-level configuration (`~/.copilot/hooks/aspire-telemetry.json` and `~/.claude/settings.json`), even with `--scope project`, so they apply in every repository where that agent runs. For what the hooks record and how to opt out, see [AI agent skill usage](/reference/cli/microsoft-collected-cli-telemetry/#ai-agent-skill-usage).
+
- **`--skills `**
Comma-separated choices: `aspire`, `playwright-cli`, or `dotnet-inspect`. The `dotnet-inspect` skill requires a C# AppHost in the workspace. Use `all` for every applicable choice or `none` to skip them. Defaults to `aspire`, which applies all enabled skill sources. MCP setup is separate.
diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx
index 1bea2b24b3..1867912392 100644
--- a/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx
+++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx
@@ -249,7 +249,7 @@ them in Docker, Podman, WSLc priority order and marks the active one `β active
Container Runtime
β
Docker v29.8.2: running β active
β οΈ Podman: installed but not running
- β
WSLc v3.0.3.0: running
+ β
WSLc v3.0.4.0: running
```
When you set `ASPIRE_CONTAINER_RUNTIME=wslc`, Aspire checks only WSLc and marks
@@ -257,7 +257,7 @@ it `β explicitly selected`:
```bash title="Aspire CLI"
Container Runtime
- β
WSLc v3.0.3.0: running β explicitly selected
+ β
WSLc v3.0.4.0: running β explicitly selected
```
If the selected WSLc client or session manager is older than the minimum
@@ -266,8 +266,8 @@ warning:
```bash title="Aspire CLI"
Container Runtime
- β WSLc client version 3.0.1.0 is below minimum required 3.0.2.0 β explicitly selected
- Upgrade WSLc to version 3.0.2.0 or later. See: https://aka.ms/aspire/containers
+ β WSLc client version 3.0.3.0 is below minimum required 3.0.4.0 β explicitly selected
+ Upgrade WSLc to version 3.0.4.0 or later. See: https://aka.ms/aspire/containers
```
WSLc is only recognized on Windows; setting `ASPIRE_CONTAINER_RUNTIME=wslc` on
diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-init.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-init.mdx
index ab7dd40f40..7e50c466d5 100644
--- a/src/frontend/src/content/docs/reference/cli/commands/aspire-init.mdx
+++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-init.mdx
@@ -36,7 +36,7 @@ The command adapts to the repo it finds:
- **C# file-based AppHost** (when selected interactively) β creates `apphost.cs` with `#:package` directives for a lightweight single-file orchestrator.
- **TypeScript AppHost** (when selected interactively) β creates `apphost.mts` with the generated `.aspire/modules/` folder. If the repo already has a root `package.json`, the AppHost is created as a nested `aspire-apphost/` package and the root `aspire.config.json` points to `aspire-apphost/apphost.mts`.
-- **Go AppHost** (when selected interactively): creates `apphost.go`, a `go.mod` that points at the generated SDK, and the generated `.aspire/modules/` folder.
+- **Go AppHost** (when selected interactively): creates `apphost.go`, a `go.mod` that points at the generated SDK, and the generated `.aspire/modules/` folder. If the repo already has a root `go.mod`, the AppHost is created as a separate `aspire-apphost/` module with its own `go.work` file, and the root `aspire.config.json` points to `aspire-apphost/apphost.go`. Your existing `go.mod`, `go.work`, and source files aren't changed.
:::note
When a `.sln` or `.slnx` is present, the C# option creates a **project-based AppHost** instead β an `AppHost.csproj` added to the solution.
diff --git a/src/frontend/src/content/docs/reference/cli/commands/aspire-update.mdx b/src/frontend/src/content/docs/reference/cli/commands/aspire-update.mdx
index ae3f8e7689..14b7fc92a8 100644
--- a/src/frontend/src/content/docs/reference/cli/commands/aspire-update.mdx
+++ b/src/frontend/src/content/docs/reference/cli/commands/aspire-update.mdx
@@ -108,7 +108,7 @@ The following options are available:
Channel to update to (`stable`, `staging`, `daily`). When switching channels, `aspire update` applies all package version edits to your project first and then runs a single `dotnet restore`, ensuring that NuGet source mappings added for the target channel are in place before any restore is attempted.
- For non-stable channels (`staging`, `daily`), `aspire update` creates or updates a project-level `nuget.config` with the source mappings needed to resolve packages from that channel's feed. For the `stable` channel, no `nuget.config` is created because nuget.org is already the default NuGet source. If an existing `nuget.config` is present and the project has package or channel updates to apply when switching to or using `stable`, those changes are applied as part of that update to remove any stale channel-specific feed entries. If the project is already up to date, `aspire update` reports this and exits before touching `nuget.config`, so a stale channel-specific feed entry from a previous `staging` or `daily` switch can remain until the next update that actually applies changes.
+ For non-stable channels (`staging`, `daily`), `aspire update` creates or updates a project-level `nuget.config` with that channel's feed. It doesn't copy feeds or source mappings from your machine-level NuGet configuration into the file. If your effective NuGet configuration doesn't use package source mapping, the feed is added without enabling mapping, so other packages continue to resolve from your existing feeds. If mapping is enabled, `aspire update` adds an Aspire package mapping for the channel feed and keeps your existing mappings. It never adds a mapping `` or a catch-all nuget.org mapping, and it leaves entries you authored, such as `` and disabled sources, untouched. For the `stable` channel, no `nuget.config` is created because nuget.org is already the default NuGet source. If an existing `nuget.config` is present and the project has package or channel updates to apply when switching to or using `stable`, those changes are applied as part of that update to remove any stale channel-specific feed entries. If the project is already up to date, `aspire update` reports this and exits before touching `nuget.config`, so a stale channel-specific feed entry from a previous `staging` or `daily` switch can remain until the next update that actually applies changes.
When you switch to a persistable channel, such as `daily`, `aspire update` also rewrites the top-level `channel` key in `aspire.config.json` when the file already exists. Only channels registered as _explicit_ channels are persisted, with one exception: the `stable` channel is treated as the portable default and is intentionally not pinned. The persisted channel keeps subsequent `aspire add` and `aspire update` runs resolving packages against the channel you just switched to.
diff --git a/src/frontend/src/content/docs/reference/cli/includes/config-settings-table.md b/src/frontend/src/content/docs/reference/cli/includes/config-settings-table.md
index 95e6cf0c39..4336470376 100644
--- a/src/frontend/src/content/docs/reference/cli/includes/config-settings-table.md
+++ b/src/frontend/src/content/docs/reference/cli/includes/config-settings-table.md
@@ -8,8 +8,10 @@ title: Config Settings Table
| `appHost.path` | β | Path to the default AppHost entry point, such as `apphost.mts`, `Program.cs`, or an AppHost project file, relative to the directory that contains `aspire.config.json`. Set it in the local `aspire.config.json` file; the CLI ignores it in global configuration. |
| `certificates.nssDbPaths` | β | NSS database paths used for browser certificate trust on Linux. Separate paths with the platform path separator. Prefix a path with `firefox=` or `chromium=` to apply the trust settings expected by that browser family. Takes precedence over the upstream `DOTNET_DEV_CERTS_NSSDB_PATHS` environment variable. |
| `channel` | β | Aspire channel used to resolve Aspire packages, such as `stable`, `staging`, or `daily`. `aspire new`, `aspire init`, and `aspire update` can record it, `aspire add` reads it for non-C# AppHosts, and `aspire update` uses it when you don't pass `--channel`. |
+| `containerTunnel.baseImage` | β | Base image used to build the [container tunnel](/fundamentals/container-networking/#use-a-custom-tunnel-base-image) proxy image. The CLI passes it to the AppHost as `ASPIRE_CONTAINER_TUNNEL_BASE_IMAGE` unless that variable is already set. |
| `docs.api.sitemapUrl` | `https://aspire.dev/sitemap-0.xml` | API reference sitemap used by `aspire docs api`. Leave it unset to use the built-in aspire.dev source. |
| `docs.llmsTxtUrl` | `https://aspire.dev/llms-full.txt` | `llms.txt` documentation source used by `aspire docs`. Leave it unset to use the built-in aspire.dev source. |
+| `features.appHostServerV2` | `false` | Opt in to the preview AppHost Server v2 for this AppHost. Supports TypeScript AppHosts only, and doesn't support AppHost server debugging. Set it in the AppHost's local `aspire.config.json` file; `aspire config set --global` rejects it. |
| `features.defaultWatchEnabled` | `false` | Enable or disable watch mode by default when running Aspire applications for automatic restarts on file changes. |
| `features.experimentalPolyglotJava` | `false` | Enable or disable experimental Java AppHost support. |
| `features.experimentalPolyglotPython` | `false` | Enable or disable experimental Python AppHost support. |
diff --git a/src/frontend/src/content/docs/reference/cli/microsoft-collected-cli-telemetry.mdx b/src/frontend/src/content/docs/reference/cli/microsoft-collected-cli-telemetry.mdx
index 76b3e09811..7679b5fe64 100644
--- a/src/frontend/src/content/docs/reference/cli/microsoft-collected-cli-telemetry.mdx
+++ b/src/frontend/src/content/docs/reference/cli/microsoft-collected-cli-telemetry.mdx
@@ -13,7 +13,9 @@ Aspire CLI telemetry is collected when using the CLI to run commands. Telemetry
### AI agent skill usage
-When you run `aspire agent init`, Aspire installs Aspire's AI skills and a `PostToolUse` hook into each detected agent client's user-level configuration (for example, GitHub Copilot CLI and Claude Code). The hook lets Aspire understand which of its AI skills and tools are actually used so the team can invest in the most valuable ones.
+When `aspire agent init` enables the Aspire plugin or configures the Aspire MCP server for GitHub Copilot or Claude Code, or finds either already set up, it also installs a `PostToolUse` hook into that agent's user-level configuration. The hook lets Aspire understand which of its AI skills and tools are actually used so the team can invest in the most valuable ones.
+
+The hook is always installed at user scope, even when you run `aspire agent init --scope project`. Because user-level configuration applies to every repository, the hook runs wherever that agent runs, but it reports usage only for Aspire's own skills, MCP tools, and skill reference files.
After each agent tool use, the hook checks if an **Aspire** skill, Aspire MCP tool, or Aspire skill reference file was involved. If so, the hook inspects the event and forwards a low-cardinality usage event to the hidden `aspire agent telemetry` command. The command records the event through the same CLI telemetry pipeline. Tool uses that don't involve Aspire skills or tools are ignored. See [AI agent skill usage data](#ai-agent-skill-usage-data) for exactly what's recorded.
diff --git a/src/frontend/src/content/docs/whats-new/aspire-17.mdx b/src/frontend/src/content/docs/whats-new/aspire-17.mdx
index ae4f8f44e6..179026c9c8 100644
--- a/src/frontend/src/content/docs/whats-new/aspire-17.mdx
+++ b/src/frontend/src/content/docs/whats-new/aspire-17.mdx
@@ -346,7 +346,7 @@ Stop it with `aspire tray stop`. The tray companion requires a native Aspire CLI
### More CLI improvements
-- **WSLc container runtime**: Set `ASPIRE_CONTAINER_RUNTIME=wslc` on Windows to run, publish, and deploy containers with WSLc. `aspire doctor` checks only the configured runtime and reports features WSLc doesn't support.
+- **WSLc container runtime**: Set `ASPIRE_CONTAINER_RUNTIME=wslc` on Windows to run containers with WSLc 3.0.4.0 or later. Publishing has limited support, and Docker Compose deployment isn't supported. `aspire doctor` checks only the configured runtime and reports features WSLc doesn't support.
- **Container tunnel base image**: Use a mirrored or customized tunnel image with `aspire config set containerTunnel.baseImage `.
- **Stricter `aspire destroy`**: The command rejects unknown arguments instead of ignoring them.
- **Clearer publish guidance**: `dotnet run --operation publish` fails fast and directs you to `aspire publish`.
diff --git a/src/frontend/src/data/aspire-integrations.json b/src/frontend/src/data/aspire-integrations.json
index 3fea732cd8..db983bb728 100644
--- a/src/frontend/src/data/aspire-integrations.json
+++ b/src/frontend/src/data/aspire-integrations.json
@@ -1,4 +1,23 @@
[
+ {
+ "title": "Aspire.Azure.AI.Extensions.OpenAI",
+ "description": "Registers Foundry project and Azure OpenAI account clients with Aspire configuration, Microsoft Entra authentication and telemetry.",
+ "icon": "https://aspire.dev/favicon.svg",
+ "href": "https://www.nuget.org/packages/Aspire.Azure.AI.Extensions.OpenAI",
+ "tags": [
+ "aspire",
+ "integration",
+ "client",
+ "component",
+ "cloud",
+ "azure",
+ "ai",
+ "foundry",
+ "openai",
+ "projects"
+ ],
+ "version": "17.0.0-preview.1.26565.2"
+ },
{
"title": "Aspire.Azure.AI.Inference",
"description": "A client for Azure AI Inference SDK that integrates with Aspire, including logging and telemetry.",
@@ -36,6 +55,24 @@
"downloads": 952928,
"version": "13.6.5-preview.1.26559.7"
},
+ {
+ "title": "Aspire.Azure.AI.Projects",
+ "description": "Registers an Azure AI Projects client with Aspire configuration, dependency injection and tracing.",
+ "icon": "https://aspire.dev/favicon.svg",
+ "href": "https://www.nuget.org/packages/Aspire.Azure.AI.Projects",
+ "tags": [
+ "aspire",
+ "integration",
+ "client",
+ "component",
+ "cloud",
+ "azure",
+ "ai",
+ "foundry",
+ "projects"
+ ],
+ "version": "17.0.0-preview.1.26565.2"
+ },
{
"title": "Aspire.Azure.Data.Tables",
"description": "A client for Azure Table Storage that integrates with Aspire, including health checks, logging, and telemetry.",
@@ -50,10 +87,11 @@
"azure",
"tables",
"table",
- "storage"
+ "storage",
+ "cloud"
],
"downloads": 4200560,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Azure.Messaging.EventHubs",
@@ -70,10 +108,11 @@
"eventhubs",
"amqp",
"messaging",
- "eventing"
+ "eventing",
+ "cloud"
],
"downloads": 922511,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Azure.Messaging.ServiceBus",
@@ -90,10 +129,11 @@
"servicebus",
"amqp",
"messaging",
- "eventing"
+ "eventing",
+ "cloud"
],
"downloads": 2432682,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Azure.Messaging.WebPubSub",
@@ -110,10 +150,11 @@
"webpubsub",
"websocket",
"pubsub",
- "messaging"
+ "messaging",
+ "cloud"
],
"downloads": 83504,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Azure.Npgsql",
@@ -132,10 +173,11 @@
"npgsql",
"sql",
"database",
- "data"
+ "data",
+ "cloud"
],
"downloads": 231126,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Azure.Npgsql.EntityFrameworkCore.PostgreSQL",
@@ -159,10 +201,11 @@
"postgresql",
"postgres",
"npgsql",
- "sql"
+ "sql",
+ "cloud"
],
"downloads": 560530,
- "version": "13.6.5"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Azure.Search.Documents",
@@ -176,12 +219,13 @@
"component",
"cloud",
"azure",
+ "azure",
"search",
"ai",
"ai-search"
],
"downloads": 537600,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Azure.Security.KeyVault",
@@ -197,10 +241,11 @@
"azure",
"keyvault",
"secrets",
- "security"
+ "security",
+ "cloud"
],
"downloads": 2085752,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Azure.Storage.Blobs",
@@ -216,10 +261,11 @@
"azure",
"storage",
"blobs",
- "blob"
+ "blob",
+ "cloud"
],
"downloads": 8392916,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Azure.Storage.Files.DataLake",
@@ -238,7 +284,7 @@
"datalake"
],
"downloads": 8411,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Azure.Storage.Queues",
@@ -255,10 +301,11 @@
"storage",
"queue",
"queues",
- "messaging"
+ "messaging",
+ "cloud"
],
"downloads": 2187542,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Confluent.Kafka",
@@ -276,7 +323,7 @@
"eventing"
],
"downloads": 2768448,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Elastic.Clients.Elasticsearch",
@@ -306,7 +353,7 @@
"polyglot"
],
"downloads": 48543005,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.AgentFramework.DevUI",
@@ -354,7 +401,26 @@
"polyglot"
],
"downloads": 12534311,
- "version": "13.6.5"
+ "version": "17.0.0"
+ },
+ {
+ "title": "Aspire.Hosting.Azure.ApiManagement",
+ "description": "Azure API Management resource types for Aspire.",
+ "icon": "https://aspire.dev/favicon.svg",
+ "href": "https://www.nuget.org/packages/Aspire.Hosting.Azure.ApiManagement",
+ "tags": [
+ "aspire",
+ "integration",
+ "hosting",
+ "azure",
+ "api-management",
+ "apim",
+ "gateway",
+ "reverse-proxy",
+ "cloud",
+ "polyglot"
+ ],
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.AppConfiguration",
@@ -371,7 +437,7 @@
"polyglot"
],
"downloads": 832430,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.AppContainers",
@@ -389,7 +455,7 @@
"polyglot"
],
"downloads": 1854997,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.ApplicationInsights",
@@ -408,7 +474,7 @@
"polyglot"
],
"downloads": 1322251,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.AppService",
@@ -425,7 +491,7 @@
"polyglot"
],
"downloads": 142556,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.CognitiveServices",
@@ -446,7 +512,7 @@
"polyglot"
],
"downloads": 1025902,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.ConnectorNamespace",
@@ -465,7 +531,7 @@
"polyglot"
],
"downloads": 445,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.ContainerRegistry",
@@ -483,7 +549,7 @@
"polyglot"
],
"downloads": 1584897,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.CosmosDB",
@@ -503,7 +569,25 @@
"polyglot"
],
"downloads": 2231025,
- "version": "13.6.5"
+ "version": "17.0.0"
+ },
+ {
+ "title": "Aspire.Hosting.Azure.EntraId",
+ "description": "Microsoft Entra ID support for Aspire.",
+ "icon": "https://aspire.dev/favicon.svg",
+ "href": "https://www.nuget.org/packages/Aspire.Hosting.Azure.EntraId",
+ "tags": [
+ "aspire",
+ "integration",
+ "hosting",
+ "azure",
+ "entra",
+ "identity",
+ "authentication",
+ "security",
+ "polyglot"
+ ],
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.EventHubs",
@@ -522,7 +606,7 @@
"polyglot"
],
"downloads": 999185,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.FrontDoor",
@@ -540,7 +624,7 @@
"polyglot"
],
"downloads": 22900,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Functions",
@@ -558,7 +642,7 @@
"polyglot"
],
"downloads": 2464452,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.KeyVault",
@@ -577,7 +661,7 @@
"polyglot"
],
"downloads": 4850908,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.Kubernetes",
@@ -594,7 +678,7 @@
"polyglot"
],
"downloads": 4853,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.Kusto",
@@ -613,7 +697,7 @@
"polyglot"
],
"downloads": 13989,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Network",
@@ -635,7 +719,7 @@
"polyglot"
],
"downloads": 821102,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.OperationalInsights",
@@ -653,7 +737,7 @@
"polyglot"
],
"downloads": 2345454,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.PostgreSQL",
@@ -672,7 +756,7 @@
"polyglot"
],
"downloads": 1178863,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.Provisioning",
@@ -688,7 +772,7 @@
"polyglot"
],
"downloads": 7569,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.AppConfiguration",
@@ -706,7 +790,7 @@
"polyglot"
],
"downloads": 423,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.AppContainers",
@@ -724,7 +808,7 @@
"polyglot"
],
"downloads": 4853,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.ApplicationInsights",
@@ -743,7 +827,7 @@
"polyglot"
],
"downloads": 436,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.AppService",
@@ -761,7 +845,7 @@
"polyglot"
],
"downloads": 440,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.Cdn",
@@ -780,7 +864,7 @@
"polyglot"
],
"downloads": 451,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.CognitiveServices",
@@ -799,7 +883,7 @@
"polyglot"
],
"downloads": 451,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.ContainerRegistry",
@@ -818,7 +902,7 @@
"polyglot"
],
"downloads": 453,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.ContainerService",
@@ -837,7 +921,7 @@
"polyglot"
],
"downloads": 427,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.CosmosDB",
@@ -856,7 +940,24 @@
"polyglot"
],
"downloads": 440,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
+ },
+ {
+ "title": "Aspire.Hosting.Azure.Provisioning.EntraId",
+ "description": "Opt-in Microsoft Graph provisioning APIs for polyglot Aspire AppHosts.",
+ "icon": "https://aspire.dev/favicon.svg",
+ "href": "https://www.nuget.org/packages/Aspire.Hosting.Azure.Provisioning.EntraId",
+ "tags": [
+ "aspire",
+ "integration",
+ "hosting",
+ "azure",
+ "provisioning",
+ "entra",
+ "identity",
+ "polyglot"
+ ],
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.EventHubs",
@@ -875,7 +976,7 @@
"polyglot"
],
"downloads": 430,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.Generators",
@@ -891,7 +992,7 @@
"source-generator"
],
"downloads": 407,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.KeyVault",
@@ -911,7 +1012,7 @@
"polyglot"
],
"downloads": 483,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.Kusto",
@@ -929,7 +1030,7 @@
"polyglot"
],
"downloads": 421,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.Network",
@@ -947,7 +1048,7 @@
"polyglot"
],
"downloads": 449,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.OperationalInsights",
@@ -966,7 +1067,7 @@
"polyglot"
],
"downloads": 449,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.PostgreSql",
@@ -984,7 +1085,7 @@
"polyglot"
],
"downloads": 491,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.PrivateDns",
@@ -1003,7 +1104,7 @@
"polyglot"
],
"downloads": 448,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.Redis",
@@ -1021,7 +1122,7 @@
"polyglot"
],
"downloads": 434,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.RedisEnterprise",
@@ -1040,7 +1141,7 @@
"polyglot"
],
"downloads": 2244,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.Search",
@@ -1058,7 +1159,7 @@
"polyglot"
],
"downloads": 419,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.ServiceBus",
@@ -1077,7 +1178,7 @@
"polyglot"
],
"downloads": 452,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.SignalR",
@@ -1095,7 +1196,7 @@
"polyglot"
],
"downloads": 434,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.Sql",
@@ -1114,7 +1215,7 @@
"polyglot"
],
"downloads": 445,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.Storage",
@@ -1132,7 +1233,7 @@
"polyglot"
],
"downloads": 494,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Provisioning.WebPubSub",
@@ -1152,7 +1253,7 @@
"polyglot"
],
"downloads": 423,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Redis",
@@ -1171,7 +1272,7 @@
"polyglot"
],
"downloads": 840393,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.Sandboxes",
@@ -1190,7 +1291,7 @@
"polyglot"
],
"downloads": 416,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Azure.Search",
@@ -1209,7 +1310,7 @@
"polyglot"
],
"downloads": 427783,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.ServiceBus",
@@ -1228,7 +1329,7 @@
"polyglot"
],
"downloads": 3595646,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.SignalR",
@@ -1246,7 +1347,7 @@
"polyglot"
],
"downloads": 508647,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.Sql",
@@ -1265,7 +1366,7 @@
"polyglot"
],
"downloads": 1333682,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.Storage",
@@ -1285,7 +1386,7 @@
"polyglot"
],
"downloads": 9102817,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Azure.WebPubSub",
@@ -1305,7 +1406,7 @@
"polyglot"
],
"downloads": 47433,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Blazor",
@@ -1322,7 +1423,7 @@
"polyglot"
],
"downloads": 13388,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Browsers",
@@ -1340,7 +1441,7 @@
"polyglot"
],
"downloads": 281685,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.ClickHouse",
@@ -1365,7 +1466,7 @@
"href": "https://www.nuget.org/packages/Aspire.Hosting.CodeGeneration.Go",
"tags": [],
"downloads": 18418,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.CodeGeneration.Java",
@@ -1374,7 +1475,7 @@
"href": "https://www.nuget.org/packages/Aspire.Hosting.CodeGeneration.Java",
"tags": [],
"downloads": 4340,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.CodeGeneration.Python",
@@ -1383,7 +1484,7 @@
"href": "https://www.nuget.org/packages/Aspire.Hosting.CodeGeneration.Python",
"tags": [],
"downloads": 4859,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.CodeGeneration.Rust",
@@ -1392,7 +1493,7 @@
"href": "https://www.nuget.org/packages/Aspire.Hosting.CodeGeneration.Rust",
"tags": [],
"downloads": 4227,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.CodeGeneration.TypeScript",
@@ -1401,7 +1502,7 @@
"href": "https://www.nuget.org/packages/Aspire.Hosting.CodeGeneration.TypeScript",
"tags": [],
"downloads": 161055,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.DevTunnels",
@@ -1415,7 +1516,7 @@
"polyglot"
],
"downloads": 770186,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Docker",
@@ -1430,7 +1531,7 @@
"polyglot"
],
"downloads": 1047005,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.DocumentDB",
@@ -1466,7 +1567,7 @@
"polyglot"
],
"downloads": 38917,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Elasticsearch",
@@ -1499,7 +1600,7 @@
"polyglot"
],
"downloads": 71917,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Foundry",
@@ -1520,7 +1621,7 @@
"polyglot"
],
"downloads": 127040,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Garnet",
@@ -1537,7 +1638,7 @@
"polyglot"
],
"downloads": 160110,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Go",
@@ -1555,7 +1656,7 @@
"polyglot"
],
"downloads": 38781,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Integration.Analyzers",
@@ -1569,7 +1670,7 @@
"ats"
],
"downloads": 6040,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Java",
@@ -1587,7 +1688,7 @@
"polyglot"
],
"downloads": 1745,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.JavaScript",
@@ -1606,7 +1707,7 @@
"polyglot"
],
"downloads": 6778444,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Kafka",
@@ -1623,7 +1724,7 @@
"polyglot"
],
"downloads": 1834341,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Keycloak",
@@ -1641,7 +1742,7 @@
"polyglot"
],
"downloads": 1324555,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Kubernetes",
@@ -1655,7 +1756,7 @@
"polyglot"
],
"downloads": 410278,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Maui",
@@ -1669,7 +1770,7 @@
"polyglot"
],
"downloads": 57626,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Milvus",
@@ -1689,7 +1790,7 @@
"polyglot"
],
"downloads": 18475,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.MongoDB",
@@ -1706,7 +1807,7 @@
"polyglot"
],
"downloads": 1367819,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.MySql",
@@ -1723,7 +1824,7 @@
"polyglot"
],
"downloads": 538402,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Nats",
@@ -1740,7 +1841,7 @@
"polyglot"
],
"downloads": 392508,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.OpenAI",
@@ -1756,7 +1857,7 @@
"polyglot"
],
"downloads": 61803,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Oracle",
@@ -1774,7 +1875,7 @@
"polyglot"
],
"downloads": 130961,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Orleans",
@@ -1791,7 +1892,7 @@
"polyglot"
],
"downloads": 520423,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.PostgreSQL",
@@ -1811,7 +1912,7 @@
"polyglot"
],
"downloads": 11504400,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Python",
@@ -1828,7 +1929,7 @@
"polyglot"
],
"downloads": 542843,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Qdrant",
@@ -1847,7 +1948,7 @@
"polyglot"
],
"downloads": 205554,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.RabbitMQ",
@@ -1864,7 +1965,7 @@
"polyglot"
],
"downloads": 4504087,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Radius",
@@ -1881,7 +1982,7 @@
"polyglot"
],
"downloads": 971,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Redis",
@@ -1898,7 +1999,7 @@
"polyglot"
],
"downloads": 10797186,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Rust",
@@ -1915,7 +2016,7 @@
"polyglot"
],
"downloads": 528,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Hosting.Seq",
@@ -1932,7 +2033,7 @@
"polyglot"
],
"downloads": 728404,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.SqlServer",
@@ -1950,7 +2051,7 @@
"polyglot"
],
"downloads": 10680867,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Valkey",
@@ -1967,7 +2068,7 @@
"polyglot"
],
"downloads": 1051071,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Hosting.Yarp",
@@ -1984,7 +2085,7 @@
"polyglot"
],
"downloads": 748481,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Keycloak.Authentication",
@@ -2003,7 +2104,7 @@
"security"
],
"downloads": 810879,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Microsoft.Azure.Cosmos",
@@ -2022,10 +2123,11 @@
"data",
"database",
"db",
- "nosql"
+ "nosql",
+ "cloud"
],
"downloads": 1836360,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Microsoft.Azure.StackExchangeRedis",
@@ -2040,11 +2142,13 @@
"cloud",
"azure",
"redis",
+ "azure",
"cache",
- "caching"
+ "caching",
+ "cloud"
],
"downloads": 211459,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Microsoft.Data.SqlClient",
@@ -2063,7 +2167,7 @@
"sql"
],
"downloads": 2222520,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Microsoft.EntityFrameworkCore.Cosmos",
@@ -2087,10 +2191,11 @@
"azure",
"cosmos",
"cosmosdb",
- "nosql"
+ "nosql",
+ "cloud"
],
"downloads": 283085,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Microsoft.EntityFrameworkCore.SqlServer",
@@ -2115,7 +2220,7 @@
"sql"
],
"downloads": 7571248,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Microsoft.Extensions.Configuration.AzureAppConfiguration",
@@ -2130,10 +2235,11 @@
"cloud",
"azure",
"configuration",
- "appconfiguration"
+ "appconfiguration",
+ "cloud"
],
"downloads": 1223921,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Milvus.Client",
@@ -2153,7 +2259,7 @@
"ai-search"
],
"downloads": 10664,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.MongoDB.Driver",
@@ -2171,7 +2277,7 @@
"mongodb"
],
"downloads": 527376,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.MongoDB.Driver.v2",
@@ -2213,7 +2319,7 @@
"mongodb"
],
"downloads": 9384,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.MySqlConnector",
@@ -2233,7 +2339,7 @@
"sql"
],
"downloads": 2489853,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.NATS.Net",
@@ -2251,7 +2357,7 @@
"eventing"
],
"downloads": 285418,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Npgsql",
@@ -2272,7 +2378,7 @@
"sql"
],
"downloads": 4173444,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Npgsql.EntityFrameworkCore.PostgreSQL",
@@ -2299,7 +2405,7 @@
"sql"
],
"downloads": 8629029,
- "version": "13.6.5"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.OpenAI",
@@ -2316,7 +2422,7 @@
"openai"
],
"downloads": 892427,
- "version": "13.6.5-preview.1.26559.7"
+ "version": "17.0.0-preview.1.26565.2"
},
{
"title": "Aspire.Oracle.EntityFrameworkCore",
@@ -2341,7 +2447,7 @@
"sql"
],
"downloads": 269832,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Pomelo.EntityFrameworkCore.MySql",
@@ -2367,7 +2473,7 @@
"sql"
],
"downloads": 442613,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.Qdrant.Client",
@@ -2386,7 +2492,7 @@
"ai-search"
],
"downloads": 146322,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.RabbitMQ.Client",
@@ -2407,7 +2513,7 @@
"eventing"
],
"downloads": 1519737,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.RabbitMQ.Client.v6",
@@ -2446,7 +2552,7 @@
"logging"
],
"downloads": 643161,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.StackExchange.Redis",
@@ -2464,7 +2570,7 @@
"redis"
],
"downloads": 13521690,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.StackExchange.Redis.DistributedCaching",
@@ -2484,7 +2590,7 @@
"redis"
],
"downloads": 4263902,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.StackExchange.Redis.OutputCaching",
@@ -2505,7 +2611,7 @@
"redis"
],
"downloads": 1170441,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "Aspire.TypeSystem",
@@ -2519,7 +2625,7 @@
"polyglot"
],
"downloads": 179172,
- "version": "13.6.5"
+ "version": "17.0.0"
},
{
"title": "CommunityToolkit.Aspire.Bitwarden.SecretManager",
diff --git a/src/frontend/src/data/pkgs/Aspire.Azure.AI.Extensions.OpenAI.17.0.0-preview.1.26565.2.json b/src/frontend/src/data/pkgs/Aspire.Azure.AI.Extensions.OpenAI.17.0.0-preview.1.26565.2.json
new file mode 100644
index 0000000000..d29e89d726
--- /dev/null
+++ b/src/frontend/src/data/pkgs/Aspire.Azure.AI.Extensions.OpenAI.17.0.0-preview.1.26565.2.json
@@ -0,0 +1,1592 @@
+{
+ "package": {
+ "name": "Aspire.Azure.AI.Extensions.OpenAI",
+ "version": "17.0.0-preview.1.26565.2",
+ "targetFramework": "net10.0",
+ "sourceRepository": "https://github.com/microsoft/aspire",
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
+ },
+ "types": [
+ {
+ "name": "AspireAzureOpenAIClientBuilder",
+ "fullName": "Aspire.Azure.AI.Extensions.OpenAI.AspireAzureOpenAIClientBuilder",
+ "namespace": "Aspire.Azure.AI.Extensions.OpenAI",
+ "kind": "class",
+ "accessibility": "public",
+ "baseType": "Aspire.OpenAI.AspireOpenAIClientBuilder",
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Configures additional services for an Azure OpenAI account's "
+ },
+ {
+ "kind": "cref",
+ "value": "T:OpenAI.OpenAIClient"
+ },
+ {
+ "kind": "text",
+ "text": " registration. "
+ }
+ ],
+ "parameters": {
+ "connectionName": [
+ {
+ "kind": "text",
+ "text": "The account connection-string name."
+ }
+ ],
+ "disableMetrics": [
+ {
+ "kind": "text",
+ "text": "Whether metrics are disabled."
+ }
+ ],
+ "disableTracing": [
+ {
+ "kind": "text",
+ "text": "Whether tracing is disabled."
+ }
+ ],
+ "enableSensitiveTelemetryData": [
+ {
+ "kind": "text",
+ "text": "Whether telemetry may capture message content."
+ }
+ ],
+ "hostBuilder": [
+ {
+ "kind": "text",
+ "text": "The application builder."
+ }
+ ],
+ "serviceKey": [
+ {
+ "kind": "text",
+ "text": "The service key, or "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": " for an unkeyed client."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireAzureOpenAIClientBuilder.cs",
+ "sourceLines": "19-19",
+ "members": [
+ {
+ "name": ".ctor",
+ "kind": "constructor",
+ "accessibility": "public",
+ "signature": "public AspireAzureOpenAIClientBuilder.AspireAzureOpenAIClientBuilder(IHostApplicationBuilder hostBuilder, string connectionName, string? serviceKey, bool disableTracing, bool disableMetrics, bool enableSensitiveTelemetryData)",
+ "returnType": "void",
+ "parameters": [
+ {
+ "name": "hostBuilder",
+ "type": "Microsoft.Extensions.Hosting.IHostApplicationBuilder"
+ },
+ {
+ "name": "connectionName",
+ "type": "string"
+ },
+ {
+ "name": "serviceKey",
+ "type": "string?",
+ "isNullable": true
+ },
+ {
+ "name": "disableTracing",
+ "type": "bool"
+ },
+ {
+ "name": "disableMetrics",
+ "type": "bool"
+ },
+ {
+ "name": "enableSensitiveTelemetryData",
+ "type": "bool"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Configures additional services for an Azure OpenAI account's "
+ },
+ {
+ "kind": "cref",
+ "value": "T:OpenAI.OpenAIClient"
+ },
+ {
+ "kind": "text",
+ "text": " registration. "
+ }
+ ],
+ "parameters": {
+ "connectionName": [
+ {
+ "kind": "text",
+ "text": "The account connection-string name."
+ }
+ ],
+ "disableMetrics": [
+ {
+ "kind": "text",
+ "text": "Whether metrics are disabled."
+ }
+ ],
+ "disableTracing": [
+ {
+ "kind": "text",
+ "text": "Whether tracing is disabled."
+ }
+ ],
+ "enableSensitiveTelemetryData": [
+ {
+ "kind": "text",
+ "text": "Whether telemetry may capture message content."
+ }
+ ],
+ "hostBuilder": [
+ {
+ "kind": "text",
+ "text": "The application builder."
+ }
+ ],
+ "serviceKey": [
+ {
+ "kind": "text",
+ "text": "The service key, or "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": " for an unkeyed client."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireAzureOpenAIClientBuilder.cs",
+ "sourceLines": "20-20"
+ },
+ {
+ "name": "ConfigurationSectionName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AspireAzureOpenAIClientBuilder.ConfigurationSectionName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the name of the configuration section for this component type. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireAzureOpenAIClientBuilder.cs",
+ "sourceLines": "23-25"
+ }
+ ]
+ },
+ {
+ "name": "AspireAzureProjectOpenAIClientBuilder",
+ "fullName": "Aspire.Azure.AI.Extensions.OpenAI.AspireAzureProjectOpenAIClientBuilder",
+ "namespace": "Aspire.Azure.AI.Extensions.OpenAI",
+ "kind": "class",
+ "accessibility": "public",
+ "baseType": "Aspire.OpenAI.AspireOpenAIClientBuilder",
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Configures additional services for a "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Azure.AI.Extensions.OpenAI.ProjectOpenAIClient"
+ },
+ {
+ "kind": "text",
+ "text": " registration. "
+ }
+ ],
+ "parameters": {
+ "connectionName": [
+ {
+ "kind": "text",
+ "text": "The project connection-string name."
+ }
+ ],
+ "disableMetrics": [
+ {
+ "kind": "text",
+ "text": "Whether metrics are disabled."
+ }
+ ],
+ "disableTracing": [
+ {
+ "kind": "text",
+ "text": "Whether tracing is disabled."
+ }
+ ],
+ "enableSensitiveTelemetryData": [
+ {
+ "kind": "text",
+ "text": "Whether telemetry may capture message content."
+ }
+ ],
+ "hostBuilder": [
+ {
+ "kind": "text",
+ "text": "The application builder."
+ }
+ ],
+ "serviceKey": [
+ {
+ "kind": "text",
+ "text": "The service key, or "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": " for an unkeyed client."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireAzureProjectOpenAIClientBuilder.cs",
+ "sourceLines": "19-19",
+ "members": [
+ {
+ "name": ".ctor",
+ "kind": "constructor",
+ "accessibility": "public",
+ "signature": "public AspireAzureProjectOpenAIClientBuilder.AspireAzureProjectOpenAIClientBuilder(IHostApplicationBuilder hostBuilder, string connectionName, string? serviceKey, bool disableTracing, bool disableMetrics, bool enableSensitiveTelemetryData)",
+ "returnType": "void",
+ "parameters": [
+ {
+ "name": "hostBuilder",
+ "type": "Microsoft.Extensions.Hosting.IHostApplicationBuilder"
+ },
+ {
+ "name": "connectionName",
+ "type": "string"
+ },
+ {
+ "name": "serviceKey",
+ "type": "string?",
+ "isNullable": true
+ },
+ {
+ "name": "disableTracing",
+ "type": "bool"
+ },
+ {
+ "name": "disableMetrics",
+ "type": "bool"
+ },
+ {
+ "name": "enableSensitiveTelemetryData",
+ "type": "bool"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Configures additional services for a "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Azure.AI.Extensions.OpenAI.ProjectOpenAIClient"
+ },
+ {
+ "kind": "text",
+ "text": " registration. "
+ }
+ ],
+ "parameters": {
+ "connectionName": [
+ {
+ "kind": "text",
+ "text": "The project connection-string name."
+ }
+ ],
+ "disableMetrics": [
+ {
+ "kind": "text",
+ "text": "Whether metrics are disabled."
+ }
+ ],
+ "disableTracing": [
+ {
+ "kind": "text",
+ "text": "Whether tracing is disabled."
+ }
+ ],
+ "enableSensitiveTelemetryData": [
+ {
+ "kind": "text",
+ "text": "Whether telemetry may capture message content."
+ }
+ ],
+ "hostBuilder": [
+ {
+ "kind": "text",
+ "text": "The application builder."
+ }
+ ],
+ "serviceKey": [
+ {
+ "kind": "text",
+ "text": "The service key, or "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": " for an unkeyed client."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireAzureProjectOpenAIClientBuilder.cs",
+ "sourceLines": "20-20"
+ },
+ {
+ "name": "ConfigurationSectionName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AspireAzureProjectOpenAIClientBuilder.ConfigurationSectionName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the name of the configuration section for this component type. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireAzureProjectOpenAIClientBuilder.cs",
+ "sourceLines": "23-25"
+ }
+ ]
+ },
+ {
+ "name": "AzureOpenAISettings",
+ "fullName": "Aspire.Azure.AI.Extensions.OpenAI.AzureOpenAISettings",
+ "namespace": "Aspire.Azure.AI.Extensions.OpenAI",
+ "kind": "class",
+ "accessibility": "public",
+ "isSealed": true,
+ "interfaces": [
+ "Aspire.Azure.Common.IConnectionStringSettings"
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Configures an Azure OpenAI account client and its Microsoft.Extensions.AI telemetry. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureOpenAISettings.cs",
+ "sourceLines": "13-13",
+ "members": [
+ {
+ "name": ".ctor",
+ "kind": "constructor",
+ "accessibility": "public",
+ "signature": "public AzureOpenAISettings.AzureOpenAISettings()",
+ "returnType": "void",
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureOpenAISettings.cs",
+ "sourceLines": "33-49"
+ },
+ {
+ "name": "Credential",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public TokenCredential? AzureOpenAISettings.Credential",
+ "returnType": "Azure.Core.TokenCredential?",
+ "isReturnNullable": true,
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets the Microsoft Entra credential. Uses managed identity in Azure and a development credential locally by default. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureOpenAISettings.cs"
+ },
+ {
+ "name": "DisableMetrics",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public bool AzureOpenAISettings.DisableMetrics",
+ "returnType": "bool",
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets whether Microsoft.Extensions.AI metrics are disabled. The default is "
+ },
+ {
+ "kind": "langword",
+ "value": "false"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureOpenAISettings.cs"
+ },
+ {
+ "name": "DisableTracing",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public bool AzureOpenAISettings.DisableTracing",
+ "returnType": "bool",
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets whether tracing is disabled. The default is "
+ },
+ {
+ "kind": "langword",
+ "value": "false"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureOpenAISettings.cs"
+ },
+ {
+ "name": "EnableSensitiveTelemetryData",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public bool AzureOpenAISettings.EnableSensitiveTelemetryData",
+ "returnType": "bool",
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets whether Microsoft.Extensions.AI telemetry includes sensitive message content. Defaults to "
+ },
+ {
+ "kind": "langword",
+ "value": "false"
+ },
+ {
+ "kind": "text",
+ "text": " unless "
+ },
+ {
+ "kind": "code",
+ "text": "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT"
+ },
+ {
+ "kind": "text",
+ "text": " is true. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureOpenAISettings.cs"
+ },
+ {
+ "name": "Endpoint",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public Uri? AzureOpenAISettings.Endpoint",
+ "returnType": "System.Uri?",
+ "isReturnNullable": true,
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets the HTTPS Azure OpenAI account endpoint or its "
+ },
+ {
+ "kind": "code",
+ "text": "/openai/v1/"
+ },
+ {
+ "kind": "text",
+ "text": " endpoint. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureOpenAISettings.cs"
+ },
+ {
+ "name": "Key",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public string? AzureOpenAISettings.Key",
+ "returnType": "string?",
+ "isReturnNullable": true,
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets the API key. When absent, the client uses Microsoft Entra authentication. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureOpenAISettings.cs"
+ },
+ {
+ "name": "TokenScope",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public string AzureOpenAISettings.TokenScope",
+ "returnType": "string",
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets the Microsoft Entra token scope. Defaults to "
+ },
+ {
+ "kind": "code",
+ "text": "https://ai.azure.com/.default"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureOpenAISettings.cs"
+ }
+ ]
+ },
+ {
+ "name": "AzureProjectOpenAISettings",
+ "fullName": "Aspire.Azure.AI.Extensions.OpenAI.AzureProjectOpenAISettings",
+ "namespace": "Aspire.Azure.AI.Extensions.OpenAI",
+ "kind": "class",
+ "accessibility": "public",
+ "isSealed": true,
+ "interfaces": [
+ "Aspire.Azure.Common.IConnectionStringSettings"
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Configures an Azure AI Project OpenAI client and its Microsoft.Extensions.AI telemetry. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureProjectOpenAISettings.cs",
+ "sourceLines": "12-12",
+ "members": [
+ {
+ "name": ".ctor",
+ "kind": "constructor",
+ "accessibility": "public",
+ "signature": "public AzureProjectOpenAISettings.AzureProjectOpenAISettings()",
+ "returnType": "void",
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureProjectOpenAISettings.cs",
+ "sourceLines": "38-38"
+ },
+ {
+ "name": "Credential",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public TokenCredential? AzureProjectOpenAISettings.Credential",
+ "returnType": "Azure.Core.TokenCredential?",
+ "isReturnNullable": true,
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets the Microsoft Entra credential. Uses managed identity in Azure and a development credential locally by default. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureProjectOpenAISettings.cs"
+ },
+ {
+ "name": "DisableMetrics",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public bool AzureProjectOpenAISettings.DisableMetrics",
+ "returnType": "bool",
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets whether Microsoft.Extensions.AI metrics are disabled. The default is "
+ },
+ {
+ "kind": "langword",
+ "value": "false"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureProjectOpenAISettings.cs"
+ },
+ {
+ "name": "DisableTracing",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public bool AzureProjectOpenAISettings.DisableTracing",
+ "returnType": "bool",
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets whether tracing is disabled. The default is "
+ },
+ {
+ "kind": "langword",
+ "value": "false"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureProjectOpenAISettings.cs"
+ },
+ {
+ "name": "EnableSensitiveTelemetryData",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public bool AzureProjectOpenAISettings.EnableSensitiveTelemetryData",
+ "returnType": "bool",
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets whether Microsoft.Extensions.AI telemetry includes sensitive message content. Defaults to "
+ },
+ {
+ "kind": "langword",
+ "value": "false"
+ },
+ {
+ "kind": "text",
+ "text": " unless "
+ },
+ {
+ "kind": "code",
+ "text": "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT"
+ },
+ {
+ "kind": "text",
+ "text": " is true. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureProjectOpenAISettings.cs"
+ },
+ {
+ "name": "Endpoint",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public Uri? AzureProjectOpenAISettings.Endpoint",
+ "returnType": "System.Uri?",
+ "isReturnNullable": true,
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets the HTTPS Foundry project endpoint, such as "
+ },
+ {
+ "kind": "code",
+ "text": "https://account.services.ai.azure.com/api/projects/project"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AzureProjectOpenAISettings.cs"
+ }
+ ]
+ },
+ {
+ "name": "AspireAzureOpenAIExtensions",
+ "fullName": "Microsoft.Extensions.Hosting.AspireAzureOpenAIExtensions",
+ "namespace": "Microsoft.Extensions.Hosting",
+ "kind": "class",
+ "accessibility": "public",
+ "isStatic": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Registers standard OpenAI SDK clients for Azure OpenAI accounts with Microsoft Entra authentication and telemetry. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireAzureOpenAIExtensions.cs",
+ "sourceLines": "21-21",
+ "members": [
+ {
+ "name": "AddAzureOpenAIClient",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static AspireAzureOpenAIClientBuilder AspireAzureOpenAIExtensions.AddAzureOpenAIClient(this IHostApplicationBuilder builder, string connectionName, Action? configureSettings = null, Action>? configureClientBuilder = null)",
+ "returnType": "Aspire.Azure.AI.Extensions.OpenAI.AspireAzureOpenAIClientBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Microsoft.Extensions.Hosting.IHostApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "connectionName",
+ "type": "string"
+ },
+ {
+ "name": "configureSettings",
+ "type": "System.Action?",
+ "isNullable": true,
+ "isOptional": true
+ },
+ {
+ "name": "configureClientBuilder",
+ "type": "System.Action>?",
+ "isNullable": true,
+ "isOptional": true
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Registers an "
+ },
+ {
+ "kind": "cref",
+ "value": "T:OpenAI.OpenAIClient"
+ },
+ {
+ "kind": "text",
+ "text": " singleton for an Azure OpenAI account's v1 API. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Reads "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire:Azure:AI:OpenAI"
+ },
+ {
+ "kind": "text",
+ "text": " and its connection-specific subsection. Account endpoints are normalized to "
+ },
+ {
+ "kind": "code",
+ "text": "/openai/v1/"
+ },
+ {
+ "kind": "text",
+ "text": ". Uses Microsoft Entra authentication unless an API key is supplied. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A builder for registering chat, embedding, and Microsoft.Extensions.AI services."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The application builder."
+ }
+ ],
+ "configureClientBuilder": [
+ {
+ "kind": "text",
+ "text": "Customizes the Azure client registration, credential, and OpenAI SDK options."
+ }
+ ],
+ "configureSettings": [
+ {
+ "kind": "text",
+ "text": "Customizes settings after configuration and connection-string binding."
+ }
+ ],
+ "connectionName": [
+ {
+ "kind": "text",
+ "text": "The account connection-string name."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "builder"
+ },
+ {
+ "kind": "text",
+ "text": " is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "connectionName"
+ },
+ {
+ "kind": "text",
+ "text": " is null or empty, or the connection string is invalid."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.AddAzureOpenAIClient(\"chat\").AddChatClient();\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireAzureOpenAIExtensions.cs",
+ "sourceLines": "50-54"
+ },
+ {
+ "name": "AddKeyedAzureOpenAIClient",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static AspireAzureOpenAIClientBuilder AspireAzureOpenAIExtensions.AddKeyedAzureOpenAIClient(this IHostApplicationBuilder builder, string name, Action? configureSettings = null, Action>? configureClientBuilder = null)",
+ "returnType": "Aspire.Azure.AI.Extensions.OpenAI.AspireAzureOpenAIClientBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Microsoft.Extensions.Hosting.IHostApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "name": "configureSettings",
+ "type": "System.Action?",
+ "isNullable": true,
+ "isOptional": true
+ },
+ {
+ "name": "configureClientBuilder",
+ "type": "System.Action>?",
+ "isNullable": true,
+ "isOptional": true
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Registers a keyed "
+ },
+ {
+ "kind": "cref",
+ "value": "T:OpenAI.OpenAIClient"
+ },
+ {
+ "kind": "text",
+ "text": " singleton for an Azure OpenAI account's v1 API. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": "Uses "
+ },
+ {
+ "kind": "paramref",
+ "value": "name"
+ },
+ {
+ "kind": "text",
+ "text": " for configuration lookup and keyed resolution. Account endpoints use the v1 API."
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A builder for registering chat, embedding, and Microsoft.Extensions.AI services."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The application builder."
+ }
+ ],
+ "configureClientBuilder": [
+ {
+ "kind": "text",
+ "text": "Customizes the Azure client registration, credential, and OpenAI SDK options."
+ }
+ ],
+ "configureSettings": [
+ {
+ "kind": "text",
+ "text": "Customizes settings after configuration and connection-string binding."
+ }
+ ],
+ "name": [
+ {
+ "kind": "text",
+ "text": "The service key and account connection-string name."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "builder"
+ },
+ {
+ "kind": "text",
+ "text": " is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "name"
+ },
+ {
+ "kind": "text",
+ "text": " is null or empty, or the connection string is invalid."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.AddKeyedAzureOpenAIClient(\"chat\").AddKeyedChatClient(\"chat-client\", \"deployment\");\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireAzureOpenAIExtensions.cs",
+ "sourceLines": "79-83"
+ }
+ ]
+ },
+ {
+ "name": "AspireAzureProjectOpenAIExtensions",
+ "fullName": "Microsoft.Extensions.Hosting.AspireAzureProjectOpenAIExtensions",
+ "namespace": "Microsoft.Extensions.Hosting",
+ "kind": "class",
+ "accessibility": "public",
+ "isStatic": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Registers Azure AI Project OpenAI clients with configuration and Microsoft.Extensions.AI telemetry. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireAzureProjectOpenAIExtensions.cs",
+ "sourceLines": "22-22",
+ "members": [
+ {
+ "name": "AddAzureProjectOpenAIClient",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static AspireAzureProjectOpenAIClientBuilder AspireAzureProjectOpenAIExtensions.AddAzureProjectOpenAIClient(this IHostApplicationBuilder builder, string connectionName, Action? configureSettings = null, Action>? configureClientBuilder = null)",
+ "returnType": "Aspire.Azure.AI.Extensions.OpenAI.AspireAzureProjectOpenAIClientBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Microsoft.Extensions.Hosting.IHostApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "connectionName",
+ "type": "string"
+ },
+ {
+ "name": "configureSettings",
+ "type": "System.Action?",
+ "isNullable": true,
+ "isOptional": true
+ },
+ {
+ "name": "configureClientBuilder",
+ "type": "System.Action>?",
+ "isNullable": true,
+ "isOptional": true
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Registers "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Azure.AI.Extensions.OpenAI.ProjectOpenAIClient"
+ },
+ {
+ "kind": "text",
+ "text": " and its "
+ },
+ {
+ "kind": "cref",
+ "value": "T:OpenAI.OpenAIClient"
+ },
+ {
+ "kind": "text",
+ "text": " alias as singletons. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": "Reads configuration from "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire:Azure:AI:Extensions:OpenAI"
+ },
+ {
+ "kind": "text",
+ "text": " and its connection-specific subsection."
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A builder for registering model clients and Microsoft.Extensions.AI services."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The application builder."
+ }
+ ],
+ "configureClientBuilder": [
+ {
+ "kind": "text",
+ "text": "Customizes the Azure client registration and options."
+ }
+ ],
+ "configureSettings": [
+ {
+ "kind": "text",
+ "text": "Customizes settings after configuration and connection-string binding."
+ }
+ ],
+ "connectionName": [
+ {
+ "kind": "text",
+ "text": "The project connection-string name."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "builder"
+ },
+ {
+ "kind": "text",
+ "text": " is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "connectionName"
+ },
+ {
+ "kind": "text",
+ "text": " is null or empty, or the connection string is invalid."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.AddAzureProjectOpenAIClient(\"project\").AddChatClient(\"chat\");\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireAzureProjectOpenAIExtensions.cs",
+ "sourceLines": "48-54"
+ },
+ {
+ "name": "AddKeyedAzureProjectOpenAIClient",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static AspireAzureProjectOpenAIClientBuilder AspireAzureProjectOpenAIExtensions.AddKeyedAzureProjectOpenAIClient(this IHostApplicationBuilder builder, string name, Action? configureSettings = null, Action>? configureClientBuilder = null)",
+ "returnType": "Aspire.Azure.AI.Extensions.OpenAI.AspireAzureProjectOpenAIClientBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Microsoft.Extensions.Hosting.IHostApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "name": "configureSettings",
+ "type": "System.Action?",
+ "isNullable": true,
+ "isOptional": true
+ },
+ {
+ "name": "configureClientBuilder",
+ "type": "System.Action>?",
+ "isNullable": true,
+ "isOptional": true
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Registers "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Azure.AI.Extensions.OpenAI.ProjectOpenAIClient"
+ },
+ {
+ "kind": "text",
+ "text": " and its "
+ },
+ {
+ "kind": "cref",
+ "value": "T:OpenAI.OpenAIClient"
+ },
+ {
+ "kind": "text",
+ "text": " alias as keyed singletons. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": "Uses "
+ },
+ {
+ "kind": "paramref",
+ "value": "name"
+ },
+ {
+ "kind": "text",
+ "text": " for both configuration lookup and keyed service resolution."
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A builder for registering model clients and Microsoft.Extensions.AI services."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The application builder."
+ }
+ ],
+ "configureClientBuilder": [
+ {
+ "kind": "text",
+ "text": "Customizes the Azure client registration and options."
+ }
+ ],
+ "configureSettings": [
+ {
+ "kind": "text",
+ "text": "Customizes settings after configuration and connection-string binding."
+ }
+ ],
+ "name": [
+ {
+ "kind": "text",
+ "text": "The service key and project connection-string name."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "builder"
+ },
+ {
+ "kind": "text",
+ "text": " is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "name"
+ },
+ {
+ "kind": "text",
+ "text": " is null or empty, or the connection string is invalid."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.AddKeyedAzureProjectOpenAIClient(\"project\").AddKeyedChatClient(\"chat-client\", \"chat\");\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireAzureProjectOpenAIExtensions.cs",
+ "sourceLines": "79-85"
+ }
+ ]
+ },
+ {
+ "name": "AspireConfigurableOpenAIExtensions",
+ "fullName": "Microsoft.Extensions.Hosting.AspireConfigurableOpenAIExtensions",
+ "namespace": "Microsoft.Extensions.Hosting",
+ "kind": "class",
+ "accessibility": "public",
+ "isStatic": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Registers OpenAI clients with endpoint and authentication selection based on connection configuration. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireConfigurableOpenAIExtensions.cs",
+ "sourceLines": "14-14",
+ "members": [
+ {
+ "name": "AddKeyedOpenAIClientFromConfiguration",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static AspireOpenAIClientBuilder AspireConfigurableOpenAIExtensions.AddKeyedOpenAIClientFromConfiguration(this IHostApplicationBuilder builder, string name)",
+ "returnType": "Aspire.OpenAI.AspireOpenAIClientBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Microsoft.Extensions.Hosting.IHostApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "name",
+ "type": "string"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Registers a keyed "
+ },
+ {
+ "kind": "cref",
+ "value": "T:OpenAI.OpenAIClient"
+ },
+ {
+ "kind": "text",
+ "text": " singleton, selecting OpenAI-compatible, Azure account, or Foundry project registration from the connection string. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": "Uses the same endpoint and authentication selection as "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Microsoft.Extensions.Hosting.AspireConfigurableOpenAIExtensions.AddOpenAIClientFromConfiguration(Microsoft.Extensions.Hosting.IHostApplicationBuilder,System.String)"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A builder for registering keyed chat and embedding services."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The application builder."
+ }
+ ],
+ "name": [
+ {
+ "kind": "text",
+ "text": "The service key and connection-string name."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "builder"
+ },
+ {
+ "kind": "text",
+ "text": " is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "The name is empty or connection information is malformed."
+ }
+ ]
+ },
+ {
+ "type": "T:System.InvalidOperationException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "The connection string has neither an endpoint nor an API key."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.AddKeyedOpenAIClientFromConfiguration(\"chat\").AddKeyedChatClient(\"chat-client\");\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireConfigurableOpenAIExtensions.cs",
+ "sourceLines": "69-77"
+ },
+ {
+ "name": "AddOpenAIClientFromConfiguration",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static AspireOpenAIClientBuilder AspireConfigurableOpenAIExtensions.AddOpenAIClientFromConfiguration(this IHostApplicationBuilder builder, string connectionName)",
+ "returnType": "Aspire.OpenAI.AspireOpenAIClientBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Microsoft.Extensions.Hosting.IHostApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "connectionName",
+ "type": "string"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Registers an "
+ },
+ {
+ "kind": "cref",
+ "value": "T:OpenAI.OpenAIClient"
+ },
+ {
+ "kind": "text",
+ "text": " singleton, selecting OpenAI-compatible, Azure account, or Foundry project registration from the connection string. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Azure endpoints use Microsoft Entra authentication unless an account API key is supplied. Other endpoints, including Foundry Local, use the configured API key. The "
+ },
+ {
+ "kind": "code",
+ "text": "IsAzure"
+ },
+ {
+ "kind": "text",
+ "text": " connection-string field overrides Azure account detection for custom domains. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A builder for registering chat and embedding services."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The application builder."
+ }
+ ],
+ "connectionName": [
+ {
+ "kind": "text",
+ "text": "The connection-string name."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "builder"
+ },
+ {
+ "kind": "text",
+ "text": " is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "The name is empty or connection information is malformed."
+ }
+ ]
+ },
+ {
+ "type": "T:System.InvalidOperationException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "The connection string has neither an endpoint nor an API key."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.AddOpenAIClientFromConfiguration(\"chat\").AddChatClient();\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Extensions.OpenAI/AspireConfigurableOpenAIExtensions.cs",
+ "sourceLines": "39-47"
+ }
+ ]
+ }
+ ]
+}
\ No newline at end of file
diff --git a/src/frontend/src/data/pkgs/Aspire.Azure.AI.Projects.17.0.0-preview.1.26565.2.json b/src/frontend/src/data/pkgs/Aspire.Azure.AI.Projects.17.0.0-preview.1.26565.2.json
new file mode 100644
index 0000000000..60fbbe31ff
--- /dev/null
+++ b/src/frontend/src/data/pkgs/Aspire.Azure.AI.Projects.17.0.0-preview.1.26565.2.json
@@ -0,0 +1,381 @@
+{
+ "package": {
+ "name": "Aspire.Azure.AI.Projects",
+ "version": "17.0.0-preview.1.26565.2",
+ "targetFramework": "net10.0",
+ "sourceRepository": "https://github.com/microsoft/aspire",
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
+ },
+ "types": [
+ {
+ "name": "AzureAIProjectsSettings",
+ "fullName": "Aspire.Azure.AI.Projects.AzureAIProjectsSettings",
+ "namespace": "Aspire.Azure.AI.Projects",
+ "kind": "class",
+ "accessibility": "public",
+ "isSealed": true,
+ "interfaces": [
+ "Aspire.Azure.Common.IConnectionStringSettings"
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Configures the connection and tracing for an Azure AI Projects client. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Projects/AzureAIProjectsSettings.cs",
+ "sourceLines": "12-12",
+ "members": [
+ {
+ "name": ".ctor",
+ "kind": "constructor",
+ "accessibility": "public",
+ "signature": "public AzureAIProjectsSettings.AzureAIProjectsSettings()",
+ "returnType": "void"
+ },
+ {
+ "name": "Credential",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public TokenCredential? AzureAIProjectsSettings.Credential",
+ "returnType": "Azure.Core.TokenCredential?",
+ "isReturnNullable": true,
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets the Microsoft Entra credential. Uses managed identity in Azure and a development credential locally by default. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Projects/AzureAIProjectsSettings.cs"
+ },
+ {
+ "name": "DisableTracing",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public bool AzureAIProjectsSettings.DisableTracing",
+ "returnType": "bool",
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets whether tracing is disabled. The default is "
+ },
+ {
+ "kind": "langword",
+ "value": "false"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Projects/AzureAIProjectsSettings.cs"
+ },
+ {
+ "name": "Endpoint",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public Uri? AzureAIProjectsSettings.Endpoint",
+ "returnType": "System.Uri?",
+ "isReturnNullable": true,
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets the HTTPS Foundry project endpoint, such as "
+ },
+ {
+ "kind": "code",
+ "text": "https://account.services.ai.azure.com/api/projects/project"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Projects/AzureAIProjectsSettings.cs"
+ }
+ ]
+ },
+ {
+ "name": "AspireAzureAIProjectsExtensions",
+ "fullName": "Microsoft.Extensions.Hosting.AspireAzureAIProjectsExtensions",
+ "namespace": "Microsoft.Extensions.Hosting",
+ "kind": "class",
+ "accessibility": "public",
+ "isStatic": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Provides extension methods for registering Azure AI Projects clients with configuration and tracing. "
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Projects/AspireAzureAIProjectsExtensions.cs",
+ "sourceLines": "19-19",
+ "members": [
+ {
+ "name": "AddAzureAIProjectClient",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static void AspireAzureAIProjectsExtensions.AddAzureAIProjectClient(this IHostApplicationBuilder builder, string connectionName, Action? configureSettings = null, Action>? configureClientBuilder = null)",
+ "returnType": "void",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Microsoft.Extensions.Hosting.IHostApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "connectionName",
+ "type": "string"
+ },
+ {
+ "name": "configureSettings",
+ "type": "System.Action?",
+ "isNullable": true,
+ "isOptional": true
+ },
+ {
+ "name": "configureClientBuilder",
+ "type": "System.Action>?",
+ "isNullable": true,
+ "isOptional": true
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Registers "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Azure.AI.Projects.AIProjectClient"
+ },
+ {
+ "kind": "text",
+ "text": " as a singleton using Microsoft Entra authentication. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": "Reads configuration from "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire:Azure:AI:Projects"
+ },
+ {
+ "kind": "text",
+ "text": " and its connection-specific subsection."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The application builder."
+ }
+ ],
+ "configureClientBuilder": [
+ {
+ "kind": "text",
+ "text": "Customizes the Azure client registration and options."
+ }
+ ],
+ "configureSettings": [
+ {
+ "kind": "text",
+ "text": "Customizes settings after configuration and connection-string binding."
+ }
+ ],
+ "connectionName": [
+ {
+ "kind": "text",
+ "text": "The name of the project connection string."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "builder"
+ },
+ {
+ "kind": "text",
+ "text": " is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "connectionName"
+ },
+ {
+ "kind": "text",
+ "text": " is null or empty, or the connection string is invalid."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.AddAzureAIProjectClient(\"project\");\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Projects/AspireAzureAIProjectsExtensions.cs",
+ "sourceLines": "44-48"
+ },
+ {
+ "name": "AddKeyedAzureAIProjectClient",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static void AspireAzureAIProjectsExtensions.AddKeyedAzureAIProjectClient(this IHostApplicationBuilder builder, string name, Action? configureSettings = null, Action>? configureClientBuilder = null)",
+ "returnType": "void",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Microsoft.Extensions.Hosting.IHostApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "name": "configureSettings",
+ "type": "System.Action?",
+ "isNullable": true,
+ "isOptional": true
+ },
+ {
+ "name": "configureClientBuilder",
+ "type": "System.Action>?",
+ "isNullable": true,
+ "isOptional": true
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Registers "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Azure.AI.Projects.AIProjectClient"
+ },
+ {
+ "kind": "text",
+ "text": " as a keyed singleton using Microsoft Entra authentication. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": "Uses "
+ },
+ {
+ "kind": "paramref",
+ "value": "name"
+ },
+ {
+ "kind": "text",
+ "text": " for both configuration lookup and keyed service resolution."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The application builder."
+ }
+ ],
+ "configureClientBuilder": [
+ {
+ "kind": "text",
+ "text": "Customizes the Azure client registration and options."
+ }
+ ],
+ "configureSettings": [
+ {
+ "kind": "text",
+ "text": "Customizes settings after configuration and connection-string binding."
+ }
+ ],
+ "name": [
+ {
+ "kind": "text",
+ "text": "The service key and project connection-string name."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "builder"
+ },
+ {
+ "kind": "text",
+ "text": " is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "name"
+ },
+ {
+ "kind": "text",
+ "text": " is null or empty, or the connection string is invalid."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.AddKeyedAzureAIProjectClient(\"project\");\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Components/Aspire.Azure.AI.Projects/AspireAzureAIProjectsExtensions.cs",
+ "sourceLines": "71-75"
+ }
+ ]
+ }
+ ]
+}
\ No newline at end of file
diff --git a/src/frontend/src/data/pkgs/Aspire.Azure.Data.Tables.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Azure.Data.Tables.17.0.0.json
similarity index 99%
rename from src/frontend/src/data/pkgs/Aspire.Azure.Data.Tables.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Azure.Data.Tables.17.0.0.json
index e5b559d37d..e0caadc1b9 100644
--- a/src/frontend/src/data/pkgs/Aspire.Azure.Data.Tables.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Azure.Data.Tables.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Azure.Data.Tables",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
diff --git a/src/frontend/src/data/pkgs/Aspire.Azure.Messaging.EventHubs.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Azure.Messaging.EventHubs.17.0.0.json
similarity index 99%
rename from src/frontend/src/data/pkgs/Aspire.Azure.Messaging.EventHubs.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Azure.Messaging.EventHubs.17.0.0.json
index 3012507ae8..19e780e1c4 100644
--- a/src/frontend/src/data/pkgs/Aspire.Azure.Messaging.EventHubs.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Azure.Messaging.EventHubs.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Azure.Messaging.EventHubs",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
diff --git a/src/frontend/src/data/pkgs/Aspire.Azure.Messaging.ServiceBus.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Azure.Messaging.ServiceBus.17.0.0.json
similarity index 99%
rename from src/frontend/src/data/pkgs/Aspire.Azure.Messaging.ServiceBus.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Azure.Messaging.ServiceBus.17.0.0.json
index 6497cfacf8..1414fdb732 100644
--- a/src/frontend/src/data/pkgs/Aspire.Azure.Messaging.ServiceBus.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Azure.Messaging.ServiceBus.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Azure.Messaging.ServiceBus",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
diff --git a/src/frontend/src/data/pkgs/Aspire.Azure.Messaging.WebPubSub.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Azure.Messaging.WebPubSub.17.0.0.json
similarity index 99%
rename from src/frontend/src/data/pkgs/Aspire.Azure.Messaging.WebPubSub.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Azure.Messaging.WebPubSub.17.0.0.json
index 07cfe7ca15..0c131a15d5 100644
--- a/src/frontend/src/data/pkgs/Aspire.Azure.Messaging.WebPubSub.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Azure.Messaging.WebPubSub.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Azure.Messaging.WebPubSub",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
diff --git a/src/frontend/src/data/pkgs/Aspire.Azure.Npgsql.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Azure.Npgsql.17.0.0.json
similarity index 99%
rename from src/frontend/src/data/pkgs/Aspire.Azure.Npgsql.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Azure.Npgsql.17.0.0.json
index 1bb939723c..fe0486f2d3 100644
--- a/src/frontend/src/data/pkgs/Aspire.Azure.Npgsql.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Azure.Npgsql.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Azure.Npgsql",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
diff --git a/src/frontend/src/data/pkgs/Aspire.Azure.Npgsql.EntityFrameworkCore.PostgreSQL.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Azure.Npgsql.EntityFrameworkCore.PostgreSQL.17.0.0-preview.1.26565.2.json
similarity index 98%
rename from src/frontend/src/data/pkgs/Aspire.Azure.Npgsql.EntityFrameworkCore.PostgreSQL.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Azure.Npgsql.EntityFrameworkCore.PostgreSQL.17.0.0-preview.1.26565.2.json
index f70d0c80fb..16043131af 100644
--- a/src/frontend/src/data/pkgs/Aspire.Azure.Npgsql.EntityFrameworkCore.PostgreSQL.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Azure.Npgsql.EntityFrameworkCore.PostgreSQL.17.0.0-preview.1.26565.2.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Azure.Npgsql.EntityFrameworkCore.PostgreSQL",
- "version": "13.6.5",
+ "version": "17.0.0-preview.1.26565.2",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
@@ -70,7 +70,7 @@
]
},
"sourceFile": "src/Components/Aspire.Azure.Npgsql.EntityFrameworkCore.PostgreSQL/AspireAzureEFPostgreSqlExtensions.cs",
- "sourceLines": "23-23",
+ "sourceLines": "17-17",
"members": [
{
"name": "AddAzureNpgsqlDbContext",
@@ -266,7 +266,7 @@
]
},
"sourceFile": "src/Components/Aspire.Azure.Npgsql.EntityFrameworkCore.PostgreSQL/AspireAzureEFPostgreSqlExtensions.cs",
- "sourceLines": "52-65"
+ "sourceLines": "46-59"
},
{
"name": "EnrichAzureNpgsqlDbContext",
@@ -350,7 +350,7 @@
]
},
"sourceFile": "src/Components/Aspire.Azure.Npgsql.EntityFrameworkCore.PostgreSQL/AspireAzureEFPostgreSqlExtensions.cs",
- "sourceLines": "77-94"
+ "sourceLines": "71-81"
}
]
}
diff --git a/src/frontend/src/data/pkgs/Aspire.Azure.Search.Documents.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Azure.Search.Documents.17.0.0.json
similarity index 99%
rename from src/frontend/src/data/pkgs/Aspire.Azure.Search.Documents.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Azure.Search.Documents.17.0.0.json
index 359b2e7309..6af23475b3 100644
--- a/src/frontend/src/data/pkgs/Aspire.Azure.Search.Documents.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Azure.Search.Documents.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Azure.Search.Documents",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
diff --git a/src/frontend/src/data/pkgs/Aspire.Azure.Security.KeyVault.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Azure.Security.KeyVault.17.0.0.json
similarity index 99%
rename from src/frontend/src/data/pkgs/Aspire.Azure.Security.KeyVault.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Azure.Security.KeyVault.17.0.0.json
index b08e790aa6..ac3247a6e8 100644
--- a/src/frontend/src/data/pkgs/Aspire.Azure.Security.KeyVault.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Azure.Security.KeyVault.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Azure.Security.KeyVault",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
diff --git a/src/frontend/src/data/pkgs/Aspire.Azure.Storage.Blobs.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Azure.Storage.Blobs.17.0.0.json
similarity index 99%
rename from src/frontend/src/data/pkgs/Aspire.Azure.Storage.Blobs.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Azure.Storage.Blobs.17.0.0.json
index 7938815686..6b9ca99f7d 100644
--- a/src/frontend/src/data/pkgs/Aspire.Azure.Storage.Blobs.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Azure.Storage.Blobs.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Azure.Storage.Blobs",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
diff --git a/src/frontend/src/data/pkgs/Aspire.Azure.Storage.Files.DataLake.13.6.5-preview.1.26559.7.json b/src/frontend/src/data/pkgs/Aspire.Azure.Storage.Files.DataLake.17.0.0-preview.1.26565.2.json
similarity index 99%
rename from src/frontend/src/data/pkgs/Aspire.Azure.Storage.Files.DataLake.13.6.5-preview.1.26559.7.json
rename to src/frontend/src/data/pkgs/Aspire.Azure.Storage.Files.DataLake.17.0.0-preview.1.26565.2.json
index 845e6610fa..38d81a8546 100644
--- a/src/frontend/src/data/pkgs/Aspire.Azure.Storage.Files.DataLake.13.6.5-preview.1.26559.7.json
+++ b/src/frontend/src/data/pkgs/Aspire.Azure.Storage.Files.DataLake.17.0.0-preview.1.26565.2.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Azure.Storage.Files.DataLake",
- "version": "13.6.5-preview.1.26559.7",
+ "version": "17.0.0-preview.1.26565.2",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
@@ -26,7 +26,7 @@
}
]
},
- "sourceFile": "artifacts/obj/Aspire.Azure.Storage.Files.DataLake/Release/net8.0/System.Text.RegularExpressions.Generator/System.Text.RegularExpressions.Generator.RegexGenerator/RegexGenerator.g.cs",
+ "sourceFile": "artifacts/obj/Aspire.Azure.Storage.Files.DataLake/Release/net10.0/System.Text.RegularExpressions.Generator/System.Text.RegularExpressions.Generator.RegexGenerator/RegexGenerator.g.cs",
"sourceLines": "21-21",
"members": [
{
diff --git a/src/frontend/src/data/pkgs/Aspire.Azure.Storage.Queues.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Azure.Storage.Queues.17.0.0.json
similarity index 99%
rename from src/frontend/src/data/pkgs/Aspire.Azure.Storage.Queues.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Azure.Storage.Queues.17.0.0.json
index 34ccfd5a33..2a8265f196 100644
--- a/src/frontend/src/data/pkgs/Aspire.Azure.Storage.Queues.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Azure.Storage.Queues.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Azure.Storage.Queues",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
diff --git a/src/frontend/src/data/pkgs/Aspire.Confluent.Kafka.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Confluent.Kafka.17.0.0.json
similarity index 99%
rename from src/frontend/src/data/pkgs/Aspire.Confluent.Kafka.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Confluent.Kafka.17.0.0.json
index ea44eddf3a..f134f08e8e 100644
--- a/src/frontend/src/data/pkgs/Aspire.Confluent.Kafka.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Confluent.Kafka.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Confluent.Kafka",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
diff --git a/src/frontend/src/data/pkgs/Aspire.Hosting.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Hosting.17.0.0.json
similarity index 95%
rename from src/frontend/src/data/pkgs/Aspire.Hosting.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Hosting.17.0.0.json
index fb474cde96..0e37671fb2 100644
--- a/src/frontend/src/data/pkgs/Aspire.Hosting.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Hosting.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Hosting",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
@@ -1431,7 +1431,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var apiKey = builder.AddParameter(\"apiKey\", secret: true);\n \n var cs = builder.AddConnectionString(\"cs\", ReferenceExpression.Create($\"Endpoint=http://something;Key={apiKey}\"));\n \n var backend = builder\n .AddProject(\"backend\")\n .WithReference(cs)\n .WaitFor(database);\n \n builder.Build().Run();\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var apiKey = builder.AddParameter(\"apiKey\", secret: true);\n \n var cs = builder.AddConnectionString(\"cs\", ReferenceExpression.Create($\"Endpoint=http://something;Key={apiKey}\"));\n \n var backend = builder\n .AddDotnetProject(\"backend\", \"../Backend/Backend.csproj\")\n .WithReference(cs);\n \n builder.Build().Run();\n ",
"language": "csharp"
}
],
@@ -1471,7 +1471,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ConnectionStringBuilderExtensions.cs",
- "sourceLines": "43-116"
+ "sourceLines": "42-115"
},
{
"name": "AddConnectionString",
@@ -1553,13 +1553,13 @@
},
"examples": [
{
- "code": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var apiKey = builder.AddParameter(\"apiKey\", secret: true);\n \n var cs = builder.AddConnectionString(\"cs\", b => b.Append($\"Endpoint=http://something;Key={apiKey}\"));\n \n var backend = builder\n .AddProject(\"backend\")\n .WithReference(cs)\n .WaitFor(database);\n \n builder.Build().Run();\n ",
+ "code": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var apiKey = builder.AddParameter(\"apiKey\", secret: true);\n \n var cs = builder.AddConnectionString(\"cs\", b => b.Append($\"Endpoint=http://something;Key={apiKey}\"));\n \n var backend = builder\n .AddDotnetProject(\"backend\", \"../Backend/Backend.csproj\")\n .WithReference(cs);\n \n builder.Build().Run();\n ",
"language": "csharp"
}
]
},
"sourceFile": "src/Aspire.Hosting/ConnectionStringBuilderExtensions.cs",
- "sourceLines": "148-150"
+ "sourceLines": "146-148"
}
]
},
@@ -2043,7 +2043,7 @@
},
"examples": [
{
- "code": "\n var registry = builder.AddContainerRegistry(\"docker-hub\", \"docker.io\", \"myusername\");\n var project = builder.AddProject(\"myproject\")\n .WithContainerRegistry(registry);\n ",
+ "code": "\n var registry = builder.AddContainerRegistry(\"docker-hub\", \"docker.io\", \"myusername\");\n var project = builder.AddDotnetProject(\"myproject\", \"../MyProject/MyProject.csproj\")\n .WithContainerRegistry(registry);\n ",
"language": "csharp",
"description": [
{
@@ -2083,7 +2083,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "25-25",
+ "sourceLines": "22-22",
"members": [
{
"name": "AddContainer",
@@ -2167,7 +2167,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "119-125"
+ "sourceLines": "116-122"
},
{
"name": "AddContainer",
@@ -2261,7 +2261,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "139-140"
+ "sourceLines": "136-137"
},
{
"name": "AddDockerfile",
@@ -2467,7 +2467,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "923-928"
+ "sourceLines": "947-952"
},
{
"name": "AddDockerfileBuilder",
@@ -2505,15 +2505,6 @@
"attributes": [
{
"name": "Aspire.Hosting.AspireExportAttribute"
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"docs": {
@@ -2680,15 +2671,6 @@
"arguments": {
"Reason": "This synchronous overload is excluded from the polyglot surface; only the async callback overload is exported."
}
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"docs": {
@@ -3138,7 +3120,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "632-634"
+ "sourceLines": "656-658"
},
{
"name": "WithBindMount",
@@ -3241,6 +3223,23 @@
}
]
},
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " Adding a bind mount that is identical to an existing one (same source, target and read-only setting) has no effect. Adding a bind mount to a target that already has a different mount throws an "
+ },
+ {
+ "kind": "cref",
+ "value": "T:System.InvalidOperationException"
+ },
+ {
+ "kind": "text",
+ "text": ", because container runtimes reject duplicate mount targets. "
+ }
+ ]
+ },
{
"kind": "text",
"text": " Adds a bind mount that will mount the "
@@ -3342,7 +3341,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "321-328"
+ "sourceLines": "323-352"
},
{
"name": "WithBuildArg",
@@ -3833,7 +3832,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "1278-1291"
+ "sourceLines": "1308-1321"
},
{
"name": "WithContainerCertificatePaths",
@@ -3995,7 +3994,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "1309-1316"
+ "sourceLines": "1339-1346"
},
{
"name": "WithContainerFiles",
@@ -4191,7 +4190,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "1390-1403"
+ "sourceLines": "1420-1433"
},
{
"name": "WithContainerFiles",
@@ -4355,7 +4354,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "1462-1475"
+ "sourceLines": "1492-1505"
},
{
"name": "WithContainerFiles",
@@ -4491,7 +4490,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "1494-1523"
+ "sourceLines": "1524-1553"
},
{
"name": "WithContainerName",
@@ -4584,7 +4583,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "1107-1110"
+ "sourceLines": "1137-1140"
},
{
"name": "WithContainerNetworkAlias",
@@ -4683,7 +4682,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "1880-1880"
+ "sourceLines": "1976-1976"
},
{
"name": "WithContainerRuntimeArgs",
@@ -4777,7 +4776,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "510-512"
+ "sourceLines": "534-536"
},
{
"name": "WithContainerRuntimeArgs",
@@ -5204,7 +5203,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "679-734"
+ "sourceLines": "703-758"
},
{
"name": "WithDockerfileBaseImage",
@@ -5244,15 +5243,6 @@
"attributes": [
{
"name": "Aspire.Hosting.AspireExportAttribute"
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"docs": {
@@ -5326,7 +5316,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "1845-1856"
+ "sourceLines": "1941-1952"
},
{
"name": "WithDockerfileBuilder",
@@ -5368,15 +5358,6 @@
"attributes": [
{
"name": "Aspire.Hosting.AspireExportAttribute"
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"docs": {
@@ -5557,15 +5538,6 @@
"arguments": {
"Reason": "This synchronous overload is excluded from the polyglot surface; only the async callback overload is exported."
}
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"docs": {
@@ -6148,7 +6120,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "44-44"
+ "sourceLines": "41-41"
},
{
"name": "WithEntrypoint",
@@ -6227,7 +6199,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "342-346"
+ "sourceLines": "366-370"
},
{
"name": "WithImage",
@@ -6318,7 +6290,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "415-469"
+ "sourceLines": "439-493"
},
{
"name": "WithImagePullPolicy",
@@ -6397,7 +6369,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "614-616"
+ "sourceLines": "638-640"
},
{
"name": "WithImageRegistry",
@@ -6477,7 +6449,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "392-400"
+ "sourceLines": "416-424"
},
{
"name": "WithImageSHA256",
@@ -6556,7 +6528,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "483-492"
+ "sourceLines": "507-516"
},
{
"name": "WithImageTag",
@@ -6635,7 +6607,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "360-378"
+ "sourceLines": "384-402"
},
{
"name": "WithLifetime",
@@ -6766,7 +6738,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "588-600"
+ "sourceLines": "612-624"
},
{
"name": "WithVolume",
@@ -6966,7 +6938,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "230-230"
+ "sourceLines": "227-227"
},
{
"name": "WithVolume",
@@ -7126,7 +7098,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ContainerResourceBuilderExtensions.cs",
- "sourceLines": "267-267"
+ "sourceLines": "264-264"
}
]
},
@@ -7530,11 +7502,19 @@
},
{
"kind": "text",
- "text": " The following example shows creating a PostgreSQL server resource with a database and referencing that database in a .NET project. "
+ "text": " The following example shows creating a PostgreSQL server resource with a database and referencing that database in a .NET project using the "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": " package. "
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var inventoryDatabase = builder.AddPostgres(\"mypostgres\").AddDatabase(\"inventory\");\n builder.AddProject()\n .WithReference(inventoryDatabase);\n \n builder.Build().Run();\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var inventoryDatabase = builder.AddPostgres(\"mypostgres\").AddDatabase(\"inventory\");\n builder.AddDotnetProject(\"inventoryservice\", \"../InventoryService/InventoryService.csproj\")\n .WithReference(inventoryDatabase);\n \n builder.Build().Run();\n ",
"language": "csharp"
}
]
@@ -7592,7 +7572,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplication.cs",
- "sourceLines": "78-90"
+ "sourceLines": "78-91"
},
{
"name": "CreateBuilder",
@@ -7655,11 +7635,19 @@
},
{
"kind": "text",
- "text": " The following example is creating a Postgres server resource with a database and referencing that database in a .NET project. "
+ "text": " The following example is creating a Postgres server resource with a database and referencing that database in a .NET project using the "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": " package. "
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder();\n var inventoryDatabase = builder.AddPostgres(\"mypostgres\").AddDatabase(\"inventory\");\n builder.AddProject()\n .WithReference(inventoryDatabase);\n \n builder.Build().Run();\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder();\n var inventoryDatabase = builder.AddPostgres(\"mypostgres\").AddDatabase(\"inventory\");\n builder.AddDotnetProject(\"inventoryservice\", \"../InventoryService/InventoryService.csproj\")\n .WithReference(inventoryDatabase);\n \n builder.Build().Run();\n ",
"language": "csharp"
}
],
@@ -7679,7 +7667,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplication.cs",
- "sourceLines": "115-115"
+ "sourceLines": "116-116"
},
{
"name": "CreateBuilder",
@@ -7786,11 +7774,19 @@
},
{
"kind": "text",
- "text": " The following example shows creating a Postgres server resource with a database and referencing that database in a .NET project. "
+ "text": " The following example shows creating a Postgres server resource with a database and referencing that database in a .NET project using the "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": " package. "
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var inventoryDatabase = builder.AddPostgres(\"mypostgres\").AddDatabase(\"inventory\");\n builder.AddProject()\n .WithReference(inventoryDatabase);\n \n builder.Build().Run();\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var inventoryDatabase = builder.AddPostgres(\"mypostgres\").AddDatabase(\"inventory\");\n builder.AddDotnetProject(\"inventoryservice\", \"../InventoryService/InventoryService.csproj\")\n .WithReference(inventoryDatabase);\n \n builder.Build().Run();\n ",
"language": "csharp"
},
{
@@ -7799,7 +7795,7 @@
},
{
"kind": "codeblock",
- "text": "\n public class Program\n {\n public static void Main(string[] args)\n {\n var builder = DistributedApplication.CreateBuilder(args);\n var inventoryDatabase = builder.AddPostgres(\"mypostgres\").AddDatabase(\"inventory\");\n builder.AddProject()\n .WithReference(inventoryDatabase);\n \n builder.Build().Run();\n }\n }\n ",
+ "text": "\n public class Program\n {\n public static void Main(string[] args)\n {\n var builder = DistributedApplication.CreateBuilder(args);\n var inventoryDatabase = builder.AddPostgres(\"mypostgres\").AddDatabase(\"inventory\");\n builder.AddDotnetProject(\"inventoryservice\", \"../InventoryService/InventoryService.csproj\")\n .WithReference(inventoryDatabase);\n \n builder.Build().Run();\n }\n }\n ",
"language": "csharp"
}
],
@@ -7827,7 +7823,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplication.cs",
- "sourceLines": "168-174"
+ "sourceLines": "169-175"
},
{
"name": "CreateBuilder",
@@ -7942,11 +7938,19 @@
},
{
"kind": "text",
- "text": " Override the container registry used by the distributed application. "
+ "text": " Override the container registry used by the distributed application. The .NET project example requires the "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": " package. "
},
{
"kind": "codeblock",
- "text": "\n var options = new DistributedApplicationOptions\n {\n Args = args; // Important for deployment tools\n ContainerRegistryOverride = \"registry.example.com\"\n };\n var builder = DistributedApplication.CreateBuilder(options);\n var inventoryDatabase = builder.AddPostgres(\"mypostgres\").AddDatabase(\"inventory\");\n builder.AddProject()\n .WithReference(inventoryDatabase);\n \n builder.Build().Run();\n ",
+ "text": "\n var options = new DistributedApplicationOptions\n {\n Args = args, // Important for deployment tools\n ContainerRegistryOverride = \"registry.example.com\"\n };\n var builder = DistributedApplication.CreateBuilder(options);\n var inventoryDatabase = builder.AddPostgres(\"mypostgres\").AddDatabase(\"inventory\");\n builder.AddDotnetProject(\"inventoryservice\", \"../InventoryService/InventoryService.csproj\")\n .WithReference(inventoryDatabase);\n \n builder.Build().Run();\n ",
"language": "csharp"
}
],
@@ -8102,7 +8106,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplication.cs",
- "sourceLines": "425-426"
+ "sourceLines": "429-430"
},
{
"name": "DisposeAsync",
@@ -8237,7 +8241,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplication.cs",
- "sourceLines": "457-457"
+ "sourceLines": "461-461"
},
{
"name": "Run",
@@ -8336,7 +8340,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplication.cs",
- "sourceLines": "603-604"
+ "sourceLines": "614-615"
},
{
"name": "RunAsync",
@@ -8476,7 +8480,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplication.cs",
- "sourceLines": "535-573"
+ "sourceLines": "540-580"
},
{
"name": "StartAsync",
@@ -8547,7 +8551,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplication.cs",
- "sourceLines": "464-492"
+ "sourceLines": "468-497"
},
{
"name": "StopAsync",
@@ -8602,7 +8606,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplication.cs",
- "sourceLines": "497-504"
+ "sourceLines": "502-509"
},
{
"name": "ResourceCommands",
@@ -8656,7 +8660,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplication.cs",
- "sourceLines": "395-395"
+ "sourceLines": "399-399"
},
{
"name": "ResourceNotifications",
@@ -8746,7 +8750,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplication.cs",
- "sourceLines": "383-383"
+ "sourceLines": "387-387"
},
{
"name": "Services",
@@ -8848,7 +8852,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplication.cs",
- "sourceLines": "331-331"
+ "sourceLines": "335-335"
}
]
},
@@ -8946,7 +8950,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "71-71",
+ "sourceLines": "68-68",
"members": [
{
"name": ".ctor",
@@ -9012,7 +9016,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "131-134"
+ "sourceLines": "129-132"
},
{
"name": ".ctor",
@@ -9119,7 +9123,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "106-681"
+ "sourceLines": "104-695"
},
{
"name": "AddResource",
@@ -9267,7 +9271,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "906-911"
+ "sourceLines": "926-931"
},
{
"name": "Build",
@@ -9349,7 +9353,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "876-900"
+ "sourceLines": "891-920"
},
{
"name": "CreateResourceBuilder",
@@ -9607,7 +9611,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "917-920"
+ "sourceLines": "937-940"
},
{
"name": "AppHostAssembly",
@@ -9626,7 +9630,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "100-100"
+ "sourceLines": "98-98"
},
{
"name": "AppHostDirectory",
@@ -9644,7 +9648,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "94-94"
+ "sourceLines": "92-92"
},
{
"name": "AppHostPath",
@@ -9655,7 +9659,7 @@
"hasGet": true,
"docs": {},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "97-97"
+ "sourceLines": "95-95"
},
{
"name": "Configuration",
@@ -9679,7 +9683,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "88-88"
+ "sourceLines": "86-86"
},
{
"name": "Environment",
@@ -9697,7 +9701,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "85-85"
+ "sourceLines": "83-83"
},
{
"name": "Eventing",
@@ -9715,7 +9719,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "109-109"
+ "sourceLines": "107-107"
},
{
"name": "ExecutionContext",
@@ -9814,7 +9818,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "103-103"
+ "sourceLines": "101-101"
},
{
"name": "FileSystemService",
@@ -9876,7 +9880,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "115-115"
+ "sourceLines": "113-113"
},
{
"name": "Pipeline",
@@ -9900,7 +9904,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "112-112"
+ "sourceLines": "110-110"
},
{
"name": "Resources",
@@ -9924,7 +9928,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "106-106"
+ "sourceLines": "104-104"
},
{
"name": "Services",
@@ -9942,7 +9946,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "91-91"
+ "sourceLines": "89-89"
},
{
"name": "UserSecretsManager",
@@ -9979,7 +9983,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationBuilder.cs",
- "sourceLines": "118-118"
+ "sourceLines": "116-116"
}
]
},
@@ -10295,28 +10299,12 @@
"summary": [
{
"kind": "text",
- "text": " Provides extension methods for subscribing to "
- },
- {
- "kind": "cref",
- "value": "T:Aspire.Hosting.Eventing.IDistributedApplicationEvent"
- },
- {
- "kind": "text",
- "text": " and "
- },
- {
- "kind": "cref",
- "value": "T:Aspire.Hosting.Eventing.IDistributedApplicationResourceEvent"
- },
- {
- "kind": "text",
- "text": " events. "
+ "text": " Provides extension methods for publishing resource allocation and subscribing to application events. "
}
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationEventingExtensions.cs",
- "sourceLines": "13-13",
+ "sourceLines": "15-15",
"members": [
{
"name": "OnAfterPublish",
@@ -10412,7 +10400,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationEventingExtensions.cs",
- "sourceLines": "49-49"
+ "sourceLines": "90-90"
},
{
"name": "OnBeforePublish",
@@ -10508,7 +10496,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationEventingExtensions.cs",
- "sourceLines": "37-37"
+ "sourceLines": "78-78"
},
{
"name": "OnBeforeResourceStarted",
@@ -10604,7 +10592,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationEventingExtensions.cs",
- "sourceLines": "62-62"
+ "sourceLines": "103-103"
},
{
"name": "OnBeforeStart",
@@ -10700,7 +10688,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationEventingExtensions.cs",
- "sourceLines": "25-25"
+ "sourceLines": "66-66"
},
{
"name": "OnConnectionStringAvailable",
@@ -10804,7 +10792,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationEventingExtensions.cs",
- "sourceLines": "88-88"
+ "sourceLines": "129-129"
},
{
"name": "OnInitializeResource",
@@ -10908,7 +10896,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationEventingExtensions.cs",
- "sourceLines": "101-101"
+ "sourceLines": "142-142"
},
{
"name": "OnResourceEndpointsAllocated",
@@ -11012,7 +11000,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationEventingExtensions.cs",
- "sourceLines": "114-114"
+ "sourceLines": "155-155"
},
{
"name": "OnResourceReady",
@@ -11116,7 +11104,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationEventingExtensions.cs",
- "sourceLines": "127-127"
+ "sourceLines": "168-168"
},
{
"name": "OnResourceStopped",
@@ -11220,7 +11208,203 @@
}
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationEventingExtensions.cs",
- "sourceLines": "75-75"
+ "sourceLines": "116-116"
+ },
+ {
+ "name": "PublishResourceEndpointsAllocatedAsync",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static Task DistributedApplicationEventingExtensions.PublishResourceEndpointsAllocatedAsync(this IDistributedApplicationEventing eventing, ResourceEndpointsAllocatedEvent @event, CancellationToken cancellationToken)",
+ "returnType": "System.Threading.Tasks.Task",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "eventing",
+ "type": "Aspire.Hosting.Eventing.IDistributedApplicationEventing",
+ "modifier": "this"
+ },
+ {
+ "name": "event",
+ "type": "Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent"
+ },
+ {
+ "name": "cancellationToken",
+ "type": "System.Threading.CancellationToken"
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "Endpoint allocation completion is used by .NET resource integrations."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Completes a resource's endpoint allocation before notifying subscribers. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Call this after assigning the resource's physical endpoints. The host awaits URL customization and finalizes browser origins before dispatching the allocation notification. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A task that completes after URL customization and notification dispatch."
+ }
+ ],
+ "parameters": {
+ "cancellationToken": [
+ {
+ "kind": "text",
+ "text": "The cancellation token."
+ }
+ ],
+ "event": [
+ {
+ "kind": "text",
+ "text": "The resource allocation notification."
+ }
+ ],
+ "eventing": [
+ {
+ "kind": "text",
+ "text": "The event dispatcher."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "An argument is "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ]
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/DistributedApplicationEventingExtensions.cs",
+ "sourceLines": "31-31"
+ },
+ {
+ "name": "PublishResourceEndpointsAllocatedAsync",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static Task DistributedApplicationEventingExtensions.PublishResourceEndpointsAllocatedAsync(this IDistributedApplicationEventing eventing, ResourceEndpointsAllocatedEvent @event, EventDispatchBehavior dispatchBehavior, CancellationToken cancellationToken)",
+ "returnType": "System.Threading.Tasks.Task",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "eventing",
+ "type": "Aspire.Hosting.Eventing.IDistributedApplicationEventing",
+ "modifier": "this"
+ },
+ {
+ "name": "event",
+ "type": "Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent"
+ },
+ {
+ "name": "dispatchBehavior",
+ "type": "Aspire.Hosting.Eventing.EventDispatchBehavior"
+ },
+ {
+ "name": "cancellationToken",
+ "type": "System.Threading.CancellationToken"
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "Endpoint allocation completion is used by .NET resource integrations."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Completes a resource's endpoint allocation before dispatching its notification with the specified behavior. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " URL customization is always awaited before notification dispatch, including when subscribers use a non-blocking dispatch behavior. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A task that completes after URL customization and the requested notification dispatch."
+ }
+ ],
+ "parameters": {
+ "cancellationToken": [
+ {
+ "kind": "text",
+ "text": "The cancellation token."
+ }
+ ],
+ "dispatchBehavior": [
+ {
+ "kind": "text",
+ "text": "The dispatch behavior for notification subscribers."
+ }
+ ],
+ "event": [
+ {
+ "kind": "text",
+ "text": "The resource allocation notification."
+ }
+ ],
+ "eventing": [
+ {
+ "kind": "text",
+ "text": "The event dispatcher."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "An argument is "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ]
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/DistributedApplicationEventingExtensions.cs",
+ "sourceLines": "49-53"
}
]
},
@@ -11601,7 +11785,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationExecutionContext.cs",
- "sourceLines": "104-104"
+ "sourceLines": "108-108"
},
{
"name": "IsRunMode",
@@ -11619,7 +11803,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationExecutionContext.cs",
- "sourceLines": "109-109"
+ "sourceLines": "113-113"
},
{
"name": "Operation",
@@ -12161,7 +12345,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DistributedApplicationOptions.cs",
- "sourceLines": "29-37"
+ "sourceLines": "30-39"
},
{
"name": "AllowUnsecuredTransport",
@@ -12631,7 +12815,23 @@
},
{
"kind": "text",
- "text": ". Ordinary projects created with "
+ "text": ". Resources added with "
+ },
+ {
+ "kind": "code",
+ "text": "AddDotnetProject"
+ },
+ {
+ "kind": "text",
+ "text": " from the "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": " package or the legacy "
},
{
"kind": "code",
@@ -12693,7 +12893,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/DotnetProgramResourceBuilderExtensions.cs",
- "sourceLines": "118-129"
+ "sourceLines": "119-130"
},
{
"name": "WithEndpointsInEnvironment",
@@ -15263,7 +15463,15 @@
},
{
"kind": "text",
- "text": " method. "
+ "text": " method. Adding the .NET project requires the "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": " package. "
}
]
},
@@ -15296,7 +15504,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var cache = builder.AddRedis(\"cache\");\n var inventoryDatabase = builder.AddPostgres(\"postgres\").AddDatabase(\"inventory\");\n builder.AddProject(\"inventoryservice\")\n .WithReference(cache)\n .WithReference(inventory);\n builder.Build().Run();\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var cache = builder.AddRedis(\"cache\");\n var inventoryDatabase = builder.AddPostgres(\"postgres\").AddDatabase(\"inventory\");\n builder.AddDotnetProject(\"inventoryservice\", \"../InventoryService/InventoryService.csproj\")\n .WithReference(cache)\n .WithReference(inventoryDatabase);\n builder.Build().Run();\n ",
"language": "csharp"
}
]
@@ -15310,7 +15518,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/IDistributedApplicationBuilder.cs",
- "sourceLines": "62-62",
+ "sourceLines": "57-57",
"members": [
{
"name": "AddResource",
@@ -16000,17 +16208,6 @@
"returnType": "Aspire.Hosting.IFileSystemService",
"isVirtual": true,
"hasGet": true,
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREFILESYSTEM001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -16064,7 +16261,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IDistributedApplicationBuilder.cs",
- "sourceLines": "164-164"
+ "sourceLines": "157-157"
},
{
"name": "Pipeline",
@@ -16074,17 +16271,6 @@
"returnType": "Aspire.Hosting.Pipelines.IDistributedApplicationPipeline",
"isAbstract": true,
"hasGet": true,
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -16156,17 +16342,6 @@
"returnType": "Aspire.Hosting.IUserSecretsManager",
"isVirtual": true,
"hasGet": true,
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREUSERSECRETS001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -16195,7 +16370,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IDistributedApplicationBuilder.cs",
- "sourceLines": "176-176"
+ "sourceLines": "168-168"
}
]
},
@@ -16219,17 +16394,6 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREFILESYSTEM001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Ats/IFileSystemService.cs",
"members": [
{
@@ -17264,6 +17428,20 @@
"kind": "text",
"text": ", this service is not available to interact with the user and service methods will throw an exception. "
}
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " The service is not available until the AppHost has completed its before-start hooks, such as "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.BeforeStartEvent"
+ },
+ {
+ "kind": "text",
+ "text": " subscribers, because the dashboard and CLI that respond to interactions haven't started yet. "
+ }
]
}
}
@@ -17291,7 +17469,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "292-292",
+ "sourceLines": "297-297",
"members": [
{
"name": ".ctor",
@@ -17418,7 +17596,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "875-875",
+ "sourceLines": "885-885",
"members": [
{
"name": ".ctor",
@@ -17480,7 +17658,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "890-890",
+ "sourceLines": "900-900",
"members": [
{
"name": ".ctor",
@@ -17528,7 +17706,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "916-925"
+ "sourceLines": "926-935"
},
{
"name": "AddValidationError",
@@ -17580,7 +17758,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "935-936"
+ "sourceLines": "945-946"
},
{
"name": "CancellationToken",
@@ -17722,7 +17900,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "596-596",
+ "sourceLines": "606-606",
"members": [
{
"name": "OpenRead",
@@ -17786,7 +17964,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "633-634"
+ "sourceLines": "643-644"
},
{
"name": "ReadAllBytesAsync",
@@ -17843,7 +18021,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "647-648"
+ "sourceLines": "657-658"
},
{
"name": "FilePath",
@@ -17861,7 +18039,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "620-620"
+ "sourceLines": "630-630"
},
{
"name": "Id",
@@ -17879,7 +18057,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "610-610"
+ "sourceLines": "620-620"
},
{
"name": "Name",
@@ -17897,7 +18075,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "615-615"
+ "sourceLines": "625-625"
}
]
},
@@ -17938,7 +18116,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "540-540",
+ "sourceLines": "550-550",
"members": [
{
"name": "this[]",
@@ -17991,7 +18169,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "578-590"
+ "sourceLines": "588-600"
},
{
"name": "GetEnumerator",
@@ -18014,7 +18192,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "567-567"
+ "sourceLines": "577-577"
},
{
"name": "Count",
@@ -18032,7 +18210,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "554-554"
+ "sourceLines": "564-564"
}
]
},
@@ -18057,7 +18235,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "346-346",
+ "sourceLines": "351-351",
"members": [
{
"name": ".ctor",
@@ -18066,7 +18244,7 @@
"signature": "public InteractionInput.InteractionInput()",
"returnType": "void",
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "351-355"
+ "sourceLines": "356-360"
},
{
"name": "GetFiles",
@@ -18111,7 +18289,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "528-528"
+ "sourceLines": "538-538"
},
{
"name": "AllowCustomChoice",
@@ -18381,7 +18559,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "513-513"
+ "sourceLines": "523-523"
},
{
"name": "InputType",
@@ -18603,7 +18781,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "669-669",
+ "sourceLines": "679-679",
"members": [
{
"name": ".ctor",
@@ -18642,7 +18820,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "678-695"
+ "sourceLines": "688-705"
},
{
"name": "this[]",
@@ -18762,7 +18940,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "745-745"
+ "sourceLines": "755-755"
},
{
"name": "GetBoolean",
@@ -18843,7 +19021,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "767-767"
+ "sourceLines": "777-777"
},
{
"name": "GetDouble",
@@ -18941,7 +19119,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "797-797"
+ "sourceLines": "807-807"
},
{
"name": "GetEnumerator",
@@ -18964,7 +19142,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "819-819"
+ "sourceLines": "829-829"
},
{
"name": "GetInt32",
@@ -19080,7 +19258,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "784-784"
+ "sourceLines": "794-794"
},
{
"name": "GetString",
@@ -19126,7 +19304,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "755-755"
+ "sourceLines": "765-765"
},
{
"name": "ToArray",
@@ -19160,7 +19338,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "807-807"
+ "sourceLines": "817-817"
},
{
"name": "TryGetByName",
@@ -19209,7 +19387,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "735-735"
+ "sourceLines": "745-745"
},
{
"name": "Count",
@@ -19227,7 +19405,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "725-725"
+ "sourceLines": "735-735"
},
{
"name": "Names",
@@ -19245,7 +19423,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "813-813"
+ "sourceLines": "823-823"
}
]
},
@@ -19272,7 +19450,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "1092-1092",
+ "sourceLines": "1107-1107",
"members": [
{
"name": ".ctor",
@@ -19410,7 +19588,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "1126-1126",
+ "sourceLines": "1141-1141",
"members": [
{
"name": "Cancel",
@@ -19503,7 +19681,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "1151-1151"
+ "sourceLines": "1166-1166"
},
{
"name": "Ok",
@@ -19570,7 +19748,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "1136-1136"
+ "sourceLines": "1151-1151"
}
]
},
@@ -19595,7 +19773,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "1126-1126",
+ "sourceLines": "1141-1141",
"members": [
{
"name": "Canceled",
@@ -19696,6 +19874,43 @@
"sourceFile": "src/Aspire.Hosting/IProjectMetadata.cs",
"sourceLines": "44-44"
},
+ {
+ "name": "BuildTarget",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public virtual ProjectBuildTarget? IProjectMetadata.BuildTarget",
+ "returnType": "Aspire.Hosting.ProjectBuildTarget?",
+ "isReturnNullable": true,
+ "isVirtual": true,
+ "hasGet": true,
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREEXTENSION001"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the project output identity produced by an externally coordinated build. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Debugger clients use this value to verify that a running process matches the exact output produced by the coordinated build without re-evaluating the project with different build inputs. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/IProjectMetadata.cs",
+ "sourceLines": "64-64"
+ },
{
"name": "BuildWorkingDirectory",
"kind": "property",
@@ -19750,7 +19965,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IProjectMetadata.cs",
- "sourceLines": "59-59"
+ "sourceLines": "69-69"
},
{
"name": "LaunchSettings",
@@ -19871,17 +20086,6 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREFILESYSTEM001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Ats/ITempFileSystemService.cs",
"members": [
{
@@ -20063,19 +20267,10 @@
"ExposeMethods": "True",
"ExposeProperties": "True"
}
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREUSERSECRETS001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"sourceFile": "src/Aspire.Hosting/UserSecrets/IUserSecretsManager.cs",
- "sourceLines": "15-15",
+ "sourceLines": "13-13",
"members": [
{
"name": "GetOrSetSecret",
@@ -20239,7 +20434,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/UserSecrets/IUserSecretsManager.cs",
- "sourceLines": "50-50"
+ "sourceLines": "48-48"
},
{
"name": "TrySetSecret",
@@ -20625,7 +20820,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "318-318",
+ "sourceLines": "323-323",
"members": [
{
"name": ".ctor",
@@ -20877,7 +21072,7 @@
},
"examples": [
{
- "code": "\n var api = builder.AddProject(\"api\")\n .WithMcpServer();\n ",
+ "code": "\n var api = builder.AddDotnetProject(\"api\", \"../MyApi/MyApi.csproj\")\n .WithMcpServer();\n ",
"language": "csharp",
"description": [
{
@@ -20890,7 +21085,7 @@
},
{
"kind": "text",
- "text": " var api = builder.AddProject(\"api\") .WithMcpServer(\"/sse\", endpointName: \"https\"); "
+ "text": " var api = builder.AddDotnetProject(\"api\", \"../MyApi/MyApi.csproj\") .WithMcpServer(\"/sse\", endpointName: \"https\"); "
}
]
}
@@ -20917,7 +21112,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "942-942",
+ "sourceLines": "952-952",
"members": [
{
"name": ".ctor",
@@ -21156,7 +21351,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "955-955",
+ "sourceLines": "965-965",
"members": [
{
"name": ".ctor",
@@ -21240,7 +21435,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/OtlpConfigurationExtensions.cs",
- "sourceLines": "15-15",
+ "sourceLines": "16-16",
"members": [
{
"name": "AddOtlpEnvironment",
@@ -21292,7 +21487,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/OtlpConfigurationExtensions.cs",
- "sourceLines": "25-33"
+ "sourceLines": "31-39"
},
{
"name": "AddOtlpEnvironment",
@@ -21354,7 +21549,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/OtlpConfigurationExtensions.cs",
- "sourceLines": "44-52"
+ "sourceLines": "50-58"
},
{
"name": "WithOtlpExporter",
@@ -21464,7 +21659,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/OtlpConfigurationExtensions.cs",
- "sourceLines": "217-221"
+ "sourceLines": "232-236"
},
{
"name": "WithOtlpExporter",
@@ -21584,7 +21779,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/OtlpConfigurationExtensions.cs",
- "sourceLines": "254-258"
+ "sourceLines": "269-273"
},
{
"name": "WithOtlpExporterIfEndpointAvailable",
@@ -21672,7 +21867,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/OtlpConfigurationExtensions.cs",
- "sourceLines": "70-79"
+ "sourceLines": "76-85"
}
]
},
@@ -21726,7 +21921,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Orchestrator/ParameterProcessor.cs",
- "sourceLines": "19-19",
+ "sourceLines": "17-17",
"members": [
{
"name": ".ctor",
@@ -21773,7 +21968,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Orchestrator/ParameterProcessor.cs",
- "sourceLines": "19-33"
+ "sourceLines": "17-37"
},
{
"name": "DeleteParameterAsync",
@@ -21821,7 +22016,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Orchestrator/ParameterProcessor.cs",
- "sourceLines": "379-410"
+ "sourceLines": "490-521"
},
{
"name": "InitializeParametersAsync",
@@ -21976,7 +22171,85 @@
}
},
"sourceFile": "src/Aspire.Hosting/Orchestrator/ParameterProcessor.cs",
- "sourceLines": "334-369"
+ "sourceLines": "433-460"
+ },
+ {
+ "name": "SetValueAsync",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public Task ParameterProcessor.SetValueAsync(ParameterResource parameterResource, string value, bool saveToUserSecrets = false, CancellationToken cancellationToken = default(CancellationToken))",
+ "returnType": "System.Threading.Tasks.Task",
+ "parameters": [
+ {
+ "name": "parameterResource",
+ "type": "Aspire.Hosting.ApplicationModel.ParameterResource"
+ },
+ {
+ "name": "value",
+ "type": "string"
+ },
+ {
+ "name": "saveToUserSecrets",
+ "type": "bool",
+ "isOptional": true,
+ "defaultValue": "False"
+ },
+ {
+ "name": "cancellationToken",
+ "type": "System.Threading.CancellationToken",
+ "isOptional": true
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Sets the value for a parameter without prompting the user. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A task that completes when the value has been applied."
+ }
+ ],
+ "parameters": {
+ "cancellationToken": [
+ {
+ "kind": "text",
+ "text": "The cancellation token to observe while updating state."
+ }
+ ],
+ "parameterResource": [
+ {
+ "kind": "text",
+ "text": "The parameter resource to set the value for."
+ }
+ ],
+ "saveToUserSecrets": [
+ {
+ "kind": "text",
+ "text": " A value indicating whether to persist the value to user secrets. This only takes effect in run mode. In publish mode it is ignored because parameter values are written to deployment state automatically once initialization completes (see "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ParameterProcessor.SaveParametersToDeploymentStateAsync(System.Collections.Generic.IEnumerable{Aspire.Hosting.ApplicationModel.ParameterResource},System.Threading.CancellationToken)"
+ },
+ {
+ "kind": "text",
+ "text": "). "
+ }
+ ],
+ "value": [
+ {
+ "kind": "text",
+ "text": "The value to use for the parameter."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Aspire.Hosting/Orchestrator/ParameterProcessor.cs",
+ "sourceLines": "476-479"
}
]
},
@@ -21996,7 +22269,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
- "sourceLines": "17-17",
+ "sourceLines": "15-15",
"members": [
{
"name": "AddConnectionString",
@@ -22075,7 +22348,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
- "sourceLines": "324-333"
+ "sourceLines": "360-369"
},
{
"name": "AddParameter",
@@ -22150,7 +22423,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
- "sourceLines": "30-38"
+ "sourceLines": "28-36"
},
{
"name": "AddParameter",
@@ -22248,7 +22521,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
- "sourceLines": "77-81"
+ "sourceLines": "75-79"
},
{
"name": "AddParameter",
@@ -22355,7 +22628,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
- "sourceLines": "102-122"
+ "sourceLines": "100-120"
},
{
"name": "AddParameter",
@@ -22481,7 +22754,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
- "sourceLines": "168-182"
+ "sourceLines": "166-180"
},
{
"name": "AddParameterFromConfiguration",
@@ -22558,7 +22831,133 @@
}
},
"sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
- "sourceLines": "136-147"
+ "sourceLines": "134-145"
+ },
+ {
+ "name": "AsOptional",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder ParameterResourceBuilderExtensions.AsOptional(this IResourceBuilder builder)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportAttribute"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Marks the parameter resource as optional. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Optional parameters that do not have values are not prompted for during run or publish operations. When referenced as environment variables or other value providers, unset optional parameters resolve to "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": ". The manifest publisher does not currently support optional parameters and throws a "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.DistributedApplicationException"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The configured resource builder."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "Resource builder for the parameter."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
+ "sourceLines": "231-235"
+ },
+ {
+ "name": "AsRequired",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder ParameterResourceBuilderExtensions.AsRequired(this IResourceBuilder builder)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportAttribute"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Marks the parameter resource as required. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Parameters are required by default. Use this method to make a parameter required again after it was marked with "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ParameterResourceBuilderExtensions.AsOptional(Aspire.Hosting.ApplicationModel.IResourceBuilder{Aspire.Hosting.ApplicationModel.ParameterResource})"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The configured resource builder."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "Resource builder for the parameter."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
+ "sourceLines": "249-253"
},
{
"name": "ConfigureConnectionStringManifestPublisher",
@@ -22598,7 +22997,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
- "sourceLines": "384-391"
+ "sourceLines": "420-427"
},
{
"name": "CreateDefaultPasswordParameter",
@@ -22832,7 +23231,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
- "sourceLines": "416-432"
+ "sourceLines": "452-468"
},
{
"name": "CreateGeneratedParameter",
@@ -22954,7 +23353,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
- "sourceLines": "449-462"
+ "sourceLines": "485-498"
},
{
"name": "CreateParameter",
@@ -23050,7 +23449,188 @@
}
},
"sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
- "sourceLines": "477-482"
+ "sourceLines": "513-516"
+ },
+ {
+ "name": "CreateParameter",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static ParameterResource ParameterResourceBuilderExtensions.CreateParameter(IConfiguration configuration, string name, bool secret)",
+ "returnType": "Aspire.Hosting.ApplicationModel.ParameterResource",
+ "isStatic": true,
+ "parameters": [
+ {
+ "name": "configuration",
+ "type": "Microsoft.Extensions.Configuration.IConfiguration"
+ },
+ {
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "name": "secret",
+ "type": "bool"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Creates a parameter whose value is read from the supplied configuration. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A parameter resource that can be referenced without adding it to the application model."
+ }
+ ],
+ "parameters": {
+ "configuration": [
+ {
+ "kind": "text",
+ "text": "The configuration containing the parameter value."
+ }
+ ],
+ "name": [
+ {
+ "kind": "text",
+ "text": "The parameter resource name. Values are read from "
+ },
+ {
+ "kind": "code",
+ "text": "Parameters:{name}"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "secret": [
+ {
+ "kind": "text",
+ "text": "Whether the parameter contains a secret."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "An argument is "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ]
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
+ "sourceLines": "528-528"
+ },
+ {
+ "name": "CreateParameter",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static ParameterResource ParameterResourceBuilderExtensions.CreateParameter(IConfiguration configuration, string name, bool secret, string? defaultValue)",
+ "returnType": "Aspire.Hosting.ApplicationModel.ParameterResource",
+ "isStatic": true,
+ "parameters": [
+ {
+ "name": "configuration",
+ "type": "Microsoft.Extensions.Configuration.IConfiguration"
+ },
+ {
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "name": "secret",
+ "type": "bool"
+ },
+ {
+ "name": "defaultValue",
+ "type": "string?",
+ "isNullable": true
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Creates a configurable parameter with a literal default when no value is supplied. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A parameter resource using the standard parameter configuration lookup."
+ }
+ ],
+ "parameters": {
+ "configuration": [
+ {
+ "kind": "text",
+ "text": "The configuration containing the parameter value."
+ }
+ ],
+ "defaultValue": [
+ {
+ "kind": "text",
+ "text": "The published default, or "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": " to require an input."
+ }
+ ],
+ "name": [
+ {
+ "kind": "text",
+ "text": "The parameter resource name."
+ }
+ ],
+ "secret": [
+ {
+ "kind": "text",
+ "text": "Whether the parameter contains a secret."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "An argument is "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ]
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
+ "sourceLines": "541-547"
},
{
"name": "PublishAsConnectionString",
@@ -23132,7 +23712,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
- "sourceLines": "372-375"
+ "sourceLines": "408-411"
},
{
"name": "WithCustomInput",
@@ -23210,7 +23790,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
- "sourceLines": "244-249"
+ "sourceLines": "280-285"
},
{
"name": "WithDescription",
@@ -23285,7 +23865,796 @@
}
},
"sourceFile": "src/Aspire.Hosting/ParameterResourceBuilderExtensions.cs",
- "sourceLines": "211-217"
+ "sourceLines": "209-215"
+ }
+ ]
+ },
+ {
+ "name": "PipelineOutputDiffingExtensions",
+ "fullName": "Aspire.Hosting.PipelineOutputDiffingExtensions",
+ "namespace": "Aspire.Hosting",
+ "kind": "class",
+ "accessibility": "public",
+ "isStatic": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Extensions for detecting stale generated pipeline output. "
+ }
+ ]
+ },
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREPIPELINES005"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting/PipelineOutputDiffingExtensions.cs",
+ "sourceLines": "17-17",
+ "members": [
+ {
+ "name": "WithOutputDiffing",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IDistributedApplicationBuilder PipelineOutputDiffingExtensions.WithOutputDiffing(this IDistributedApplicationBuilder builder, string targetStep = \"publish\", string? diffStepName = null, string? description = null)",
+ "returnType": "Aspire.Hosting.IDistributedApplicationBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.IDistributedApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "targetStep",
+ "type": "string",
+ "isOptional": true,
+ "defaultValue": "publish"
+ },
+ {
+ "name": "diffStepName",
+ "type": "string?",
+ "isNullable": true,
+ "isOptional": true
+ },
+ {
+ "name": "description",
+ "type": "string?",
+ "isNullable": true,
+ "isOptional": true
+ }
+ ],
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREPIPELINES005"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ },
+ {
+ "name": "Aspire.Hosting.AspireExportAttribute"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Adds an opt-in target that checks for stale generated pipeline output. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.IDistributedApplicationBuilder"
+ },
+ {
+ "kind": "text",
+ "text": " for chaining."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.IDistributedApplicationBuilder"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "description": [
+ {
+ "kind": "text",
+ "text": "An optional description of the comparison target."
+ }
+ ],
+ "diffStepName": [
+ {
+ "kind": "text",
+ "text": "The comparison target name. When null, uses the target name followed by "
+ },
+ {
+ "kind": "code",
+ "text": "-and-diff"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "targetStep": [
+ {
+ "kind": "text",
+ "text": "The step whose completed output is compared. Defaults to "
+ },
+ {
+ "kind": "code",
+ "text": "publish"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "builder"
+ },
+ {
+ "kind": "text",
+ "text": " or "
+ },
+ {
+ "kind": "paramref",
+ "value": "targetStep"
+ },
+ {
+ "kind": "text",
+ "text": " is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "targetStep"
+ },
+ {
+ "kind": "text",
+ "text": " or "
+ },
+ {
+ "kind": "paramref",
+ "value": "diffStepName"
+ },
+ {
+ "kind": "text",
+ "text": " is empty."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.WithOutputDiffing();\n // Run: aspire do publish-and-diff\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/PipelineOutputDiffingExtensions.cs"
+ },
+ {
+ "name": "WithOutputDiffing",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IDistributedApplicationBuilder PipelineOutputDiffingExtensions.WithOutputDiffing(this IDistributedApplicationBuilder builder, Func createStep)",
+ "returnType": "Aspire.Hosting.IDistributedApplicationBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.IDistributedApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "createStep",
+ "type": "System.Func"
+ }
+ ],
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREPIPELINES005"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ },
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "Polyglot callbacks can't construct and return PipelineStep instances. Use the parameter-based overload instead."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Adds an opt-in target that checks for stale generated pipeline output. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " The check compares existing output with artifacts regenerated from the current source and fails if selected output differs. Capture runs only when the comparison target is selected, directly or through another target's dependencies. The baseline captures before every selected step so prerequisite and build writes are checked. The comparison step's dependencies and action finish before the second capture and comparison. Each capture resolves the global output directory; generators should write checked artifacts beneath it. This boundary does not enforce where writes occur. Step factories and configuration callbacks run before the baseline and must not write checked artifacts. Final actions appended to the comparison step after registration and AfterPublishEvent run too late for their writes to be checked. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.IDistributedApplicationBuilder"
+ },
+ {
+ "kind": "text",
+ "text": " for chaining."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.IDistributedApplicationBuilder"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "createStep": [
+ {
+ "kind": "text",
+ "text": "A factory that constructs the comparison step, including its dependencies and action."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "builder"
+ },
+ {
+ "kind": "text",
+ "text": " or "
+ },
+ {
+ "kind": "paramref",
+ "value": "createStep"
+ },
+ {
+ "kind": "text",
+ "text": " is null."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.WithOutputDiffing(() => new PipelineStep\n {\n Name = \"check-generated-files\",\n DependsOnSteps = [WellKnownPipelineSteps.Publish],\n Tags = [\"ci\"],\n Action = _ => Task.CompletedTask\n });\n // Run: aspire do check-generated-files\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/PipelineOutputDiffingExtensions.cs"
+ },
+ {
+ "name": "WithOutputDiffing",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IDistributedApplicationBuilder PipelineOutputDiffingExtensions.WithOutputDiffing(this IDistributedApplicationBuilder builder, string targetStep = \"publish\", string? diffStepName = null, string? description = null)",
+ "returnType": "Aspire.Hosting.IDistributedApplicationBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.IDistributedApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "targetStep",
+ "type": "string",
+ "isOptional": true,
+ "defaultValue": "publish"
+ },
+ {
+ "name": "diffStepName",
+ "type": "string?",
+ "isNullable": true,
+ "isOptional": true
+ },
+ {
+ "name": "description",
+ "type": "string?",
+ "isNullable": true,
+ "isOptional": true
+ }
+ ],
+ "genericParameters": [
+ {
+ "name": "TSnapshot",
+ "constraints": [
+ "notnull"
+ ]
+ },
+ {
+ "name": "TSnapshotter",
+ "constraints": [
+ "class",
+ "Aspire.Hosting.Pipelines.IPipelineOutputSnapshotter"
+ ]
+ },
+ {
+ "name": "TComparer",
+ "constraints": [
+ "class",
+ "Aspire.Hosting.Pipelines.IPipelineOutputComparer"
+ ]
+ }
+ ],
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREPIPELINES005"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ },
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "Custom output providers use .NET snapshot and service types."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Adds an opt-in target using a typed snapshotter and comparer. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.IDistributedApplicationBuilder"
+ },
+ {
+ "kind": "text",
+ "text": " for chaining."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.IDistributedApplicationBuilder"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "description": [
+ {
+ "kind": "text",
+ "text": "An optional description of the comparison target."
+ }
+ ],
+ "diffStepName": [
+ {
+ "kind": "text",
+ "text": "The comparison target name. When null, uses the target name followed by "
+ },
+ {
+ "kind": "code",
+ "text": "-and-diff"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "targetStep": [
+ {
+ "kind": "text",
+ "text": "The step whose completed output is compared. Defaults to "
+ },
+ {
+ "kind": "code",
+ "text": "publish"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ]
+ },
+ "typeParameters": {
+ "TComparer": [
+ {
+ "kind": "text",
+ "text": "The comparer implementation registered when none exists for "
+ },
+ {
+ "kind": "typeparamref",
+ "value": "TSnapshot"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "TSnapshot": [
+ {
+ "kind": "text",
+ "text": "The snapshot representation shared by capture and comparison."
+ }
+ ],
+ "TSnapshotter": [
+ {
+ "kind": "text",
+ "text": "The snapshotter implementation registered when none exists for "
+ },
+ {
+ "kind": "typeparamref",
+ "value": "TSnapshot"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "builder"
+ },
+ {
+ "kind": "text",
+ "text": " or "
+ },
+ {
+ "kind": "paramref",
+ "value": "targetStep"
+ },
+ {
+ "kind": "text",
+ "text": " is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "targetStep"
+ },
+ {
+ "kind": "text",
+ "text": " or "
+ },
+ {
+ "kind": "paramref",
+ "value": "diffStepName"
+ },
+ {
+ "kind": "text",
+ "text": " is empty."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.WithOutputDiffing();\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/PipelineOutputDiffingExtensions.cs"
+ },
+ {
+ "name": "WithOutputDiffing",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IDistributedApplicationBuilder PipelineOutputDiffingExtensions.WithOutputDiffing(this IDistributedApplicationBuilder builder, Func createStep)",
+ "returnType": "Aspire.Hosting.IDistributedApplicationBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.IDistributedApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "createStep",
+ "type": "System.Func"
+ }
+ ],
+ "genericParameters": [
+ {
+ "name": "TSnapshot",
+ "constraints": [
+ "notnull"
+ ]
+ },
+ {
+ "name": "TSnapshotter",
+ "constraints": [
+ "class",
+ "Aspire.Hosting.Pipelines.IPipelineOutputSnapshotter"
+ ]
+ },
+ {
+ "name": "TComparer",
+ "constraints": [
+ "class",
+ "Aspire.Hosting.Pipelines.IPipelineOutputComparer"
+ ]
+ }
+ ],
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREPIPELINES005"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ },
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "Custom output providers use .NET snapshot and service types."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Adds an opt-in target using a typed snapshotter and comparer. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " The snapshotter and comparer are registered as transient defaults for "
+ },
+ {
+ "kind": "typeparamref",
+ "value": "TSnapshot"
+ },
+ {
+ "kind": "text",
+ "text": ". Existing registrations for either closed generic interface are preserved. Each capture resolves its snapshotter. A comparer is resolved after the second capture. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.IDistributedApplicationBuilder"
+ },
+ {
+ "kind": "text",
+ "text": " for chaining."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.IDistributedApplicationBuilder"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "createStep": [
+ {
+ "kind": "text",
+ "text": "A factory that constructs the comparison step, including its dependencies and action."
+ }
+ ],
+ "description": [
+ {
+ "kind": "text",
+ "text": "An optional description of the comparison target."
+ }
+ ],
+ "diffStepName": [
+ {
+ "kind": "text",
+ "text": "The comparison target name. When null, uses the target name followed by "
+ },
+ {
+ "kind": "code",
+ "text": "-and-diff"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "targetStep": [
+ {
+ "kind": "text",
+ "text": "The step whose completed output is compared. Defaults to "
+ },
+ {
+ "kind": "code",
+ "text": "publish"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ]
+ },
+ "typeParameters": {
+ "TComparer": [
+ {
+ "kind": "text",
+ "text": "The comparer implementation registered when none exists for "
+ },
+ {
+ "kind": "typeparamref",
+ "value": "TSnapshot"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "TSnapshot": [
+ {
+ "kind": "text",
+ "text": "The snapshot representation shared by capture and comparison."
+ }
+ ],
+ "TSnapshotter": [
+ {
+ "kind": "text",
+ "text": "The snapshotter implementation registered when none exists for "
+ },
+ {
+ "kind": "typeparamref",
+ "value": "TSnapshot"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "builder"
+ },
+ {
+ "kind": "text",
+ "text": " or "
+ },
+ {
+ "kind": "paramref",
+ "value": "createStep"
+ },
+ {
+ "kind": "text",
+ "text": " is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "targetStep"
+ },
+ {
+ "kind": "text",
+ "text": " or "
+ },
+ {
+ "kind": "paramref",
+ "value": "diffStepName"
+ },
+ {
+ "kind": "text",
+ "text": " is empty."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.WithOutputDiffing();\n // Run: aspire do publish-and-diff\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/PipelineOutputDiffingExtensions.cs"
}
]
},
@@ -23316,7 +24685,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "1005-1005",
+ "sourceLines": "1020-1020",
"members": [
{
"name": ".ctor",
@@ -23381,7 +24750,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "979-979",
+ "sourceLines": "994-994",
"members": [
{
"name": ".ctor",
@@ -23460,6 +24829,174 @@
}
]
},
+ {
+ "name": "ProjectBuildTarget",
+ "fullName": "Aspire.Hosting.ProjectBuildTarget",
+ "namespace": "Aspire.Hosting",
+ "kind": "class",
+ "accessibility": "public",
+ "isSealed": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Identifies the project output produced by an externally coordinated build. "
+ }
+ ]
+ },
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREEXTENSION001"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting/ProjectBuildTarget.cs",
+ "sourceLines": "12-12",
+ "members": [
+ {
+ "name": ".ctor",
+ "kind": "constructor",
+ "accessibility": "public",
+ "signature": "public ProjectBuildTarget.ProjectBuildTarget(string targetPath, bool useAppHost)",
+ "returnType": "void",
+ "parameters": [
+ {
+ "name": "targetPath",
+ "type": "string"
+ },
+ {
+ "name": "useAppHost",
+ "type": "bool"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Initializes a new instance of the "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ProjectBuildTarget"
+ },
+ {
+ "kind": "text",
+ "text": " class. "
+ }
+ ],
+ "parameters": {
+ "targetPath": [
+ {
+ "kind": "text",
+ "text": "The fully-qualified MSBuild "
+ },
+ {
+ "kind": "code",
+ "text": "TargetPath"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "useAppHost": [
+ {
+ "kind": "text",
+ "text": " A value indicating whether the project output includes an apphost executable that launches "
+ },
+ {
+ "kind": "paramref",
+ "value": "targetPath"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "targetPath"
+ },
+ {
+ "kind": "text",
+ "text": " is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "targetPath"
+ },
+ {
+ "kind": "text",
+ "text": " is empty or consists only of white-space characters."
+ }
+ ]
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ProjectBuildTarget.cs",
+ "sourceLines": "24-29"
+ },
+ {
+ "name": "TargetPath",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public string ProjectBuildTarget.TargetPath",
+ "returnType": "string",
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the fully-qualified MSBuild "
+ },
+ {
+ "kind": "code",
+ "text": "TargetPath"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ProjectBuildTarget.cs",
+ "sourceLines": "34-34"
+ },
+ {
+ "name": "UseAppHost",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public bool ProjectBuildTarget.UseAppHost",
+ "returnType": "bool",
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets a value indicating whether the project output includes an apphost executable. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ProjectBuildTarget.cs",
+ "sourceLines": "39-39"
+ }
+ ]
+ },
{
"name": "ProjectResourceBuilderExtensions",
"fullName": "Aspire.Hosting.ProjectResourceBuilderExtensions",
@@ -23484,7 +25021,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs",
- "sourceLines": "25-25",
+ "sourceLines": "24-24",
"members": [
{
"name": "AddCSharpApp",
@@ -23511,13 +25048,10 @@
],
"attributes": [
{
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "name": "System.ObsoleteAttribute",
"constructorArguments": [
- "ASPIRECSHARPAPPS001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
+ "Use AddDotnetProject(name, path) from the Aspire.Hosting.Dotnet package instead."
+ ]
},
{
"name": "Aspire.Hosting.AspireExportIgnoreAttribute",
@@ -23534,6 +25068,31 @@
}
],
"remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " This method is obsolete. Use "
+ },
+ {
+ "kind": "code",
+ "text": "AddDotnetProject"
+ },
+ {
+ "kind": "text",
+ "text": " from the "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": " package instead. "
+ }
+ ]
+ },
{
"kind": "para",
"children": [
@@ -23605,7 +25164,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs",
- "sourceLines": "354-358"
+ "sourceLines": "387-391"
},
{
"name": "AddCSharpApp",
@@ -23636,13 +25195,10 @@
],
"attributes": [
{
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "name": "System.ObsoleteAttribute",
"constructorArguments": [
- "ASPIRECSHARPAPPS001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
+ "Use AddDotnetProject(name, path) from the Aspire.Hosting.Dotnet package instead."
+ ]
},
{
"name": "Aspire.Hosting.AspireExportIgnoreAttribute",
@@ -23659,6 +25215,31 @@
}
],
"remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " This method is obsolete. Use "
+ },
+ {
+ "kind": "code",
+ "text": "AddDotnetProject"
+ },
+ {
+ "kind": "text",
+ "text": " from the "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": " package instead. "
+ }
+ ]
+ },
{
"kind": "para",
"children": [
@@ -23736,7 +25317,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs",
- "sourceLines": "406-440"
+ "sourceLines": "442-476"
},
{
"name": "AddProject",
@@ -23772,6 +25353,12 @@
"arguments": {
"Reason": "Uses IProjectMetadata generic constraint which is a .NET-specific type."
}
+ },
+ {
+ "name": "System.ObsoleteAttribute",
+ "constructorArguments": [
+ "Use AddDotnetProject(name, path) from the Aspire.Hosting.Dotnet package instead. There is no generic AddDotnetProject; pass the project path instead of the TProject type."
+ ]
}
],
"docs": {
@@ -23782,6 +25369,40 @@
}
],
"remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " This method is obsolete. Use "
+ },
+ {
+ "kind": "code",
+ "text": "AddDotnetProject"
+ },
+ {
+ "kind": "text",
+ "text": " from the "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": " package instead. See the "
+ },
+ {
+ "kind": "href",
+ "text": "migration guide",
+ "value": "https://github.com/microsoft/aspire/blob/main/docs/migrate-from-addproject.md"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
{
"kind": "para",
"children": [
@@ -23892,7 +25513,7 @@
},
{
"kind": "text",
- "text": " Example of adding a project to the application model. "
+ "text": " Legacy example of adding a project to the application model. "
},
{
"kind": "codeblock",
@@ -23950,7 +25571,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs",
- "sourceLines": "70-73"
+ "sourceLines": "74-77"
},
{
"name": "AddProject",
@@ -23981,6 +25602,12 @@
"arguments": {
"Reason": "Polyglot AppHosts use the internal addProject dispatcher export."
}
+ },
+ {
+ "name": "System.ObsoleteAttribute",
+ "constructorArguments": [
+ "Use AddDotnetProject(name, path) from the Aspire.Hosting.Dotnet package instead."
+ ]
}
],
"docs": {
@@ -23991,6 +25618,40 @@
}
],
"remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " This method is obsolete. Use "
+ },
+ {
+ "kind": "code",
+ "text": "AddDotnetProject"
+ },
+ {
+ "kind": "text",
+ "text": " from the "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": " package instead. See the "
+ },
+ {
+ "kind": "href",
+ "text": "migration guide",
+ "value": "https://github.com/microsoft/aspire/blob/main/docs/migrate-from-addproject.md"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
{
"kind": "para",
"children": [
@@ -24010,7 +25671,7 @@
},
{
"kind": "text",
- "text": " Add a project to the app model via a project path. "
+ "text": " Legacy example of adding a project to the app model via a project path. "
},
{
"kind": "codeblock",
@@ -24062,7 +25723,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs",
- "sourceLines": "104-108"
+ "sourceLines": "113-117"
},
{
"name": "AddProject",
@@ -24103,6 +25764,12 @@
"arguments": {
"Reason": "Uses IProjectMetadata generic constraint which is a .NET-specific type."
}
+ },
+ {
+ "name": "System.ObsoleteAttribute",
+ "constructorArguments": [
+ "Use AddDotnetProject(name, path) from the Aspire.Hosting.Dotnet package instead. There is no generic AddDotnetProject; pass the project path instead of the TProject type."
+ ]
}
],
"docs": {
@@ -24113,6 +25780,40 @@
}
],
"remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " This method is obsolete. Use "
+ },
+ {
+ "kind": "code",
+ "text": "AddDotnetProject"
+ },
+ {
+ "kind": "text",
+ "text": " from the "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": " package instead. See the "
+ },
+ {
+ "kind": "href",
+ "text": "migration guide",
+ "value": "https://github.com/microsoft/aspire/blob/main/docs/migrate-from-addproject.md"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
{
"kind": "para",
"children": [
@@ -24206,7 +25907,7 @@
},
{
"kind": "text",
- "text": " Example of adding a project to the application model. "
+ "text": " Legacy example of adding a project to the application model. "
},
{
"kind": "codeblock",
@@ -24278,7 +25979,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs",
- "sourceLines": "176-183"
+ "sourceLines": "191-198"
},
{
"name": "AddProject",
@@ -24314,6 +26015,12 @@
"arguments": {
"Reason": "Polyglot AppHosts use the internal addProject dispatcher export."
}
+ },
+ {
+ "name": "System.ObsoleteAttribute",
+ "constructorArguments": [
+ "Use AddDotnetProject(name, path) from the Aspire.Hosting.Dotnet package instead."
+ ]
}
],
"docs": {
@@ -24324,6 +26031,40 @@
}
],
"remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " This method is obsolete. Use "
+ },
+ {
+ "kind": "code",
+ "text": "AddDotnetProject"
+ },
+ {
+ "kind": "text",
+ "text": " from the "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": " package instead. See the "
+ },
+ {
+ "kind": "href",
+ "text": "migration guide",
+ "value": "https://github.com/microsoft/aspire/blob/main/docs/migrate-from-addproject.md"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
{
"kind": "para",
"children": [
@@ -24343,7 +26084,7 @@
},
{
"kind": "text",
- "text": " Add a project to the app model via a project path. "
+ "text": " Legacy example of adding a project to the app model via a project path. "
},
{
"kind": "codeblock",
@@ -24409,7 +26150,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs",
- "sourceLines": "215-223"
+ "sourceLines": "235-243"
},
{
"name": "AddProject",
@@ -24449,6 +26190,12 @@
"arguments": {
"Reason": "Uses IProjectMetadata generic constraint which is a .NET-specific type."
}
+ },
+ {
+ "name": "System.ObsoleteAttribute",
+ "constructorArguments": [
+ "Use AddDotnetProject(name, path) from the Aspire.Hosting.Dotnet package instead. There is no generic AddDotnetProject; pass the project path instead of the TProject type."
+ ]
}
],
"docs": {
@@ -24459,6 +26206,40 @@
}
],
"remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " This method is obsolete. Use "
+ },
+ {
+ "kind": "code",
+ "text": "AddDotnetProject"
+ },
+ {
+ "kind": "text",
+ "text": " from the "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": " package instead. See the "
+ },
+ {
+ "kind": "href",
+ "text": "migration guide",
+ "value": "https://github.com/microsoft/aspire/blob/main/docs/migrate-from-addproject.md"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
{
"kind": "para",
"children": [
@@ -24552,7 +26333,7 @@
},
{
"kind": "text",
- "text": " Example of adding a project to the application model. "
+ "text": " Legacy example of adding a project to the application model. "
},
{
"kind": "codeblock",
@@ -24616,7 +26397,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs",
- "sourceLines": "266-278"
+ "sourceLines": "291-303"
},
{
"name": "AddProject",
@@ -24651,6 +26432,12 @@
"arguments": {
"Reason": "Polyglot AppHosts use the internal addProject dispatcher export."
}
+ },
+ {
+ "name": "System.ObsoleteAttribute",
+ "constructorArguments": [
+ "Use AddDotnetProject(name, path) from the Aspire.Hosting.Dotnet package instead."
+ ]
}
],
"docs": {
@@ -24661,6 +26448,40 @@
}
],
"remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " This method is obsolete. Use "
+ },
+ {
+ "kind": "code",
+ "text": "AddDotnetProject"
+ },
+ {
+ "kind": "text",
+ "text": " from the "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": " package instead. See the "
+ },
+ {
+ "kind": "href",
+ "text": "migration guide",
+ "value": "https://github.com/microsoft/aspire/blob/main/docs/migrate-from-addproject.md"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
{
"kind": "para",
"children": [
@@ -24680,7 +26501,7 @@
},
{
"kind": "text",
- "text": " Add a project to the app model via a project path. "
+ "text": " Legacy example of adding a project to the app model via a project path. "
},
{
"kind": "codeblock",
@@ -24738,7 +26559,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs",
- "sourceLines": "309-323"
+ "sourceLines": "339-353"
},
{
"name": "DisableForwardedHeaders",
@@ -24804,7 +26625,31 @@
},
{
"kind": "text",
- "text": " Disable forwarded headers for a project. "
+ "text": " Disable forwarded headers for a legacy "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.ProjectResource"
+ },
+ {
+ "kind": "text",
+ "text": ". For "
+ },
+ {
+ "kind": "code",
+ "text": "AddDotnetProject"
+ },
+ {
+ "kind": "text",
+ "text": " resources, use the overload from "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": ". "
},
{
"kind": "codeblock",
@@ -24836,7 +26681,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs",
- "sourceLines": "962-965"
+ "sourceLines": "1012-1015"
},
{
"name": "PublishAsDockerFile",
@@ -24954,7 +26799,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs",
- "sourceLines": "1008-1055"
+ "sourceLines": "1058-1105"
},
{
"name": "WithEndpointsInEnvironment",
@@ -25020,7 +26865,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs",
- "sourceLines": "980-985"
+ "sourceLines": "1030-1035"
},
{
"name": "WithProjectDefaults",
@@ -25192,12 +27037,12 @@
"text": "; use "
},
{
- "kind": "cref",
- "value": "M:Aspire.Hosting.ProjectResourceBuilderExtensions.AddProject``1(Aspire.Hosting.IDistributedApplicationBuilder,System.String)"
+ "kind": "code",
+ "text": "AddDotnetProject"
},
{
"kind": "text",
- "text": " for ordinary projects. "
+ "text": " from that package for ordinary projects. "
}
]
},
@@ -25260,7 +27105,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs",
- "sourceLines": "497-890"
+ "sourceLines": "533-938"
},
{
"name": "WithReplicas",
@@ -25322,7 +27167,31 @@
},
{
"kind": "text",
- "text": " Start multiple instances of the same service. "
+ "text": " Start multiple instances of a legacy "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.ProjectResource"
+ },
+ {
+ "kind": "text",
+ "text": ". For "
+ },
+ {
+ "kind": "code",
+ "text": "AddDotnetProject"
+ },
+ {
+ "kind": "text",
+ "text": " resources, use the overload from "
+ },
+ {
+ "kind": "code",
+ "text": "Aspire.Hosting.Dotnet"
+ },
+ {
+ "kind": "text",
+ "text": ". "
},
{
"kind": "codeblock",
@@ -25360,7 +27229,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs",
- "sourceLines": "925-928"
+ "sourceLines": "974-977"
}
]
},
@@ -25477,7 +27346,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/RequiredCommandResourceExtensions.cs",
- "sourceLines": "12-12",
+ "sourceLines": "11-11",
"members": [
{
"name": "WithRequiredCommand",
@@ -25566,7 +27435,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/RequiredCommandResourceExtensions.cs",
- "sourceLines": "34-44"
+ "sourceLines": "33-41"
},
{
"name": "WithRequiredCommand",
@@ -25606,15 +27475,6 @@
}
],
"attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRECOMMAND001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- },
{
"name": "Aspire.Hosting.AspireExportAttribute",
"constructorArguments": [
@@ -25720,7 +27580,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/RequiredCommandResourceExtensions.cs",
- "sourceLines": "71-81"
+ "sourceLines": "67-77"
}
]
},
@@ -25740,7 +27600,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "33-33",
+ "sourceLines": "34-34",
"members": [
{
"name": "AsHttp2Service",
@@ -25809,7 +27669,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "1985-1987"
+ "sourceLines": "2233-2235"
},
{
"name": "ClearContainerFilesSources",
@@ -25870,7 +27730,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2373-2380"
+ "sourceLines": "2700-2707"
},
{
"name": "ExcludeFromManifest",
@@ -25939,7 +27799,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2393-2395"
+ "sourceLines": "2720-2722"
},
{
"name": "ExcludeFromMcp",
@@ -26008,7 +27868,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "5224-5226"
+ "sourceLines": "5655-5657"
},
{
"name": "GetConnectionProperty",
@@ -26069,7 +27929,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "1233-1242"
+ "sourceLines": "1481-1490"
},
{
"name": "GetEndpoint",
@@ -26199,7 +28059,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "1953-1955"
+ "sourceLines": "2201-2203"
},
{
"name": "GetEndpoint",
@@ -26310,7 +28170,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "1970-1972"
+ "sourceLines": "2218-2220"
},
{
"name": "PublishWithContainerFiles",
@@ -26399,7 +28259,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2325-2338"
+ "sourceLines": "2652-2665"
},
{
"name": "SubscribeHttpsEndpointsUpdate",
@@ -26556,7 +28416,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4384-4421"
+ "sourceLines": "4748-4785"
},
{
"name": "WaitFor",
@@ -26658,7 +28518,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var messaging = builder.AddRabbitMQ(\"messaging\");\n builder.AddProject(\"myapp\")\n .WithReference(messaging)\n .WaitFor(messaging);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var messaging = builder.AddRabbitMQ(\"messaging\");\n builder.AddDotnetProject(\"myapp\", \"../MyApp/MyApp.csproj\")\n .WithReference(messaging)\n .WaitFor(messaging);\n ",
"language": "csharp"
}
],
@@ -26700,7 +28560,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2428-2431"
+ "sourceLines": "2755-2758"
},
{
"name": "WaitFor",
@@ -26864,7 +28724,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var messaging = builder.AddRabbitMQ(\"messaging\");\n builder.AddProject(\"myapp\")\n .WithReference(messaging)\n .WaitFor(messaging, WaitBehavior.StopOnResourceUnavailable);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var messaging = builder.AddRabbitMQ(\"messaging\");\n builder.AddDotnetProject(\"myapp\", \"../MyApp/MyApp.csproj\")\n .WithReference(messaging)\n .WaitFor(messaging, WaitBehavior.StopOnResourceUnavailable);\n ",
"language": "csharp"
}
],
@@ -26912,7 +28772,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2488-2491"
+ "sourceLines": "2815-2818"
},
{
"name": "WaitForCompletion",
@@ -26990,7 +28850,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var pgsql = builder.AddPostgres(\"postgres\");\n var dbprep = builder.AddProject(\"dbprep\")\n .WithReference(pgsql);\n builder.AddProject(\"dbpreptool\")\n .WithReference(pgsql)\n .WaitForCompletion(dbprep);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var pgsql = builder.AddPostgres(\"postgres\");\n var dbprep = builder.AddDotnetProject(\"dbprep\", \"../DbPrepApp/DbPrepApp.csproj\")\n .WithReference(pgsql);\n builder.AddDotnetProject(\"dbpreptool\", \"../DatabasePrepTool/DatabasePrepTool.csproj\")\n .WithReference(pgsql)\n .WaitForCompletion(dbprep);\n ",
"language": "csharp"
}
],
@@ -27038,7 +28898,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2719-2734"
+ "sourceLines": "3046-3061"
},
{
"name": "WaitForStart",
@@ -27115,7 +28975,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var messaging = builder.AddRabbitMQ(\"messaging\");\n builder.AddProject(\"myapp\")\n .WithReference(messaging)\n .WaitForStart(messaging);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var messaging = builder.AddRabbitMQ(\"messaging\");\n builder.AddDotnetProject(\"myapp\", \"../MyApp/MyApp.csproj\")\n .WithReference(messaging)\n .WaitForStart(messaging);\n ",
"language": "csharp"
}
],
@@ -27157,7 +29017,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2553-2556"
+ "sourceLines": "2880-2883"
},
{
"name": "WaitForStart",
@@ -27296,7 +29156,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var messaging = builder.AddRabbitMQ(\"messaging\");\n builder.AddProject(\"myapp\")\n .WithReference(messaging)\n .WaitForStart(messaging, WaitBehavior.StopOnResourceUnavailable);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var messaging = builder.AddRabbitMQ(\"messaging\");\n builder.AddDotnetProject(\"myapp\", \"../MyApp/MyApp.csproj\")\n .WithReference(messaging)\n .WaitForStart(messaging, WaitBehavior.StopOnResourceUnavailable);\n ",
"language": "csharp"
}
],
@@ -27344,7 +29204,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2611-2614"
+ "sourceLines": "2938-2941"
},
{
"name": "WithArgs",
@@ -27816,7 +29676,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4053-4073"
+ "sourceLines": "4380-4400"
},
{
"name": "WithCertificateTrustConfiguration",
@@ -27919,7 +29779,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4209-4212"
+ "sourceLines": "4536-4539"
},
{
"name": "WithCertificateTrustScope",
@@ -28046,7 +29906,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4162-4175"
+ "sourceLines": "4489-4502"
},
{
"name": "WithChildRelationship",
@@ -28125,7 +29985,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var parameter = builder.AddParameter(\"parameter\");\n \n var backend = builder.AddProject(\"backend\");\n .WithChildRelationship(parameter);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var parameter = builder.AddParameter(\"parameter\");\n \n var backend = builder.AddDotnetProject(\"backend\", \"../Backend/Backend.csproj\")\n .WithChildRelationship(parameter);\n ",
"language": "csharp"
}
],
@@ -28242,7 +30102,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var parameter = builder.AddParameter(\"parameter\");\n \n var backend = builder.AddProject(\"backend\");\n .WithChildRelationship(parameter.Resource);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var parameter = builder.AddParameter(\"parameter\");\n \n var backend = builder.AddDotnetProject(\"backend\", \"../Backend/Backend.csproj\")\n .WithChildRelationship(parameter.Resource);\n ",
"language": "csharp"
},
{
@@ -28447,7 +30307,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2981-2997"
+ "sourceLines": "3308-3324"
},
{
"name": "WithCommand",
@@ -28695,7 +30555,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "3051-3063"
+ "sourceLines": "3378-3390"
},
{
"name": "WithComputeEnvironment",
@@ -28772,7 +30632,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4818-4822"
+ "sourceLines": "5215-5219"
},
{
"name": "WithConnectionProperty",
@@ -29032,7 +30892,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "797-801"
+ "sourceLines": "1045-1049"
},
{
"name": "WithContainerFilesSource",
@@ -29103,7 +30963,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2354-2360"
+ "sourceLines": "2681-2687"
},
{
"name": "WithDebugSupport",
@@ -29613,7 +31473,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions()\n {\n Args = args,\n TrustDeveloperCertificate = false,\n });\n var project = builder.AddProject(\"my-service\")\n .WithDeveloperCertificateTrust(true);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions()\n {\n Args = args,\n TrustDeveloperCertificate = false,\n });\n var project = builder.AddDotnetProject(\"my-service\", \"../MyService/MyService.csproj\")\n .WithDeveloperCertificateTrust(true);\n ",
"language": "csharp"
}
],
@@ -29655,7 +31515,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4111-4124"
+ "sourceLines": "4438-4451"
},
{
"name": "WithEndpoint",
@@ -29804,7 +31664,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "1525-1553"
+ "sourceLines": "1773-1801"
},
{
"name": "WithEndpoint",
@@ -30718,7 +32578,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "1754-1754"
+ "sourceLines": "2002-2002"
},
{
"name": "WithEnvironment",
@@ -31122,7 +32982,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "352-356"
+ "sourceLines": "365-369"
},
{
"name": "WithEnvironment",
@@ -31384,7 +33244,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "404-413"
+ "sourceLines": "417-426"
},
{
"name": "WithEnvironment",
@@ -31490,7 +33350,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "429-456"
+ "sourceLines": "442-469"
},
{
"name": "WithEnvironment",
@@ -31590,7 +33450,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "470-479"
+ "sourceLines": "483-492"
},
{
"name": "WithEnvironment",
@@ -31682,7 +33542,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "497-506"
+ "sourceLines": "510-519"
},
{
"name": "WithEnvironment",
@@ -31990,7 +33850,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var pgsql = builder.AddPostgres(\"postgres\");\n builder.AddProject(\"dbcleanuptool\")\n .WithReference(pgsql)\n .WithExplicitStart();\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var pgsql = builder.AddPostgres(\"postgres\");\n builder.AddDotnetProject(\"dbcleanuptool\", \"../CleanUpDatabase/CleanUpDatabase.csproj\")\n .WithReference(pgsql)\n .WithExplicitStart();\n ",
"language": "csharp"
}
],
@@ -32026,7 +33886,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2685-2685"
+ "sourceLines": "3012-3012"
},
{
"name": "WithExternalHttpEndpoints",
@@ -32095,7 +33955,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "1922-1937"
+ "sourceLines": "2170-2185"
},
{
"name": "WithHealthCheck",
@@ -32184,7 +34044,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var startAfter = DateTime.Now.AddSeconds(30);\n \n builder.Services.AddHealthChecks().AddCheck(mycheck\", () =>\n {\n return DateTime.Now > startAfter ? HealthCheckResult.Healthy() : HealthCheckResult.Unhealthy();\n });\n \n var pg = builder.AddPostgres(\"pg\")\n .WithHealthCheck(\"mycheck\");\n \n builder.AddProject(\"myapp\")\n .WithReference(pg)\n .WaitFor(pg); // This will result in waiting for the building check, and the\n // custom check defined in the code.\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var startAfter = DateTime.Now.AddSeconds(30);\n \n builder.Services.AddHealthChecks().AddCheck(mycheck\", () =>\n {\n return DateTime.Now > startAfter ? HealthCheckResult.Healthy() : HealthCheckResult.Unhealthy();\n });\n \n var pg = builder.AddPostgres(\"pg\")\n .WithHealthCheck(\"mycheck\");\n \n builder.AddDotnetProject(\"myapp\", \"../MyApp/MyApp.csproj\")\n .WithReference(pg)\n .WaitFor(pg); // This will result in waiting for the building check, and the\n // custom check defined in the code.\n ",
"language": "csharp"
}
],
@@ -32226,7 +34086,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2779-2789"
+ "sourceLines": "3106-3116"
},
{
"name": "WithHidden",
@@ -32317,7 +34177,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "5244-5246"
+ "sourceLines": "5675-5677"
},
{
"name": "WithHiddenOnCompletion",
@@ -32421,7 +34281,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "5264-5266"
+ "sourceLines": "5695-5697"
},
{
"name": "WithHiddenOnCompletion",
@@ -32534,7 +34394,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "5309-5312"
+ "sourceLines": "5740-5743"
},
{
"name": "WithHttpCommand",
@@ -32839,7 +34699,7 @@
},
{
"kind": "codeblock",
- "text": "\n var apiService = builder.AddProject>MyApiService>(\"api\")\n .WithHttpCommand(\"/clear-cache\", \"Clear cache\");\n ",
+ "text": "\n var apiService = builder.AddDotnetProject(\"api\", \"../MyApiService/MyApiService.csproj\")\n .WithHttpCommand(\"/clear-cache\", \"Clear cache\");\n ",
"language": "csharp"
},
{
@@ -32872,7 +34732,7 @@
},
{
"kind": "codeblock",
- "text": "\n var adminKey = builder.AddParameter(\"admin-key\");\n var apiService = builder.AddProject>MyApiService>(\"api\")\n .WithHttpsEndpoint(\"admin\")\n .WithEnvironment(\"ADMIN_KEY\", adminKey)\n .WithHttpCommand(\"/reset-db\", \"Reset database\",\n endpointName: \"admin\",\n commandOptions: new ()\n {\n Method = HttpMethod.Get,\n ConfirmationMessage = \"Are you sure you want to reset the database?\",\n PrepareRequest: request =>\n {\n request.Headers.Add(\"X-Admin-Key\", adminKey);\n return Task.CompletedTask;\n }\n });\n ",
+ "text": "\n var adminKey = builder.AddParameter(\"admin-key\");\n var apiService = builder.AddDotnetProject(\"api\", \"../MyApiService/MyApiService.csproj\")\n .WithHttpsEndpoint(name: \"admin\")\n .WithEnvironment(\"ADMIN_KEY\", adminKey)\n .WithHttpCommand(\"/reset-db\", \"Reset database\",\n endpointName: \"admin\",\n commandOptions: new ()\n {\n Method = HttpMethod.Get,\n ConfirmationMessage = \"Are you sure you want to reset the database?\",\n PrepareRequest: request =>\n {\n request.Headers.Add(\"X-Admin-Key\", adminKey);\n return Task.CompletedTask;\n }\n });\n ",
"language": "csharp"
},
{
@@ -32947,7 +34807,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "3665-3672"
+ "sourceLines": "3992-3999"
},
{
"name": "WithHttpCommand",
@@ -33235,7 +35095,7 @@
},
{
"kind": "codeblock",
- "text": "\n var loadGenerator = builder.AddProject>LoadGenerator>(\"load\");\n var loadGeneratorEndpoint = loadGenerator.GetEndpoint(\"https\");\n var customerService = builder.AddProject>CustomerService>(\"customer-service\")\n .WithHttpCommand(\"/stress?resource=customer-service&requests=1000\", \"Apply load (1000)\", endpointSelector: () => loadGeneratorEndpoint)\n .WithHttpCommand(\"/stress?resource=customer-service&requests=5000\", \"Apply load (5000)\", endpointSelector: () => loadGeneratorEndpoint);\n loadGenerator.WithReference(customerService);\n ",
+ "text": "\n var loadGenerator = builder.AddDotnetProject(\"load\", \"../LoadGenerator/LoadGenerator.csproj\");\n var loadGeneratorEndpoint = loadGenerator.GetEndpoint(\"https\");\n var customerService = builder.AddDotnetProject(\"customer-service\", \"../CustomerService/CustomerService.csproj\")\n .WithHttpCommand(\"/stress?resource=customer-service&requests=1000\", \"Apply load (1000)\", endpointSelector: () => loadGeneratorEndpoint)\n .WithHttpCommand(\"/stress?resource=customer-service&requests=5000\", \"Apply load (5000)\", endpointSelector: () => loadGeneratorEndpoint);\n loadGenerator.WithReference(customerService);\n ",
"language": "csharp"
},
{
@@ -33315,7 +35175,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "3743-3837"
+ "sourceLines": "4070-4164"
},
{
"name": "WithHttpEndpoint",
@@ -33703,7 +35563,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var backend = builder.AddProject(\"backend\")\n .WithHttpHealthCheck(\"/health\");\n builder.AddProject(\"frontend\")\n .WithReference(backend).WaitFor(backend);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var backend = builder.AddDotnetProject(\"backend\", \"../Backend/Backend.csproj\")\n .WithHttpHealthCheck(\"/health\");\n builder.AddDotnetProject(\"frontend\", \"../Frontend/Frontend.csproj\")\n .WithReference(backend).WaitFor(backend);\n ",
"language": "csharp"
}
],
@@ -33765,7 +35625,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2826-2832"
+ "sourceLines": "3153-3159"
},
{
"name": "WithHttpHealthCheck",
@@ -33838,7 +35698,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var backend = builder.AddProject(\"backend\");\n backend.WithHttpHealthCheck(() => backend.GetEndpoint(\"https\"), path: \"/health\")\n builder.AddProject(\"frontend\")\n .WithReference(backend).WaitFor(backend);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var backend = builder.AddDotnetProject(\"backend\", \"../Backend/Backend.csproj\");\n backend.WithHttpHealthCheck(() => backend.GetEndpoint(\"https\"), path: \"/health\");\n builder.AddDotnetProject(\"frontend\", \"../Frontend/Frontend.csproj\")\n .WithReference(backend).WaitFor(backend);\n ",
"language": "csharp"
},
{
@@ -33903,7 +35763,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2868-2912"
+ "sourceLines": "3195-3239"
},
{
"name": "WithHttpProbe",
@@ -33976,15 +35836,6 @@
}
],
"attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPROBES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- },
{
"name": "Aspire.Hosting.AspireExportIgnoreAttribute",
"arguments": {
@@ -34015,7 +35866,7 @@
},
{
"kind": "codeblock",
- "text": "\n var service = builder.AddProject(\"service\")\n .WithHttpProbe(ProbeType.Liveness, \"/health\");\n ",
+ "text": "\n var service = builder.AddDotnetProject(\"service\", \"../MyService/MyService.csproj\")\n .WithHttpProbe(ProbeType.Liveness, \"/health\");\n ",
"language": "csharp"
},
{
@@ -34024,7 +35875,7 @@
},
{
"kind": "codeblock",
- "text": "\n var service = builder.AddProject(\"service\")\n .WithHttpProbe(ProbeType.Liveness, \"/health\")\n .WithHttpHealthCheck(\"/health\");\n ",
+ "text": "\n var service = builder.AddDotnetProject(\"service\", \"../MyService/MyService.csproj\")\n .WithHttpProbe(ProbeType.Liveness, \"/health\")\n .WithHttpHealthCheck(\"/health\");\n ",
"language": "csharp"
},
{
@@ -34117,7 +35968,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "5115-5121"
+ "sourceLines": "5549-5555"
},
{
"name": "WithHttpProbe",
@@ -34189,15 +36040,6 @@
}
],
"attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPROBES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- },
{
"name": "Aspire.Hosting.AspireExportIgnoreAttribute",
"arguments": {
@@ -34228,7 +36070,7 @@
},
{
"kind": "codeblock",
- "text": "\n var service = builder.AddProject(\"service\")\n .WithHttpProbe(ProbeType.Liveness, \"/health\");\n ",
+ "text": "\n var service = builder.AddDotnetProject(\"service\", \"../MyService/MyService.csproj\")\n .WithHttpProbe(ProbeType.Liveness, \"/health\");\n ",
"language": "csharp"
},
{
@@ -34237,7 +36079,7 @@
},
{
"kind": "codeblock",
- "text": "\n var service = builder.AddProject(\"service\")\n .WithHttpProbe(ProbeType.Liveness, \"/health\")\n .WithHttpHealthCheck(\"/health\");\n ",
+ "text": "\n var service = builder.AddDotnetProject(\"service\", \"../MyService/MyService.csproj\")\n .WithHttpProbe(ProbeType.Liveness, \"/health\")\n .WithHttpHealthCheck(\"/health\");\n ",
"language": "csharp"
},
{
@@ -34330,7 +36172,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "5175-5192"
+ "sourceLines": "5607-5624"
},
{
"name": "WithHttpsCertificate",
@@ -34478,7 +36320,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4275-4283"
+ "sourceLines": "4639-4647"
},
{
"name": "WithHttpsCertificateConfiguration",
@@ -34570,7 +36412,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4344-4349"
+ "sourceLines": "4708-4713"
},
{
"name": "WithHttpsDeveloperCertificate",
@@ -34678,7 +36520,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4239-4247"
+ "sourceLines": "4603-4611"
},
{
"name": "WithHttpsEndpoint",
@@ -35069,7 +36911,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var backend = builder.AddProject(\"backend\")\n .WithHttpsHealthCheck(\"/health\");\n builder.AddProject(\"frontend\")\n .WithReference(backend).WaitFor(backend);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var backend = builder.AddDotnetProject(\"backend\", \"../Backend/Backend.csproj\")\n .WithHttpsHealthCheck(\"/health\");\n builder.AddDotnetProject(\"frontend\", \"../Frontend/Frontend.csproj\")\n .WithReference(backend).WaitFor(backend);\n ",
"language": "csharp"
}
],
@@ -35131,7 +36973,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "2947-2949"
+ "sourceLines": "3274-3276"
},
{
"name": "WithIconName",
@@ -35203,7 +37045,7 @@
},
{
"kind": "codeblock",
- "text": "\n var service = builder.AddProject(\"service\")\n .WithIconName(\"CloudArrowUp\", IconVariant.Regular);\n ",
+ "text": "\n var service = builder.AddDotnetProject(\"service\", \"../MyService/MyService.csproj\")\n .WithIconName(\"CloudArrowUp\", IconVariant.Regular);\n ",
"language": "csharp"
}
],
@@ -35251,7 +37093,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4798-4801"
+ "sourceLines": "5195-5198"
},
{
"name": "WithImagePushOptions",
@@ -36147,7 +37989,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "122-136"
+ "sourceLines": "135-149"
},
{
"name": "WithManifestPublishingCallback",
@@ -36427,7 +38269,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4307-4315"
+ "sourceLines": "4671-4679"
},
{
"name": "WithParentProcessLifetime",
@@ -36488,7 +38330,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n builder.AddProject(\"api\")\n .WithParentProcessLifetime(parentProcessId: 1234);\n \n builder.Build().Run();\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n builder.AddDotnetProject(\"api\", \"../ApiService/ApiService.csproj\")\n .WithParentProcessLifetime(parentProcessId: 1234);\n \n builder.Build().Run();\n ",
"language": "csharp"
}
],
@@ -36575,7 +38417,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "170-188"
+ "sourceLines": "183-201"
},
{
"name": "WithParentRelationship",
@@ -36654,7 +38496,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var backend = builder.AddProject(\"backend\");\n \n var frontend = builder.AddProject(\"frontend\")\n .WithParentRelationship(backend);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var backend = builder.AddDotnetProject(\"backend\", \"../Backend/Backend.csproj\");\n \n var frontend = builder.AddDotnetProject(\"frontend\", \"../Manager/Manager.csproj\")\n .WithParentRelationship(backend);\n ",
"language": "csharp"
}
],
@@ -36771,7 +38613,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var backend = builder.AddProject(\"backend\");\n \n var frontend = builder.AddProject(\"frontend\")\n .WithParentRelationship(backend.Resource);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var backend = builder.AddDotnetProject(\"backend\", \"../Backend/Backend.csproj\");\n \n var frontend = builder.AddDotnetProject(\"frontend\", \"../Manager/Manager.csproj\")\n .WithParentRelationship(backend.Resource);\n ",
"language": "csharp"
},
{
@@ -36874,7 +38716,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n builder.AddProject(\"api\")\n .WithPersistentLifetime();\n \n builder.Build().Run();\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n builder.AddDotnetProject(\"api\", \"../ApiService/ApiService.csproj\")\n .WithPersistentLifetime();\n \n builder.Build().Run();\n ",
"language": "csharp"
}
],
@@ -36921,7 +38763,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "97-99"
+ "sourceLines": "110-112"
},
{
"name": "WithProcessCommand",
@@ -37090,7 +38932,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "3126-3136"
+ "sourceLines": "3453-3463"
},
{
"name": "WithProcessCommand",
@@ -37735,7 +39577,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "1116-1171"
+ "sourceLines": "1364-1419"
},
{
"name": "WithReference",
@@ -37892,7 +39734,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "1268-1272"
+ "sourceLines": "1516-1520"
},
{
"name": "WithReference",
@@ -38059,7 +39901,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "1300-1304"
+ "sourceLines": "1548-1552"
},
{
"name": "WithReference",
@@ -38151,7 +39993,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "1321-1354"
+ "sourceLines": "1569-1602"
},
{
"name": "WithReference",
@@ -38233,7 +40075,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "1369-1429"
+ "sourceLines": "1617-1677"
},
{
"name": "WithReference",
@@ -38323,7 +40165,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "1445-1449"
+ "sourceLines": "1693-1697"
},
{
"name": "WithReferenceEnvironment",
@@ -38411,7 +40253,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "883-885"
+ "sourceLines": "1131-1133"
},
{
"name": "WithReferenceRelationship",
@@ -38499,7 +40341,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4545-4548"
+ "sourceLines": "4914-4917"
},
{
"name": "WithReferenceRelationship",
@@ -38587,7 +40429,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4564-4569"
+ "sourceLines": "4933-4938"
},
{
"name": "WithReferenceRelationship",
@@ -38675,7 +40517,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4625-4628"
+ "sourceLines": "4994-4997"
},
{
"name": "WithRelationship",
@@ -38763,7 +40605,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var backend = builder.AddProject(\"backend\");\n var manager = builder.AddProject(\"manager\")\n .WithRelationship(backend.Resource, \"Manager\");\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n var backend = builder.AddDotnetProject(\"backend\", \"../Backend/Backend.csproj\");\n var manager = builder.AddDotnetProject(\"manager\", \"../Manager/Manager.csproj\")\n .WithRelationship(backend.Resource, \"Manager\");\n ",
"language": "csharp"
},
{
@@ -38812,7 +40654,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4505-4509"
+ "sourceLines": "4869-4878"
},
{
"name": "WithRelationship",
@@ -38899,7 +40741,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "4526-4529"
+ "sourceLines": "4895-4898"
},
{
"name": "WithRemoteImageName",
@@ -39056,7 +40898,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "5430-5436"
+ "sourceLines": "5861-5867"
},
{
"name": "WithRemoteImageTag",
@@ -39213,7 +41055,110 @@
]
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "5470-5476"
+ "sourceLines": "5901-5907"
+ },
+ {
+ "name": "WithResourceTypeDisplayName",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder ResourceBuilderExtensions.WithResourceTypeDisplayName(this IResourceBuilder builder, string resourceTypeDisplayName)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "resourceTypeDisplayName",
+ "type": "string"
+ }
+ ],
+ "genericParameters": [
+ {
+ "name": "T",
+ "constraints": [
+ "Aspire.Hosting.ApplicationModel.IResource"
+ ]
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportAttribute"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Overrides the human-readable resource type label. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " When not specified, the resource class supplies the default label, falling back to the resource type. This setting affects the dashboard and CLI output, not resource identity, service discovery, or OpenTelemetry identity. Repeated calls replace the previous override. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ],
+ "resourceTypeDisplayName": [
+ {
+ "kind": "text",
+ "text": "The type label, such as Redis or PostgreSQL Server."
+ }
+ ]
+ },
+ "typeParameters": {
+ "T": [
+ {
+ "kind": "text",
+ "text": "The resource type."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "The builder is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "The resource type display name is empty or whitespace."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.AddProject(\"orders\").WithResourceTypeDisplayName(\"Orders API\");\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
+ "sourceLines": "5156-5159"
},
{
"name": "WithSessionLifetime",
@@ -39266,7 +41211,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n builder.AddProject(\"api\")\n .WithSessionLifetime();\n \n builder.Build().Run();\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n builder.AddDotnetProject(\"api\", \"../ApiService/ApiService.csproj\")\n .WithSessionLifetime();\n \n builder.Build().Run();\n ",
"language": "csharp"
}
],
@@ -39313,7 +41258,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
- "sourceLines": "65-67"
+ "sourceLines": "78-80"
},
{
"name": "WithUrl",
@@ -39433,7 +41378,7 @@
},
"examples": [
{
- "code": "\n var frontend = builder.AddProject(\"frontend\")\n .WithUrl(\"https://example.com/\", \"Home\");\n ",
+ "code": "\n var frontend = builder.AddDotnetProject(\"frontend\", \"../Frontend/Frontend.csproj\")\n .WithUrl(\"https://example.com/\", \"Home\");\n ",
"language": "csharp",
"description": [
{
@@ -39443,7 +41388,7 @@
]
},
{
- "code": "\n var frontend = builder.AddProject(\"frontend\")\n .WithUrl(\"/home\", \"Home\");\n ",
+ "code": "\n var frontend = builder.AddDotnetProject(\"frontend\", \"../Frontend/Frontend.csproj\")\n .WithUrl(\"/home\", \"Home\");\n ",
"language": "csharp",
"description": [
{
@@ -39750,7 +41695,15 @@
"children": [
{
"kind": "text",
- "text": " The callback will be executed after endpoints have been allocated and the URL has been generated."
+ "text": " The callback will be executed after endpoints have been allocated and the URL has been generated, but before "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent"
+ },
+ {
+ "kind": "text",
+ "text": " handlers run."
},
{
"kind": "text",
@@ -39758,6 +41711,31 @@
}
]
},
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " The preferred finalized origin is available through "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.ApplicationModel.EndpointReference.PrimaryBrowserOrigin"
+ },
+ {
+ "kind": "text",
+ "text": ", and all origins through "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.ApplicationModel.EndpointReference.BrowserOrigins"
+ },
+ {
+ "kind": "text",
+ "text": ". Localhost and container network references are unchanged. "
+ }
+ ]
+ },
{
"kind": "para",
"children": [
@@ -39790,7 +41768,7 @@
},
{
"kind": "codeblock",
- "text": "\n var frontend = builder.AddProject(\"frontend\")\n .WithUrlForEndpoint(\"https\", url => url.DisplayText = \"Home\");\n ",
+ "text": "\n var frontend = builder.AddDotnetProject(\"frontend\", \"../Frontend/Frontend.csproj\")\n .WithUrlForEndpoint(\"https\", url => url.DisplayText = \"Home\");\n ",
"language": "csharp"
},
{
@@ -39799,7 +41777,7 @@
},
{
"kind": "codeblock",
- "text": "\n var frontend = builder.AddProject(\"frontend\")\n .WithUrlForEndpoint(\"https\", url => url.Url = \"/home\");\n ",
+ "text": "\n var frontend = builder.AddDotnetProject(\"frontend\", \"../Frontend/Frontend.csproj\")\n .WithUrlForEndpoint(\"https\", url => url.Url = \"/home\");\n ",
"language": "csharp"
}
],
@@ -39940,7 +41918,7 @@
},
{
"kind": "codeblock",
- "text": "\n var frontend = builder.AddProject(\"frontend\")\n .WithUrlForEndpoint(\"https\", ep => new() { Url = \"/admin\", DisplayText = \"Admin\" });\n ",
+ "text": "\n var frontend = builder.AddDotnetProject(\"frontend\", \"../Frontend/Frontend.csproj\")\n .WithUrlForEndpoint(\"https\", ep => new() { Url = \"/admin\", DisplayText = \"Admin\" });\n ",
"language": "csharp"
}
],
@@ -39989,6 +41967,96 @@
},
"sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs"
},
+ {
+ "name": "WithUrlForEndpoint",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder ResourceBuilderExtensions.WithUrlForEndpoint(this IResourceBuilder builder, EndpointReference endpoint, Action callback)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "endpoint",
+ "type": "Aspire.Hosting.ApplicationModel.EndpointReference"
+ },
+ {
+ "name": "callback",
+ "type": "System.Action"
+ }
+ ],
+ "genericParameters": [
+ {
+ "name": "T",
+ "constraints": [
+ "Aspire.Hosting.ApplicationModel.IResource"
+ ]
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "Polyglot AppHosts use the endpoint name overload for withUrlForEndpoint."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Configures the URL for an endpoint, including an endpoint on another resource. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " The callback runs after endpoints have been allocated. An existing URL for the endpoint is updated. When the endpoint belongs to another resource, a URL is added with its endpoint set before the callback runs. A relative URL is combined with the referenced endpoint's URL. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The builder for the resource that will display the URL."
+ }
+ ],
+ "callback": [
+ {
+ "kind": "text",
+ "text": "The callback that configures the URL."
+ }
+ ],
+ "endpoint": [
+ {
+ "kind": "text",
+ "text": "The endpoint to link to."
+ }
+ ]
+ },
+ "typeParameters": {
+ "T": [
+ {
+ "kind": "text",
+ "text": "The resource type."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Aspire.Hosting/ResourceBuilderExtensions.cs",
+ "sourceLines": "2604-2636"
+ },
{
"name": "WithUrls",
"kind": "method",
@@ -40034,7 +42102,15 @@
"children": [
{
"kind": "text",
- "text": " The callback will be executed after endpoints have been allocated for this resource."
+ "text": " The callback will be executed after endpoints have been allocated for this resource and before "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent"
+ },
+ {
+ "kind": "text",
+ "text": " handlers run."
},
{
"kind": "text",
@@ -40046,13 +42122,38 @@
}
]
},
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " Final origins associated with the resource's own endpoints are exposed through "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.ApplicationModel.EndpointReference.BrowserOrigins"
+ },
+ {
+ "kind": "text",
+ "text": ". Preferred browser values follow display ordering; origin collections deduplicate scheme, host, and port. Browser references are finalized after these callbacks. Resolving unfinished browser references from a URL callback throws "
+ },
+ {
+ "kind": "cref",
+ "value": "T:System.InvalidOperationException"
+ },
+ {
+ "kind": "text",
+ "text": " rather than waiting; already-finalized browser references remain available. "
+ }
+ ]
+ },
{
"kind": "text",
"text": " Update all displayed URLs to have display text: "
},
{
"kind": "codeblock",
- "text": "\n var frontend = builder.AddProject(\"frontend\")\n .WithUrls(c =>\n {\n foreach (var url in c.Urls)\n {\n if (string.IsNullOrEmpty(url.DisplayText))\n {\n url.DisplayText = \"frontend\";\n }\n }\n });\n ",
+ "text": "\n var frontend = builder.AddDotnetProject(\"frontend\", \"../Frontend/Frontend.csproj\")\n .WithUrls(c =>\n {\n foreach (var url in c.Urls)\n {\n if (string.IsNullOrEmpty(url.DisplayText))\n {\n url.DisplayText = \"frontend\";\n }\n }\n });\n ",
"language": "csharp"
},
{
@@ -40061,7 +42162,7 @@
},
{
"kind": "codeblock",
- "text": "\n var frontend = builder.AddProject(\"frontend\")\n .WithUrls(c =>\n {\n foreach (var url in c.Urls)\n {\n if (url.Endpoint is not null)\n {\n var uri = new UriBuilder(url.Url) { Host = $\"{c.Resource.Name}.localhost\" };\n url.Url = uri.ToString();\n }\n }\n });\n ",
+ "text": "\n var frontend = builder.AddDotnetProject(\"frontend\", \"../Frontend/Frontend.csproj\")\n .WithUrls(c =>\n {\n foreach (var url in c.Urls)\n {\n if (url.Endpoint is not null)\n {\n var uri = new UriBuilder(url.Url) { Host = $\"{c.Resource.Name}.localhost\" };\n url.Url = uri.ToString();\n }\n }\n });\n ",
"language": "csharp"
}
],
@@ -40152,7 +42253,15 @@
"children": [
{
"kind": "text",
- "text": " The callback will be executed after endpoints have been allocated for this resource."
+ "text": " The callback will be executed after endpoints have been allocated for this resource and before "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent"
+ },
+ {
+ "kind": "text",
+ "text": " handlers run."
},
{
"kind": "text",
@@ -40163,6 +42272,31 @@
"text": " Note that any endpoints on the resource will automatically get a corresponding URL added for them. "
}
]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " Final origins associated with the resource's own endpoints are exposed through "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.ApplicationModel.EndpointReference.BrowserOrigins"
+ },
+ {
+ "kind": "text",
+ "text": ". Preferred browser values follow display ordering; origin collections deduplicate scheme, host, and port. Browser references are finalized after these callbacks. Resolving unfinished browser references from a URL callback throws "
+ },
+ {
+ "kind": "cref",
+ "value": "T:System.InvalidOperationException"
+ },
+ {
+ "kind": "text",
+ "text": " rather than waiting; already-finalized browser references remain available. "
+ }
+ ]
}
],
"returns": [
@@ -40206,6 +42340,288 @@
}
]
},
+ {
+ "name": "ResourceTraitBuilderExtensions",
+ "fullName": "Aspire.Hosting.ResourceTraitBuilderExtensions",
+ "namespace": "Aspire.Hosting",
+ "kind": "class",
+ "accessibility": "public",
+ "isStatic": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Provides methods for adding resource metadata and dashboard defaults."
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ResourceTraitBuilderExtensions.cs",
+ "sourceLines": "11-11",
+ "members": [
+ {
+ "name": "WithDisplayOrder",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder ResourceTraitBuilderExtensions.WithDisplayOrder(this IResourceBuilder builder, int order)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "order",
+ "type": "int"
+ }
+ ],
+ "genericParameters": [
+ {
+ "name": "T",
+ "constraints": [
+ "Aspire.Hosting.ApplicationModel.IResource"
+ ]
+ }
+ ],
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIRERESOURCETRAITS001"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ },
+ {
+ "name": "Aspire.Hosting.AspireExportAttribute"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Sets the default display order of the resource in lists of resources, such as the dashboard's. A saved ordering takes precedence. Repeated calls replace the order. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ],
+ "order": [
+ {
+ "kind": "text",
+ "text": " A relative sort key. Higher values appear first, consistent with "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.ApplicationModel.ResourceUrlAnnotation.DisplayOrder"
+ },
+ {
+ "kind": "text",
+ "text": ". Resources without a display order are treated as having an order of 0, so a negative value moves a resource after them. "
+ }
+ ]
+ },
+ "typeParameters": {
+ "T": [
+ {
+ "kind": "text",
+ "text": "The resource type."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Aspire.Hosting/ResourceTraitBuilderExtensions.cs",
+ "sourceLines": "82-82"
+ },
+ {
+ "name": "WithTags",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder ResourceTraitBuilderExtensions.WithTags(this IResourceBuilder builder, params ReadOnlySpan tags)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "tags",
+ "type": "System.ReadOnlySpan",
+ "modifier": "params"
+ }
+ ],
+ "genericParameters": [
+ {
+ "name": "T",
+ "constraints": [
+ "Aspire.Hosting.ApplicationModel.IResource"
+ ]
+ }
+ ],
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIRERESOURCETRAITS001"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ },
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "ReadOnlySpan is not supported by ATS; use the withTags array adapter for polyglot SDKs."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Adds AppHost-defined dashboard tags that users cannot remove. Repeated calls add tags."
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ],
+ "tags": [
+ {
+ "kind": "text",
+ "text": "The tags, each up to 50 characters with single spaces between words."
+ }
+ ]
+ },
+ "typeParameters": {
+ "T": [
+ {
+ "kind": "text",
+ "text": "The resource type."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Aspire.Hosting/ResourceTraitBuilderExtensions.cs",
+ "sourceLines": "45-52"
+ },
+ {
+ "name": "WithTrait",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder ResourceTraitBuilderExtensions.WithTrait(this IResourceBuilder builder, string name, string value)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "name": "value",
+ "type": "string"
+ }
+ ],
+ "genericParameters": [
+ {
+ "name": "T",
+ "constraints": [
+ "Aspire.Hosting.ApplicationModel.IResource"
+ ]
+ }
+ ],
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIRERESOURCETRAITS001"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ },
+ {
+ "name": "Aspire.Hosting.AspireExportAttribute"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Adds immutable, non-sensitive metadata to a resource. Repeated names add multiple values."
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ],
+ "name": [
+ {
+ "kind": "text",
+ "text": "The case-sensitive trait name."
+ }
+ ],
+ "value": [
+ {
+ "kind": "text",
+ "text": "The trait value. Do not include secrets."
+ }
+ ]
+ },
+ "typeParameters": {
+ "T": [
+ {
+ "kind": "text",
+ "text": "The resource type."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Aspire.Hosting/ResourceTraitBuilderExtensions.cs",
+ "sourceLines": "23-33"
+ }
+ ]
+ },
{
"name": "RunConfiguration",
"fullName": "Aspire.Hosting.RunConfiguration",
@@ -40325,17 +42741,6 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREFILESYSTEM001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Ats/TempDirectory.cs",
"members": [
{
@@ -40391,17 +42796,6 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREFILESYSTEM001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Ats/TempFile.cs",
"members": [
{
@@ -40466,7 +42860,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "1046-1046",
+ "sourceLines": "1061-1061",
"members": [
{
"name": ".ctor",
@@ -40543,7 +42937,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/IInteractionService.cs",
- "sourceLines": "1022-1022",
+ "sourceLines": "1037-1037",
"members": [
{
"name": ".ctor",
@@ -40630,7 +43024,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs",
- "sourceLines": "22-22",
+ "sourceLines": "21-21",
"members": [
{
"name": "WithTerminal",
@@ -40663,18 +43057,9 @@
],
"attributes": [
{
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRETERMINAL001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- },
- {
- "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "name": "Aspire.Hosting.AspireExportAttribute",
"arguments": {
- "Reason": "Polyglot AppHosts use the parameterless withTerminal dispatcher export."
+ "RunSyncOnBackgroundThread": "True"
}
}
],
@@ -40707,7 +43092,39 @@
},
{
"kind": "text",
- "text": " CLI command. "
+ "text": " CLI command. When neither "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.ApplicationModel.TerminalOptions.Columns"
+ },
+ {
+ "kind": "text",
+ "text": " nor "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.ApplicationModel.TerminalOptions.Rows"
+ },
+ {
+ "kind": "text",
+ "text": " is configured, opening the dashboard terminal automatically fits the grid to the view. Explicit dimensions retain the producer's current grid until the viewer requests a resize. Terminal host resources can be revealed using the dashboard's Show hidden resources control to inspect their state and diagnostic telemetry. Terminal host telemetry is disabled when "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.DistributedApplicationOptions.DisableDashboard"
+ },
+ {
+ "kind": "text",
+ "text": " is "
+ },
+ {
+ "kind": "langword",
+ "value": "true"
+ },
+ {
+ "kind": "text",
+ "text": ". "
}
]
},
@@ -40845,7 +43262,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/TerminalResourceBuilderExtensions.cs",
- "sourceLines": "71-110"
+ "sourceLines": "77-116"
}
]
},
@@ -41115,7 +43532,7 @@
},
"examples": [
{
- "code": "\n builder.AddProject(\"api\")\n .WithVolume(\"data\", \"/usr/data\", env: \"DATA_PATH\");\n ",
+ "code": "\n builder.AddDotnetProject(\"api\", \"../Api/Api.csproj\")\n .WithVolume(\"data\", \"/usr/data\", env: \"DATA_PATH\");\n ",
"language": "csharp"
}
]
@@ -48850,21 +51267,24 @@
"kind": "text",
"text": " Describes the logical and physical names used for a connection-string reference. "
}
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " The names can be independently initialized in a record copy; they are not recomputed when another property changes. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ApplicationModel.ConnectionStringEnvironmentVariableNames.Create(Aspire.Hosting.ApplicationModel.IResourceWithConnectionString,System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to derive names from a resource. "
+ }
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRECONNECTIONSTRINGS001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ConnectionStringEnvironmentVariableNames.cs",
- "sourceLines": "12-12",
+ "sourceLines": "13-13",
"members": [
{
"name": "$",
@@ -48919,7 +51339,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ConnectionStringEnvironmentVariableNames.cs",
- "sourceLines": "67-79"
+ "sourceLines": "68-80"
},
{
"name": "Deconstruct",
@@ -48984,7 +51404,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ConnectionStringEnvironmentVariableNames.cs",
- "sourceLines": "53-57"
+ "sourceLines": "54-58"
},
{
"name": "Equals",
@@ -49134,7 +51554,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ConnectionStringEnvironmentVariableNames.cs",
- "sourceLines": "88-94"
+ "sourceLines": "89-95"
},
{
"name": "op_Equality",
@@ -49392,7 +51812,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ConnectionStringReference.cs",
- "sourceLines": "11-11",
+ "sourceLines": "9-9",
"members": [
{
"name": ".ctor",
@@ -49419,7 +51839,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ConnectionStringReference.cs",
- "sourceLines": "11-56"
+ "sourceLines": "9-51"
},
{
"name": "ConnectionStringExpression",
@@ -49443,7 +51863,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ConnectionStringReference.cs",
- "sourceLines": "53-53"
+ "sourceLines": "48-48"
},
{
"name": "EnvironmentVariableNames",
@@ -49453,17 +51873,6 @@
"returnType": "Aspire.Hosting.ApplicationModel.ConnectionStringEnvironmentVariableNames?",
"isReturnNullable": true,
"hasGet": true,
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRECONNECTIONSTRINGS001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -49481,7 +51890,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ConnectionStringReference.cs",
- "sourceLines": "44-44"
+ "sourceLines": "39-39"
},
{
"name": "Optional",
@@ -49499,7 +51908,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ConnectionStringReference.cs",
- "sourceLines": "37-37"
+ "sourceLines": "33-33"
},
{
"name": "Resource",
@@ -49517,7 +51926,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ConnectionStringReference.cs",
- "sourceLines": "32-32"
+ "sourceLines": "28-28"
}
]
},
@@ -53068,7 +55477,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ContainerResource.cs",
- "sourceLines": "17-17",
+ "sourceLines": "15-15",
"members": [
{
"name": ".ctor",
@@ -53111,7 +55520,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ContainerResource.cs",
- "sourceLines": "18-25"
+ "sourceLines": "16-23"
},
{
"name": "Entrypoint",
@@ -53559,7 +55968,7 @@
"signature": "public CustomResourceSnapshot.CustomResourceSnapshot()",
"returnType": "void",
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "19-125"
+ "sourceLines": "19-149"
},
{
"name": "$",
@@ -54011,6 +56420,53 @@
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs"
},
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public string CustomResourceSnapshot.ResourceTypeDisplayName",
+ "returnType": "string",
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the human-readable resource type label, falling back to "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.ApplicationModel.CustomResourceSnapshot.ResourceType"
+ },
+ {
+ "kind": "text",
+ "text": " when not set. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " This label is presentation metadata and must not be used to identify resource capabilities. To change it, override "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.ApplicationModel.Resource.ResourceTypeDisplayName"
+ },
+ {
+ "kind": "text",
+ "text": " or call "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs"
+ },
{
"name": "StartTimeStamp",
"kind": "property",
@@ -54467,7 +56923,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DebugSupportExtensions.cs",
- "sourceLines": "131-139"
+ "sourceLines": "134-142"
},
{
"name": "HasLaunchToolArgsOwnedBy",
@@ -54551,7 +57007,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DebugSupportExtensions.cs",
- "sourceLines": "90-95"
+ "sourceLines": "93-98"
},
{
"name": "SupportsDebugging",
@@ -54632,7 +57088,7 @@
},
{
"kind": "text",
- "text": ", a debug session is active, the resource is not forced to process execution, it does not have a persistent lifetime, and the IDE advertised support for the annotation's launch configuration type. "
+ "text": ", a debug session is active, the resource is not forced to process execution, it does not have a persistent lifetime, and the IDE advertised support for the annotation's launch configuration type. A producer that requires explicit Debug mode uses plain process execution for non-debug launches. "
}
]
},
@@ -54702,7 +57158,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DebugSupportExtensions.cs",
- "sourceLines": "46-73"
+ "sourceLines": "47-76"
}
]
},
@@ -54902,6 +57358,113 @@
}
]
},
+ {
+ "name": "DisplayOrderAnnotation",
+ "fullName": "Aspire.Hosting.ApplicationModel.DisplayOrderAnnotation",
+ "namespace": "Aspire.Hosting.ApplicationModel",
+ "kind": "class",
+ "accessibility": "public",
+ "isSealed": true,
+ "interfaces": [
+ "Aspire.Hosting.ApplicationModel.IResourceAnnotation"
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " The default display order of a resource in lists of resources. Higher values appear first, consistent with "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.ApplicationModel.ResourceUrlAnnotation.DisplayOrder"
+ },
+ {
+ "kind": "text",
+ "text": ". Resources without a display order are treated as having an order of 0. "
+ }
+ ],
+ "parameters": {
+ "order": [
+ {
+ "kind": "text",
+ "text": "The display order."
+ }
+ ]
+ }
+ },
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIRERESOURCETRAITS001"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/DisplayOrderAnnotation.cs",
+ "sourceLines": "14-14",
+ "members": [
+ {
+ "name": ".ctor",
+ "kind": "constructor",
+ "accessibility": "public",
+ "signature": "public DisplayOrderAnnotation.DisplayOrderAnnotation(int order)",
+ "returnType": "void",
+ "parameters": [
+ {
+ "name": "order",
+ "type": "int"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " The default display order of a resource in lists of resources. Higher values appear first, consistent with "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.ApplicationModel.ResourceUrlAnnotation.DisplayOrder"
+ },
+ {
+ "kind": "text",
+ "text": ". Resources without a display order are treated as having an order of 0. "
+ }
+ ],
+ "parameters": {
+ "order": [
+ {
+ "kind": "text",
+ "text": "The display order."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/DisplayOrderAnnotation.cs",
+ "sourceLines": "14-17"
+ },
+ {
+ "name": "Order",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public int DisplayOrderAnnotation.Order",
+ "returnType": "int",
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Gets the display order. Higher values appear first."
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/DisplayOrderAnnotation.cs",
+ "sourceLines": "17-17"
+ }
+ ]
+ },
{
"name": "DistributedApplicationModel",
"fullName": "Aspire.Hosting.ApplicationModel.DistributedApplicationModel",
@@ -55435,19 +57998,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DockerfileBaseImageAnnotation.cs",
- "sourceLines": "17-17",
+ "sourceLines": "14-14",
"members": [
{
"name": ".ctor",
@@ -55975,19 +58527,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DockerfileBuilderCallbackAnnotation.cs",
- "sourceLines": "12-12",
+ "sourceLines": "9-9",
"members": [
{
"name": ".ctor",
@@ -56012,7 +58553,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DockerfileBuilderCallbackAnnotation.cs",
- "sourceLines": "14-21"
+ "sourceLines": "11-18"
},
{
"name": ".ctor",
@@ -56051,7 +58592,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DockerfileBuilderCallbackAnnotation.cs",
- "sourceLines": "14-31"
+ "sourceLines": "11-28"
},
{
"name": "AddCallback",
@@ -56065,17 +58606,6 @@
"type": "System.Func"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -56093,7 +58623,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DockerfileBuilderCallbackAnnotation.cs",
- "sourceLines": "45-47"
+ "sourceLines": "41-43"
},
{
"name": "Callbacks",
@@ -56111,7 +58641,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DockerfileBuilderCallbackAnnotation.cs",
- "sourceLines": "36-36"
+ "sourceLines": "33-33"
}
]
},
@@ -56135,19 +58665,10 @@
"arguments": {
"ExposeProperties": "True"
}
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DockerfileBuilderCallbackContext.cs",
- "sourceLines": "14-14",
+ "sourceLines": "12-12",
"members": [
{
"name": ".ctor",
@@ -56216,7 +58737,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DockerfileBuilderCallbackContext.cs",
- "sourceLines": "23-29"
+ "sourceLines": "21-27"
},
{
"name": "Builder",
@@ -56234,7 +58755,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DockerfileBuilderCallbackContext.cs",
- "sourceLines": "39-39"
+ "sourceLines": "37-37"
},
{
"name": "CancellationToken",
@@ -56252,7 +58773,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DockerfileBuilderCallbackContext.cs",
- "sourceLines": "49-49"
+ "sourceLines": "47-47"
},
{
"name": "Resource",
@@ -56270,7 +58791,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DockerfileBuilderCallbackContext.cs",
- "sourceLines": "34-34"
+ "sourceLines": "32-32"
},
{
"name": "Services",
@@ -56288,7 +58809,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/DockerfileBuilderCallbackContext.cs",
- "sourceLines": "44-44"
+ "sourceLines": "42-42"
}
]
},
@@ -57414,7 +59935,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs",
- "sourceLines": "390-390"
+ "sourceLines": "393-393"
},
{
"name": "AllocatedEndpoint",
@@ -57483,7 +60004,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs",
- "sourceLines": "385-385"
+ "sourceLines": "388-388"
},
{
"name": "DefaultNetworkID",
@@ -57501,7 +60022,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs",
- "sourceLines": "341-341"
+ "sourceLines": "344-344"
},
{
"name": "ExcludeReferenceEndpoint",
@@ -58480,19 +61001,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPROBES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ProbeAnnotation.cs",
- "sourceLines": "71-71",
+ "sourceLines": "66-66",
"members": [
{
"name": ".ctor",
@@ -58595,6 +61105,16 @@
"name": "TlsEnabled",
"value": 7,
"description": "Whether TLS is enabled on the endpoint. Returns TrueString or FalseString."
+ },
+ {
+ "name": "BrowserOrigins",
+ "value": 8,
+ "description": "Comma-separated browser-facing origins for this endpoint."
+ },
+ {
+ "name": "PrimaryBrowserOrigin",
+ "value": 9,
+ "description": "The primary browser-facing origin for this endpoint."
}
],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointProperty.cs",
@@ -58631,7 +61151,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "14-14",
+ "sourceLines": "15-15",
"members": [
{
"name": ".ctor",
@@ -58721,7 +61241,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "262-271"
+ "sourceLines": "297-306"
},
{
"name": ".ctor",
@@ -58770,7 +61290,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "278-280"
+ "sourceLines": "313-315"
},
{
"name": ".ctor",
@@ -58837,7 +61357,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "294-302"
+ "sourceLines": "329-337"
},
{
"name": ".ctor",
@@ -58886,7 +61406,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "309-311"
+ "sourceLines": "344-346"
},
{
"name": "GetTlsValue",
@@ -59016,7 +61536,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "183-187"
+ "sourceLines": "218-222"
},
{
"name": "GetValueAsync",
@@ -59059,7 +61579,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "116-116"
+ "sourceLines": "149-149"
},
{
"name": "GetValueAsync",
@@ -59112,7 +61632,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "125-125"
+ "sourceLines": "158-158"
},
{
"name": "Property",
@@ -59178,7 +61698,37 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "162-162"
+ "sourceLines": "197-197"
+ },
+ {
+ "name": "BrowserOrigins",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public EndpointReferenceExpression EndpointReference.BrowserOrigins",
+ "returnType": "Aspire.Hosting.ApplicationModel.EndpointReferenceExpression",
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets a deferred comma-separated list of browser-facing origins associated with this endpoint. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Origins use finalized URL customization and are independent of this reference's service-discovery network context. Origins are distinct and ordered by display preference. The allocated HTTP(S) endpoint origin is included after display origins, even if its display links are removed. An endpoint without HTTP(S) origins resolves to an empty string. "
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n backend.WithEnvironment(\"ALLOWED_ORIGINS\", frontend.GetEndpoint(\"https\").BrowserOrigins);\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
+ "sourceLines": "71-71"
},
{
"name": "ContextNetworkID",
@@ -59197,7 +61747,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "132-132"
+ "sourceLines": "165-165"
},
{
"name": "EndpointAnnotation",
@@ -59215,7 +61765,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "24-24"
+ "sourceLines": "25-25"
},
{
"name": "EndpointName",
@@ -59233,7 +61783,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "54-54"
+ "sourceLines": "55-55"
},
{
"name": "ErrorMessage",
@@ -59293,7 +61843,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "106-106"
+ "sourceLines": "139-139"
},
{
"name": "Exists",
@@ -59311,7 +61861,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "69-69"
+ "sourceLines": "102-102"
},
{
"name": "Host",
@@ -59329,7 +61879,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "203-203"
+ "sourceLines": "238-238"
},
{
"name": "IsAllocated",
@@ -59347,7 +61897,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "64-64"
+ "sourceLines": "97-97"
},
{
"name": "IsHttp",
@@ -59365,7 +61915,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "74-74"
+ "sourceLines": "107-107"
},
{
"name": "IsHttps",
@@ -59383,7 +61933,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "79-79"
+ "sourceLines": "112-112"
},
{
"name": "IsHttpSchemeNamedEndpoint",
@@ -59401,7 +61951,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "96-97"
+ "sourceLines": "129-130"
},
{
"name": "Port",
@@ -59419,7 +61969,45 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "193-193"
+ "sourceLines": "228-228"
+ },
+ {
+ "name": "PrimaryBrowserOrigin",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public EndpointReferenceExpression EndpointReference.PrimaryBrowserOrigin",
+ "returnType": "Aspire.Hosting.ApplicationModel.EndpointReferenceExpression",
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the deferred primary browser-facing origin associated with this endpoint. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Returns the first origin in "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.ApplicationModel.EndpointReference.BrowserOrigins"
+ },
+ {
+ "kind": "text",
+ "text": ", following finalized URL display ordering. The allocated HTTP(S) endpoint origin is used when no display origins remain. An endpoint without HTTP(S) origins resolves to an empty string. This value is independent of this reference's service-discovery network context. "
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n frontend.WithEnvironment(\"PUBLIC_ORIGIN\", frontend.GetEndpoint(\"https\").PrimaryBrowserOrigin);\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
+ "sourceLines": "87-87"
},
{
"name": "Resource",
@@ -59437,7 +62025,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "47-47"
+ "sourceLines": "48-48"
},
{
"name": "Scheme",
@@ -59455,7 +62043,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "208-208"
+ "sourceLines": "243-243"
},
{
"name": "TargetPort",
@@ -59482,7 +62070,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "198-198"
+ "sourceLines": "233-233"
},
{
"name": "TlsEnabled",
@@ -59522,7 +62110,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "88-88"
+ "sourceLines": "121-121"
},
{
"name": "Url",
@@ -59540,7 +62128,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "213-213"
+ "sourceLines": "248-248"
}
]
},
@@ -59721,7 +62309,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "321-321",
+ "sourceLines": "356-356",
"members": [
{
"name": ".ctor",
@@ -59762,7 +62350,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "321-331"
+ "sourceLines": "356-366"
},
{
"name": "GetValueAsync",
@@ -59843,7 +62431,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "347-347"
+ "sourceLines": "382-382"
},
{
"name": "GetValueAsync",
@@ -59934,7 +62522,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "347-347"
+ "sourceLines": "382-382"
},
{
"name": "Endpoint",
@@ -59960,7 +62548,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "326-326"
+ "sourceLines": "361-361"
},
{
"name": "Property",
@@ -59986,7 +62574,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "331-331"
+ "sourceLines": "366-366"
},
{
"name": "ValueExpression",
@@ -60004,7 +62592,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointReference.cs",
- "sourceLines": "337-337"
+ "sourceLines": "372-372"
}
]
},
@@ -60570,7 +63158,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "339-339",
+ "sourceLines": "364-364",
"members": [
{
"name": ".ctor",
@@ -60622,7 +63210,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "339-339"
+ "sourceLines": "364-364"
},
{
"name": "$",
@@ -61132,7 +63720,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ExecutableLaunchConfiguration.cs",
- "sourceLines": "89-89",
+ "sourceLines": "90-90",
"members": [
{
"name": ".ctor",
@@ -61219,7 +63807,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ExecutableLaunchConfiguration.cs",
- "sourceLines": "89-107"
+ "sourceLines": "90-108"
},
{
"name": "Mode",
@@ -61418,7 +64006,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ExecutableResource.cs",
- "sourceLines": "22-22",
+ "sourceLines": "20-20",
"members": [
{
"name": ".ctor",
@@ -61463,7 +64051,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ExecutableResource.cs",
- "sourceLines": "28-36"
+ "sourceLines": "26-34"
},
{
"name": "Command",
@@ -61481,7 +64069,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ExecutableResource.cs",
- "sourceLines": "41-41"
+ "sourceLines": "39-39"
},
{
"name": "WorkingDirectory",
@@ -61499,7 +64087,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ExecutableResource.cs",
- "sourceLines": "46-46"
+ "sourceLines": "44-44"
}
]
},
@@ -63582,7 +66170,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "487-487",
+ "sourceLines": "512-512",
"members": [
{
"name": ".ctor",
@@ -63654,7 +66242,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "487-487"
+ "sourceLines": "512-512"
},
{
"name": "$",
@@ -64173,7 +66761,23 @@
"summary": [
{
"kind": "text",
- "text": " Represents a URL on the host machine. When referenced in a container resource, localhost will be replaced with the configured container host name. "
+ "text": " Represents a URL on the host machine. When referenced in a container resource, localhost (including "
+ },
+ {
+ "kind": "code",
+ "text": "*.localhost"
+ },
+ {
+ "kind": "text",
+ "text": " host names such as "
+ },
+ {
+ "kind": "code",
+ "text": "*.dev.localhost"
+ },
+ {
+ "kind": "text",
+ "text": ") will be replaced with the configured container host name. "
}
]
},
@@ -64196,7 +66800,23 @@
"summary": [
{
"kind": "text",
- "text": " Represents a URL on the host machine. When referenced in a container resource, localhost will be replaced with the configured container host name. "
+ "text": " Represents a URL on the host machine. When referenced in a container resource, localhost (including "
+ },
+ {
+ "kind": "code",
+ "text": "*.localhost"
+ },
+ {
+ "kind": "text",
+ "text": " host names such as "
+ },
+ {
+ "kind": "code",
+ "text": "*.dev.localhost"
+ },
+ {
+ "kind": "text",
+ "text": ") will be replaced with the configured container host name. "
}
]
},
@@ -66295,7 +68915,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/IComputeEnvironmentResource.cs",
- "sourceLines": "12-12",
+ "sourceLines": "11-11",
"members": [
{
"name": "GetEndpointPropertyExpression",
@@ -66310,17 +68930,6 @@
"type": "Aspire.Hosting.ApplicationModel.EndpointReferenceExpression"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRECOMPUTE002"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -66363,7 +68972,15 @@
},
{
"kind": "text",
- "text": ", the endpoint scheme, and endpoint ports. HTTP and HTTPS endpoints use ports 80 and 443 respectively when no explicit port is configured. "
+ "text": ", the endpoint scheme, and endpoint ports. HTTP and HTTPS endpoints use ports 80 and 443 respectively when no explicit port is configured. Environments can override this method to provide their own endpoint-property mappings. Host-dependent properties require an implementation of "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ApplicationModel.IComputeEnvironmentResource.GetHostAddressExpression(Aspire.Hosting.ApplicationModel.EndpointReference)"
+ },
+ {
+ "kind": "text",
+ "text": ". "
}
],
"returns": [
@@ -66422,11 +69039,29 @@
"text": "Thrown when the requested endpoint property is unsupported, or when a non-HTTP/HTTPS endpoint does not specify a port."
}
]
+ },
+ {
+ "type": "T:System.NotSupportedException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when the environment does not implement browser-origin resolution."
+ }
+ ]
+ },
+ {
+ "type": "T:System.NotImplementedException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when a host-dependent property is requested and the environment does not implement host-address resolution."
+ }
+ ]
}
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/IComputeEnvironmentResource.cs",
- "sourceLines": "42-65"
+ "sourceLines": "47-76"
},
{
"name": "GetHostAddressExpression",
@@ -66441,17 +69076,6 @@
"type": "Aspire.Hosting.ApplicationModel.EndpointReference"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRECOMPUTE002"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -66478,7 +69102,23 @@
"remarks": [
{
"kind": "text",
- "text": " The returned value typically contains only the host name or address, without scheme, port, or path information. "
+ "text": " The returned value typically contains only the host name or address, without scheme, port, or path information. Implementations that support host-address resolution must override this method. The default implementation throws "
+ },
+ {
+ "kind": "cref",
+ "value": "T:System.NotImplementedException"
+ },
+ {
+ "kind": "text",
+ "text": " so environments that do not support this capability can still implement "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.IComputeEnvironmentResource"
+ },
+ {
+ "kind": "text",
+ "text": ". "
}
],
"returns": [
@@ -66502,10 +69142,21 @@
"text": "The endpoint reference for which to retrieve the host address or host name."
}
]
- }
+ },
+ "exceptions": [
+ {
+ "type": "T:System.NotImplementedException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when the environment does not implement host-address resolution."
+ }
+ ]
+ }
+ ]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/IComputeEnvironmentResource.cs",
- "sourceLines": "23-23"
+ "sourceLines": "25-25"
}
]
},
@@ -66876,23 +69527,12 @@
},
{
"kind": "text",
- "text": ". Implementing this interface does not by itself enable SDK container publishing; use the publishing configuration supplied by the resource's builder API. "
+ "text": ". Implementing this interface does not by itself apply project metadata, launch defaults, build coordination, or SDK container publishing. Use the configuration supplied by the resource's builder API. "
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPROJECTS001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/IDotnetProgramResource.cs",
- "sourceLines": "17-17",
+ "sourceLines": "15-15",
"members": []
},
{
@@ -68003,19 +70643,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRECOMMAND001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/IRequiredCommandValidator.cs",
- "sourceLines": "16-16",
+ "sourceLines": "13-13",
"members": [
{
"name": "ValidateAsync",
@@ -69076,19 +71705,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPROBES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/IResourceWithProbes.cs",
- "sourceLines": "12-12",
+ "sourceLines": "9-9",
"members": []
},
{
@@ -69390,7 +72008,7 @@
},
{
"kind": "text",
- "text": ". Aspire hands the project path and launch profile to the IDE, which owns building and launching the project. "
+ "text": ". Aspire hands the project path and launch profile to the IDE. The type indicates that the IDE can launch the resource; it does not guarantee whether the IDE builds the project before launch. "
}
]
},
@@ -69946,7 +72564,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "539-539",
+ "sourceLines": "564-564",
"members": [
{
"name": "Error",
@@ -71510,7 +74128,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs",
- "sourceLines": "399-399",
+ "sourceLines": "402-402",
"members": [
{
"name": ".ctor",
@@ -71551,7 +74169,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs",
- "sourceLines": "399-399"
+ "sourceLines": "402-402"
},
{
"name": "$",
@@ -71837,7 +74455,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs",
- "sourceLines": "404-404",
+ "sourceLines": "407-407",
"members": [
{
"name": ".ctor",
@@ -71846,7 +74464,7 @@
"signature": "public NetworkEndpointSnapshotList.NetworkEndpointSnapshotList()",
"returnType": "void",
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs",
- "sourceLines": "407-407"
+ "sourceLines": "410-410"
},
{
"name": "AddOrUpdateAllocatedEndpoint",
@@ -71873,7 +74491,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs",
- "sourceLines": "444-450"
+ "sourceLines": "447-453"
},
{
"name": "GetAllocatedEndpointAsync",
@@ -71901,7 +74519,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs",
- "sourceLines": "457-458"
+ "sourceLines": "460-461"
},
{
"name": "GetEnumerator",
@@ -71918,7 +74536,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs",
- "sourceLines": "414-414"
+ "sourceLines": "417-417"
},
{
"name": "TryAdd",
@@ -71953,7 +74571,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs",
- "sourceLines": "428-437"
+ "sourceLines": "431-440"
}
]
},
@@ -72331,176 +74949,660 @@
"summary": [
{
"kind": "text",
- "text": " Writes the current "
+ "text": " Writes the current "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.ParameterDefault"
+ },
+ {
+ "kind": "text",
+ "text": " to the manifest context. "
+ }
+ ],
+ "parameters": {
+ "context": [
+ {
+ "kind": "text",
+ "text": "The context for the manifest publishing operation."
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ {
+ "name": "ParameterResource",
+ "fullName": "Aspire.Hosting.ApplicationModel.ParameterResource",
+ "namespace": "Aspire.Hosting.ApplicationModel",
+ "kind": "class",
+ "accessibility": "public",
+ "baseType": "Aspire.Hosting.ApplicationModel.Resource",
+ "interfaces": [
+ "Aspire.Hosting.ApplicationModel.IExpressionValue",
+ "Aspire.Hosting.ApplicationModel.IManifestExpressionProvider",
+ "Aspire.Hosting.ApplicationModel.IValueProvider"
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Represents a parameter resource. "
+ }
+ ]
+ },
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportAttribute"
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs",
+ "sourceLines": "17-17",
+ "members": [
+ {
+ "name": ".ctor",
+ "kind": "constructor",
+ "accessibility": "public",
+ "signature": "public ParameterResource.ParameterResource(string name, Func callback, bool secret = false)",
+ "returnType": "void",
+ "parameters": [
+ {
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "name": "callback",
+ "type": "System.Func"
+ },
+ {
+ "name": "secret",
+ "type": "bool",
+ "isOptional": true,
+ "defaultValue": "False"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Initializes a new instance of "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.ParameterResource"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ],
+ "parameters": {
+ "callback": [
+ {
+ "kind": "text",
+ "text": "The callback function to retrieve the value of the parameter."
+ }
+ ],
+ "name": [
+ {
+ "kind": "text",
+ "text": "The name of the parameter resource."
+ }
+ ],
+ "secret": [
+ {
+ "kind": "text",
+ "text": "A flag indicating whether the parameter is secret."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs",
+ "sourceLines": "21-41"
+ },
+ {
+ "name": "GetValueAsync",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public ValueTask ParameterResource.GetValueAsync(CancellationToken cancellationToken)",
+ "returnType": "System.Threading.Tasks.ValueTask",
+ "parameters": [
+ {
+ "name": "cancellationToken",
+ "type": "System.Threading.CancellationToken"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the value of the parameter asynchronously, waiting if necessary for the value to be set. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A task that represents the asynchronous operation, containing the value of the parameter."
+ }
+ ],
+ "parameters": {
+ "cancellationToken": [
+ {
+ "kind": "text",
+ "text": "The cancellation token to observe while waiting for the value."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs",
+ "sourceLines": "558-558"
+ },
+ {
+ "name": "GetValueAsync",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public ValueTask ParameterResource.GetValueAsync(ValueProviderContext _, CancellationToken cancellationToken)",
+ "returnType": "System.Threading.Tasks.ValueTask",
+ "parameters": [
+ {
+ "name": "_",
+ "type": "Aspire.Hosting.ApplicationModel.ValueProviderContext"
+ },
+ {
+ "name": "cancellationToken",
+ "type": "System.Threading.CancellationToken"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the value of the parameter asynchronously, waiting if necessary for the value to be set. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs",
+ "sourceLines": "558-558"
+ },
+ {
+ "name": "SetExceptionAsync",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public Task ParameterResource.SetExceptionAsync(Exception exception, CancellationToken cancellationToken = default(CancellationToken))",
+ "returnType": "System.Threading.Tasks.Task",
+ "parameters": [
+ {
+ "name": "exception",
+ "type": "System.Exception"
+ },
+ {
+ "name": "cancellationToken",
+ "type": "System.Threading.CancellationToken",
+ "isOptional": true
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Sets or replaces the exception for this parameter. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Cancellation is checked before assignment. After assignment, cancellation does not roll back the exception or prevent the host from synchronizing dashboard and parameter-resolution state, even if another observer reports cancellation. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A task that completes when the exception has been applied and observers have processed the change."
+ }
+ ],
+ "parameters": {
+ "cancellationToken": [
+ {
+ "kind": "text",
+ "text": "The cancellation token to observe while applying the exception."
+ }
+ ],
+ "exception": [
+ {
+ "kind": "text",
+ "text": "The exception used to fault this parameter."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when "
+ },
+ {
+ "kind": "paramref",
+ "value": "exception"
+ },
+ {
+ "kind": "text",
+ "text": " is "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ]
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs",
+ "sourceLines": "408-419"
+ },
+ {
+ "name": "SetValueAsync",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public Task ParameterResource.SetValueAsync(string? value = null, CancellationToken cancellationToken = default(CancellationToken))",
+ "returnType": "System.Threading.Tasks.Task",
+ "parameters": [
+ {
+ "name": "value",
+ "type": "string?",
+ "isNullable": true,
+ "isOptional": true
+ },
+ {
+ "name": "cancellationToken",
+ "type": "System.Threading.CancellationToken",
+ "isOptional": true
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportAttribute",
+ "constructorArguments": [
+ "ParameterResource.setValueAsync"
+ ],
+ "arguments": {
+ "MethodName": "setValueAsync"
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Sets or replaces the value for this parameter. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Setting a value directly on the resource updates dashboard state after the resource has been observed by the host. It does not save the value to deployment state. Required parameters set to "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": " or an empty string are faulted with "
},
{
"kind": "cref",
- "value": "T:Aspire.Hosting.ApplicationModel.ParameterDefault"
+ "value": "T:Aspire.Hosting.MissingParameterValueException"
},
{
"kind": "text",
- "text": " to the manifest context. "
+ "text": ", while optional parameters can be cleared to "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": ". Cancellation is checked before assignment. After assignment, cancellation does not roll back the value or prevent the host from synchronizing dashboard and parameter-resolution state, even if another observer reports cancellation. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A task that completes when the value has been applied and observers have processed the change."
}
],
"parameters": {
- "context": [
+ "cancellationToken": [
{
"kind": "text",
- "text": "The context for the manifest publishing operation."
+ "text": "The cancellation token to observe while applying the value."
+ }
+ ],
+ "value": [
+ {
+ "kind": "text",
+ "text": "The value to use for this parameter."
}
]
}
- }
- }
- ]
- },
- {
- "name": "ParameterResource",
- "fullName": "Aspire.Hosting.ApplicationModel.ParameterResource",
- "namespace": "Aspire.Hosting.ApplicationModel",
- "kind": "class",
- "accessibility": "public",
- "baseType": "Aspire.Hosting.ApplicationModel.Resource",
- "interfaces": [
- "Aspire.Hosting.ApplicationModel.IExpressionValue",
- "Aspire.Hosting.ApplicationModel.IManifestExpressionProvider",
- "Aspire.Hosting.ApplicationModel.IValueProvider"
- ],
- "docs": {
- "summary": [
- {
- "kind": "text",
- "text": " Represents a parameter resource. "
- }
- ]
- },
- "sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs",
- "sourceLines": "14-14",
- "members": [
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs",
+ "sourceLines": "356-356"
+ },
{
- "name": ".ctor",
- "kind": "constructor",
+ "name": "TryGetCurrentValue",
+ "kind": "method",
"accessibility": "public",
- "signature": "public ParameterResource.ParameterResource(string name, Func callback, bool secret = false)",
- "returnType": "void",
+ "signature": "public bool ParameterResource.TryGetCurrentValue(out string? value)",
+ "returnType": "bool",
"parameters": [
{
- "name": "name",
- "type": "string"
- },
- {
- "name": "callback",
- "type": "System.Func"
- },
+ "name": "value",
+ "type": "string?",
+ "isNullable": true,
+ "modifier": "out"
+ }
+ ],
+ "attributes": [
{
- "name": "secret",
- "type": "bool",
- "isOptional": true,
- "defaultValue": "False"
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "Uses out parameter which is not ATS-compatible."
+ }
}
],
"docs": {
"summary": [
{
"kind": "text",
- "text": " Initializes a new instance of "
+ "text": " Attempts to get the current value for this parameter without waiting for unresolved input. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " This method returns "
},
{
- "kind": "cref",
- "value": "T:Aspire.Hosting.ApplicationModel.ParameterResource"
+ "kind": "langword",
+ "value": "false"
},
{
"kind": "text",
- "text": ". "
+ "text": " for unresolved parameters, parameters with initialization errors, and optional parameters that resolved without a value. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "langword",
+ "value": "true"
+ },
+ {
+ "kind": "text",
+ "text": " if the parameter currently has a non-empty value; otherwise, "
+ },
+ {
+ "kind": "langword",
+ "value": "false"
+ },
+ {
+ "kind": "text",
+ "text": "."
}
],
"parameters": {
- "callback": [
+ "value": [
{
"kind": "text",
- "text": "The callback function to retrieve the value of the parameter."
- }
- ],
- "name": [
+ "text": "When this method returns "
+ },
{
- "kind": "text",
- "text": "The name of the parameter resource."
- }
- ],
- "secret": [
+ "kind": "langword",
+ "value": "true"
+ },
{
"kind": "text",
- "text": "A flag indicating whether the parameter is secret."
+ "text": ", contains the current parameter value."
}
]
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs",
- "sourceLines": "26-34"
+ "sourceLines": "209-235"
},
{
- "name": "GetValueAsync",
+ "name": "TrySetException",
"kind": "method",
"accessibility": "public",
- "signature": "public ValueTask ParameterResource.GetValueAsync(CancellationToken cancellationToken)",
- "returnType": "System.Threading.Tasks.ValueTask",
+ "signature": "public bool ParameterResource.TrySetException(Exception exception)",
+ "returnType": "bool",
"parameters": [
{
- "name": "cancellationToken",
- "type": "System.Threading.CancellationToken"
+ "name": "exception",
+ "type": "System.Exception"
}
],
"docs": {
"summary": [
{
"kind": "text",
- "text": " Gets the value of the parameter asynchronously, waiting if necessary for the value to be set. "
+ "text": " Attempts to complete this parameter with the specified exception. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " This method follows "
+ },
+ {
+ "kind": "cref",
+ "value": "M:System.Threading.Tasks.TaskCompletionSource`1.TrySetException(System.Exception)"
+ },
+ {
+ "kind": "text",
+ "text": " semantics and returns "
+ },
+ {
+ "kind": "langword",
+ "value": "false"
+ },
+ {
+ "kind": "text",
+ "text": " when the parameter has already completed. "
}
],
"returns": [
+ {
+ "kind": "langword",
+ "value": "true"
+ },
{
"kind": "text",
- "text": "A task that represents the asynchronous operation, containing the value of the parameter."
+ "text": " if the parameter was completed with "
+ },
+ {
+ "kind": "paramref",
+ "value": "exception"
+ },
+ {
+ "kind": "text",
+ "text": "; otherwise, "
+ },
+ {
+ "kind": "langword",
+ "value": "false"
+ },
+ {
+ "kind": "text",
+ "text": "."
}
],
"parameters": {
- "cancellationToken": [
+ "exception": [
{
"kind": "text",
- "text": "The cancellation token to observe while waiting for the value."
+ "text": "The exception used to fault this parameter."
}
]
- }
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when "
+ },
+ {
+ "kind": "paramref",
+ "value": "exception"
+ },
+ {
+ "kind": "text",
+ "text": " is "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ]
+ }
+ ]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs",
- "sourceLines": "130-130"
+ "sourceLines": "313-330"
},
{
- "name": "GetValueAsync",
+ "name": "TrySetValue",
"kind": "method",
"accessibility": "public",
- "signature": "public ValueTask ParameterResource.GetValueAsync(ValueProviderContext _, CancellationToken cancellationToken)",
- "returnType": "System.Threading.Tasks.ValueTask",
+ "signature": "public bool ParameterResource.TrySetValue(string? value)",
+ "returnType": "bool",
"parameters": [
{
- "name": "_",
- "type": "Aspire.Hosting.ApplicationModel.ValueProviderContext"
- },
- {
- "name": "cancellationToken",
- "type": "System.Threading.CancellationToken"
+ "name": "value",
+ "type": "string?",
+ "isNullable": true
}
],
"docs": {
"summary": [
{
"kind": "text",
- "text": " Gets the value of the parameter asynchronously, waiting if necessary for the value to be set. "
+ "text": " Attempts to complete this parameter with the specified value. "
}
- ]
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " This method follows "
+ },
+ {
+ "kind": "cref",
+ "value": "M:System.Threading.Tasks.TaskCompletionSource`1.TrySetResult(`0)"
+ },
+ {
+ "kind": "text",
+ "text": " semantics and returns "
+ },
+ {
+ "kind": "langword",
+ "value": "false"
+ },
+ {
+ "kind": "text",
+ "text": " when the parameter has already completed. Required parameters completed with "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": " or an empty string are faulted with "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.MissingParameterValueException"
+ },
+ {
+ "kind": "text",
+ "text": ". Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ApplicationModel.ParameterResource.SetValueAsync(System.String,System.Threading.CancellationToken)"
+ },
+ {
+ "kind": "text",
+ "text": " when the value should replace an existing value and update dashboard state. To also save the value to user secrets in run mode, use "
+ },
+ {
+ "kind": "code",
+ "text": "ParameterProcessor.SetValueAsync"
+ },
+ {
+ "kind": "text",
+ "text": " with "
+ },
+ {
+ "kind": "code",
+ "text": "saveToUserSecrets: true"
+ },
+ {
+ "kind": "text",
+ "text": ". In publish mode, values are saved to deployment state during parameter initialization; setting a value does not itself persist it. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "langword",
+ "value": "true"
+ },
+ {
+ "kind": "text",
+ "text": " if the parameter was completed with "
+ },
+ {
+ "kind": "paramref",
+ "value": "value"
+ },
+ {
+ "kind": "text",
+ "text": " or a missing-value exception; otherwise, "
+ },
+ {
+ "kind": "langword",
+ "value": "false"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "parameters": {
+ "value": [
+ {
+ "kind": "text",
+ "text": "The value to use for this parameter."
+ }
+ ]
+ }
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs",
- "sourceLines": "130-130"
+ "sourceLines": "269-299"
},
{
"name": "Default",
@@ -72576,6 +75678,69 @@
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs"
},
+ {
+ "name": "Required",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public bool ParameterResource.Required",
+ "returnType": "bool",
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets a value indicating whether this parameter must have a value before it can be resolved. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ParameterResourceBuilderExtensions.AsRequired(Aspire.Hosting.ApplicationModel.IResourceBuilder{Aspire.Hosting.ApplicationModel.ParameterResource})"
+ },
+ {
+ "kind": "text",
+ "text": " or "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ParameterResourceBuilderExtensions.AsOptional(Aspire.Hosting.ApplicationModel.IResourceBuilder{Aspire.Hosting.ApplicationModel.ParameterResource})"
+ },
+ {
+ "kind": "text",
+ "text": " to change this value. Optional parameters that do not have values resolve to "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": " from "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ApplicationModel.ParameterResource.GetValueAsync(System.Threading.CancellationToken)"
+ },
+ {
+ "kind": "text",
+ "text": ". The obsolete "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.ApplicationModel.ParameterResource.Value"
+ },
+ {
+ "kind": "text",
+ "text": " property returns an empty string for unset optional parameters because its signature is non-nullable. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs"
+ },
{
"name": "Secret",
"kind": "property",
@@ -72592,7 +75757,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs",
- "sourceLines": "67-67"
+ "sourceLines": "93-93"
},
{
"name": "Value",
@@ -72640,7 +75805,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs",
- "sourceLines": "43-43"
+ "sourceLines": "68-68"
},
{
"name": "ValueExpression",
@@ -72658,7 +75823,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ParameterResource.cs",
- "sourceLines": "77-77"
+ "sourceLines": "166-166"
}
]
},
@@ -73008,19 +76173,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPROBES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ProbeAnnotation.cs",
- "sourceLines": "34-34",
+ "sourceLines": "30-30",
"members": [
{
"name": "FailureThreshold",
@@ -73168,17 +76322,6 @@
"description": "Liveness probe."
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPROBES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ProbeType.cs",
"members": []
},
@@ -74375,7 +77518,15 @@
"remarks": [
{
"kind": "text",
- "text": " By default, the IDE builds and launches the project itself. When "
+ "text": " The IDE launches the resource described by "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.IProjectMetadata"
+ },
+ {
+ "kind": "text",
+ "text": ". When "
},
{
"kind": "cref",
@@ -74391,15 +77542,15 @@
},
{
"kind": "text",
- "text": ", the IDE launches output produced by an external or coordinated build. The resource must carry "
+ "text": ", the IDE launches output produced by an external or coordinated build. When it is "
},
{
- "kind": "cref",
- "value": "T:Aspire.Hosting.IProjectMetadata"
+ "kind": "langword",
+ "value": "false"
},
{
"kind": "text",
- "text": ". "
+ "text": ", Aspire does not ask the IDE to suppress its normal build behavior, but Aspire may still prebuild the project before sending the launch request. "
}
]
},
@@ -74415,7 +77566,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ExecutableLaunchConfiguration.cs",
- "sourceLines": "119-119",
+ "sourceLines": "121-121",
"members": [
{
"name": ".ctor",
@@ -74433,7 +77584,15 @@
"remarks": [
{
"kind": "text",
- "text": " By default, the IDE builds and launches the project itself. When "
+ "text": " The IDE launches the resource described by "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.IProjectMetadata"
+ },
+ {
+ "kind": "text",
+ "text": ". When "
},
{
"kind": "cref",
@@ -74449,20 +77608,20 @@
},
{
"kind": "text",
- "text": ", the IDE launches output produced by an external or coordinated build. The resource must carry "
+ "text": ", the IDE launches output produced by an external or coordinated build. When it is "
},
{
- "kind": "cref",
- "value": "T:Aspire.Hosting.IProjectMetadata"
+ "kind": "langword",
+ "value": "false"
},
{
"kind": "text",
- "text": ". "
+ "text": ", Aspire does not ask the IDE to suppress its normal build behavior, but Aspire may still prebuild the project before sending the launch request. "
}
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ExecutableLaunchConfiguration.cs",
- "sourceLines": "119-126"
+ "sourceLines": "121-128"
},
{
"name": "BuildConfiguration",
@@ -74754,7 +77913,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ProjectResource.cs",
- "sourceLines": "15-15",
+ "sourceLines": "14-14",
"members": [
{
"name": ".ctor",
@@ -74793,7 +77952,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ProjectResource.cs",
- "sourceLines": "22-33"
+ "sourceLines": "21-32"
}
]
},
@@ -76168,7 +79327,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ReferenceExpression.cs",
- "sourceLines": "522-523"
+ "sourceLines": "523-524"
},
{
"name": "AppendFormatted",
@@ -76217,7 +79376,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ReferenceExpression.cs",
- "sourceLines": "533-542"
+ "sourceLines": "534-544"
},
{
"name": "AppendFormatted",
@@ -76294,7 +79453,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ReferenceExpression.cs",
- "sourceLines": "551-552"
+ "sourceLines": "553-554"
},
{
"name": "AppendFormatted",
@@ -76472,7 +79631,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ReferenceExpression.cs",
- "sourceLines": "513-514"
+ "sourceLines": "514-515"
},
{
"name": "AppendValueProvider",
@@ -76555,7 +79714,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ReferenceExpression.cs",
- "sourceLines": "596-613"
+ "sourceLines": "598-615"
},
{
"name": "Build",
@@ -76585,7 +79744,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ReferenceExpression.cs",
- "sourceLines": "621-621"
+ "sourceLines": "623-623"
},
{
"name": "IsEmpty",
@@ -76667,7 +79826,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ReferenceExpression.cs",
- "sourceLines": "632-632",
+ "sourceLines": "634-634",
"members": [
{
"name": ".ctor",
@@ -76772,7 +79931,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ReferenceExpression.cs",
- "sourceLines": "650-651"
+ "sourceLines": "652-653"
},
{
"name": "AppendFormatted",
@@ -76814,7 +79973,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ReferenceExpression.cs",
- "sourceLines": "660-661"
+ "sourceLines": "662-663"
},
{
"name": "AppendFormatted",
@@ -77228,7 +80387,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ReferenceExpression.cs",
- "sourceLines": "641-642"
+ "sourceLines": "643-644"
}
]
},
@@ -77384,7 +80543,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "394-394",
+ "sourceLines": "419-419",
"members": [
{
"name": ".ctor",
@@ -77425,7 +80584,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "394-394"
+ "sourceLines": "419-419"
},
{
"name": "$",
@@ -77789,19 +80948,8 @@
]
}
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRECOMMAND001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandAnnotation.cs",
- "sourceLines": "15-15",
+ "sourceLines": "13-13",
"members": [
{
"name": ".ctor",
@@ -77832,7 +80980,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandAnnotation.cs",
- "sourceLines": "15-20"
+ "sourceLines": "13-18"
},
{
"name": "Command",
@@ -77850,7 +80998,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandAnnotation.cs",
- "sourceLines": "20-20"
+ "sourceLines": "18-18"
},
{
"name": "HelpLink",
@@ -77908,7 +81056,7 @@
},
{
"kind": "text",
- "text": " indicating whether the command is valid. "
+ "text": " indicating whether the command is valid. Failed validation logs a warning but does not prevent the resource from attempting to start. "
}
]
},
@@ -77952,15 +81100,6 @@
}
},
"attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRECOMMAND001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- },
{
"name": "Aspire.Hosting.AspireExportAttribute",
"arguments": {
@@ -77970,7 +81109,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandValidationContext.cs",
- "sourceLines": "16-16",
+ "sourceLines": "13-13",
"members": [
{
"name": ".ctor",
@@ -78021,7 +81160,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandValidationContext.cs",
- "sourceLines": "16-31"
+ "sourceLines": "13-28"
},
{
"name": "Failure",
@@ -78066,7 +81205,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandValidationContext.cs",
- "sourceLines": "44-44"
+ "sourceLines": "41-41"
},
{
"name": "Success",
@@ -78097,7 +81236,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandValidationContext.cs",
- "sourceLines": "37-37"
+ "sourceLines": "34-34"
},
{
"name": "CancellationToken",
@@ -78115,7 +81254,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandValidationContext.cs",
- "sourceLines": "31-31"
+ "sourceLines": "28-28"
},
{
"name": "ResolvedPath",
@@ -78133,7 +81272,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandValidationContext.cs",
- "sourceLines": "21-21"
+ "sourceLines": "18-18"
},
{
"name": "Services",
@@ -78151,7 +81290,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandValidationContext.cs",
- "sourceLines": "26-26"
+ "sourceLines": "23-23"
}
]
},
@@ -78168,18 +81307,15 @@
"kind": "text",
"text": " Represents the result of validating a required command. "
}
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Failed validation logs a warning but does not prevent the resource from attempting to start. "
+ }
]
},
"attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRECOMMAND001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- },
{
"name": "Aspire.Hosting.AspireExportAttribute",
"arguments": {
@@ -78188,7 +81324,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandValidationResult.cs",
- "sourceLines": "13-13",
+ "sourceLines": "15-15",
"members": [
{
"name": "Failure",
@@ -78226,7 +81362,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandValidationResult.cs",
- "sourceLines": "48-48"
+ "sourceLines": "50-50"
},
{
"name": "Success",
@@ -78250,7 +81386,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandValidationResult.cs",
- "sourceLines": "41-41"
+ "sourceLines": "43-43"
},
{
"name": "IsValid",
@@ -78268,7 +81404,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandValidationResult.cs",
- "sourceLines": "30-30"
+ "sourceLines": "32-32"
},
{
"name": "ValidationMessage",
@@ -78287,7 +81423,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/RequiredCommandValidationResult.cs",
- "sourceLines": "35-35"
+ "sourceLines": "37-37"
}
]
},
@@ -78735,7 +81871,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Resource.cs",
- "sourceLines": "22-22"
+ "sourceLines": "33-33"
},
{
"name": "Name",
@@ -78755,6 +81891,39 @@
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Resource.cs",
"sourceLines": "17-17"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public virtual string Resource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isVirtual": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/Resource.cs",
+ "sourceLines": "28-28"
}
]
},
@@ -79819,7 +82988,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "466-466",
+ "sourceLines": "491-491",
"members": [
{
"name": ".ctor",
@@ -79935,7 +83104,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "466-476"
+ "sourceLines": "491-501"
},
{
"name": "$",
@@ -80612,7 +83781,7 @@
"remarks": [
{
"kind": "text",
- "text": " Any resources that customize their URLs via a "
+ "text": " Resources that customize their URLs via a "
},
{
"kind": "cref",
@@ -80620,7 +83789,15 @@
},
{
"kind": "text",
- "text": " will have their callbacks invoked during this event. "
+ "text": " have their callbacks invoked before event handlers run. Browser URL references contain the finalized values at that point. Endpoint and URL configuration must be registered before this event is published. Browser-facing resource allocators should complete allocation through "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.DistributedApplicationEventingExtensions.PublishResourceEndpointsAllocatedAsync(Aspire.Hosting.Eventing.IDistributedApplicationEventing,Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent,System.Threading.CancellationToken)"
+ },
+ {
+ "kind": "text",
+ "text": " so URL customization completes before the notification is dispatched. "
}
]
},
@@ -80633,7 +83810,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceEndpointsAllocatedEvent.cs",
- "sourceLines": "15-15",
+ "sourceLines": "20-20",
"members": [
{
"name": ".ctor",
@@ -80661,7 +83838,7 @@
"remarks": [
{
"kind": "text",
- "text": " Any resources that customize their URLs via a "
+ "text": " Resources that customize their URLs via a "
},
{
"kind": "cref",
@@ -80669,12 +83846,20 @@
},
{
"kind": "text",
- "text": " will have their callbacks invoked during this event. "
+ "text": " have their callbacks invoked before event handlers run. Browser URL references contain the finalized values at that point. Endpoint and URL configuration must be registered before this event is published. Browser-facing resource allocators should complete allocation through "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.DistributedApplicationEventingExtensions.PublishResourceEndpointsAllocatedAsync(Aspire.Hosting.Eventing.IDistributedApplicationEventing,Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent,System.Threading.CancellationToken)"
+ },
+ {
+ "kind": "text",
+ "text": " so URL customization completes before the notification is dispatched. "
}
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceEndpointsAllocatedEvent.cs",
- "sourceLines": "15-21"
+ "sourceLines": "20-26"
},
{
"name": "Resource",
@@ -80692,7 +83877,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceEndpointsAllocatedEvent.cs",
- "sourceLines": "18-18"
+ "sourceLines": "23-23"
},
{
"name": "Services",
@@ -80718,7 +83903,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceEndpointsAllocatedEvent.cs",
- "sourceLines": "21-21"
+ "sourceLines": "26-26"
}
]
},
@@ -80757,7 +83942,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs",
- "sourceLines": "1442-1442",
+ "sourceLines": "1511-1511",
"members": [
{
"name": ".ctor",
@@ -80808,7 +83993,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs",
- "sourceLines": "1442-1457"
+ "sourceLines": "1511-1526"
},
{
"name": "Resource",
@@ -80826,7 +84011,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs",
- "sourceLines": "1447-1447"
+ "sourceLines": "1516-1516"
},
{
"name": "ResourceId",
@@ -80844,7 +84029,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs",
- "sourceLines": "1452-1452"
+ "sourceLines": "1521-1521"
},
{
"name": "Snapshot",
@@ -80862,7 +84047,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs",
- "sourceLines": "1457-1457"
+ "sourceLines": "1526-1526"
}
]
},
@@ -84151,7 +87336,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs",
- "sourceLines": "27-698"
+ "sourceLines": "27-758"
},
{
"name": ".ctor",
@@ -84220,7 +87405,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs",
- "sourceLines": "27-698"
+ "sourceLines": "27-758"
},
{
"name": "Dispose",
@@ -84237,7 +87422,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs",
- "sourceLines": "1382-1383"
+ "sourceLines": "1451-1452"
},
{
"name": "PublishUpdateAsync",
@@ -84302,7 +87487,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs",
- "sourceLines": "830-952"
+ "sourceLines": "888-1021"
},
{
"name": "PublishUpdateAsync",
@@ -84357,7 +87542,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs",
- "sourceLines": "830-952"
+ "sourceLines": "888-1021"
},
{
"name": "TryGetCurrentState",
@@ -84495,7 +87680,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs",
- "sourceLines": "722-755"
+ "sourceLines": "782-815"
},
{
"name": "WaitForDependenciesAsync",
@@ -84547,7 +87732,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs",
- "sourceLines": "478-595"
+ "sourceLines": "507-642"
},
{
"name": "WaitForResourceAsync",
@@ -84590,7 +87775,7 @@
"remarks": [
{
"kind": "text",
- "text": " This method returns a task that will complete when the resource reaches the specified target state. If the resource is already in the target state, the method will return immediately."
+ "text": " This method returns a task that will complete when the resource reaches the specified target state. If the resource is already in the target state, the method will return immediately without logging wait or completion messages."
},
{
"kind": "text",
@@ -84706,7 +87891,7 @@
"remarks": [
{
"kind": "text",
- "text": " This method returns a task that will complete when the resource reaches one of the specified target states. If the resource is already in the target state, the method will return immediately."
+ "text": " This method returns a task that will complete when the resource reaches one of the specified target states. If the resource is already in the target state, the method will return immediately without logging wait or completion messages."
},
{
"kind": "text",
@@ -84816,6 +88001,10 @@
"kind": "text",
"text": "."
},
+ {
+ "kind": "text",
+ "text": " If the predicate matches a current resource snapshot, the method will return immediately without logging wait or completion messages."
+ },
{
"kind": "text",
"text": " If the predicate isn't satisfied before "
@@ -85162,7 +88351,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs",
- "sourceLines": "763-816"
+ "sourceLines": "823-874"
}
]
},
@@ -85190,7 +88379,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceNotificationService.cs",
- "sourceLines": "1463-1463",
+ "sourceLines": "1532-1532",
"members": [
{
"name": ".ctor",
@@ -85252,7 +88441,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "402-402",
+ "sourceLines": "427-427",
"members": [
{
"name": ".ctor",
@@ -85294,7 +88483,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "402-402"
+ "sourceLines": "427-427"
},
{
"name": "$",
@@ -85323,7 +88512,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "438-441"
+ "sourceLines": "463-466"
},
{
"name": "Equals",
@@ -86001,7 +89190,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "322-322",
+ "sourceLines": "347-347",
"members": [
{
"name": ".ctor",
@@ -86055,7 +89244,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "322-322"
+ "sourceLines": "347-347"
},
{
"name": "$",
@@ -86255,7 +89444,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "329-329"
+ "sourceLines": "354-354"
},
{
"name": "op_Inequality",
@@ -86602,57 +89791,45 @@
"returnType": "void"
},
{
- "name": "DisplayOrder",
- "kind": "field",
+ "name": "DisplayLocation",
+ "kind": "property",
"accessibility": "public",
- "signature": "public int? ResourceUrlAnnotation.DisplayOrder",
- "returnType": "int?",
- "isReturnNullable": true,
- "attributes": [
- {
- "name": "System.ObsoleteAttribute",
- "constructorArguments": [
- "DisplayOrder was incorrectly created as a field. It will be re-added as a property in a future Aspire version."
- ]
- }
- ],
+ "signature": "public UrlDisplayLocation ResourceUrlAnnotation.DisplayLocation",
+ "returnType": "Aspire.Hosting.ApplicationModel.UrlDisplayLocation",
+ "hasGet": true,
+ "hasSet": true,
"docs": {
"summary": [
{
"kind": "text",
- "text": " The display order the URL. Higher values mean sort higher in the list. "
- }
- ],
- "remarks": [
+ "text": " Locations where this URL should be shown on the dashboard. Defaults to "
+ },
+ {
+ "kind": "cref",
+ "value": "F:Aspire.Hosting.ApplicationModel.UrlDisplayLocation.SummaryAndDetails"
+ },
{
"kind": "text",
- "text": " This member was incorrectly created as a field. It will be re-added as a property in a future Aspire version. "
+ "text": ". "
}
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/ResourceUrlAnnotation.cs"
},
{
- "name": "DisplayLocation",
+ "name": "DisplayOrder",
"kind": "property",
"accessibility": "public",
- "signature": "public UrlDisplayLocation ResourceUrlAnnotation.DisplayLocation",
- "returnType": "Aspire.Hosting.ApplicationModel.UrlDisplayLocation",
+ "signature": "public int? ResourceUrlAnnotation.DisplayOrder",
+ "returnType": "int?",
+ "isReturnNullable": true,
"hasGet": true,
"hasSet": true,
"docs": {
"summary": [
{
"kind": "text",
- "text": " Locations where this URL should be shown on the dashboard. Defaults to "
- },
- {
- "kind": "cref",
- "value": "F:Aspire.Hosting.ApplicationModel.UrlDisplayLocation.SummaryAndDetails"
- },
- {
- "kind": "text",
- "text": ". "
+ "text": " Gets or sets the display order of the URL. Higher values mean sort higher in the list. "
}
]
},
@@ -87758,17 +90935,11 @@
},
"attributes": [
{
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRETERMINAL001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
+ "name": "Aspire.Hosting.AspireDtoAttribute"
}
],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs",
- "sourceLines": "97-97",
+ "sourceLines": "92-92",
"members": [
{
"name": ".ctor",
@@ -87777,7 +90948,7 @@
"signature": "public TerminalOptions.TerminalOptions()",
"returnType": "void",
"sourceFile": "src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs",
- "sourceLines": "99-100"
+ "sourceLines": "94-95"
},
{
"name": "Columns",
@@ -87794,6 +90965,12 @@
"text": " Gets or sets the initial number of columns for the terminal. The value must be greater than zero. Defaults to 132. "
}
],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": "Setting either dimension makes the dashboard's Terminals page adopt the producer's current grid instead of automatically fitting it to the view."
+ }
+ ],
"exceptions": [
{
"type": "T:System.ArgumentOutOfRangeException",
@@ -87823,78 +91000,19 @@
"text": " Gets or sets the initial number of rows for the terminal. The value must be greater than zero. Defaults to 50. "
}
],
- "exceptions": [
- {
- "type": "T:System.ArgumentOutOfRangeException",
- "description": [
- {
- "kind": "text",
- "text": "Thrown when set to zero or a negative value."
- }
- ]
- }
- ]
- },
- "sourceFile": "src/Aspire.Hosting/ApplicationModel/TerminalAnnotation.cs"
- },
- {
- "name": "ShowTerminalHost",
- "kind": "property",
- "accessibility": "public",
- "signature": "public bool TerminalOptions.ShowTerminalHost",
- "returnType": "bool",
- "hasGet": true,
- "hasSet": true,
- "docs": {
- "summary": [
- {
- "kind": "text",
- "text": " Gets or sets a value indicating whether the per-replica terminal host resources (named "
- },
- {
- "kind": "code",
- "text": "{parent}-terminalhost-{index}"
- },
+ "remarks": [
{
"kind": "text",
- "text": ") should appear in the resource list and export diagnostic logs, metrics, and traces. "
+ "text": "Setting either dimension makes the dashboard's Terminals page adopt the producer's current grid instead of automatically fitting it to the view."
}
],
- "remarks": [
- {
- "kind": "text",
- "text": " Defaults to "
- },
- {
- "kind": "code",
- "text": "false"
- },
- {
- "kind": "text",
- "text": ": terminal host resources are hidden from the dashboard and CLI resource list and do not export telemetry because they are an implementation detail of the "
- },
- {
- "kind": "cref",
- "value": "M:Aspire.Hosting.TerminalResourceBuilderExtensions.WithTerminal``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.Action{Aspire.Hosting.ApplicationModel.TerminalOptions})"
- },
- {
- "kind": "text",
- "text": " feature, not something the user explicitly added to their app model. "
- },
+ "exceptions": [
{
- "kind": "para",
- "children": [
- {
- "kind": "text",
- "text": " Set to "
- },
- {
- "kind": "code",
- "text": "true"
- },
+ "type": "T:System.ArgumentOutOfRangeException",
+ "description": [
{
"kind": "text",
- "text": " when diagnosing terminal-host startup / connectivity issues so the host's state, exit code, and diagnostic telemetry are visible alongside the parent resource. Telemetry is exported when a dashboard OTLP endpoint is available. This is useful when investigating cases like \"DCP never dialed the producer UDS\" or \"the host crashed during recycle\". "
+ "text": "Thrown when set to zero or a negative value."
}
]
}
@@ -88320,7 +91438,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/TerminalService.cs",
- "sourceLines": "477-506"
+ "sourceLines": "478-507"
},
{
"name": "TryGetTerminal",
@@ -88387,7 +91505,118 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/TerminalService.cs",
- "sourceLines": "234-249"
+ "sourceLines": "235-250"
+ }
+ ]
+ },
+ {
+ "name": "TraitAnnotation",
+ "fullName": "Aspire.Hosting.ApplicationModel.TraitAnnotation",
+ "namespace": "Aspire.Hosting.ApplicationModel",
+ "kind": "class",
+ "accessibility": "public",
+ "isSealed": true,
+ "interfaces": [
+ "Aspire.Hosting.ApplicationModel.IResourceAnnotation"
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Immutable, non-sensitive metadata attached to a resource. Multiple annotations with the same name represent multiple values. "
+ }
+ ]
+ },
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIRERESOURCETRAITS001"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/TraitAnnotation.cs",
+ "sourceLines": "12-12",
+ "members": [
+ {
+ "name": ".ctor",
+ "kind": "constructor",
+ "accessibility": "public",
+ "signature": "public TraitAnnotation.TraitAnnotation(string name, string value)",
+ "returnType": "void",
+ "parameters": [
+ {
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "name": "value",
+ "type": "string"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Creates a resource trait. "
+ }
+ ],
+ "parameters": {
+ "name": [
+ {
+ "kind": "text",
+ "text": "The case-sensitive trait name."
+ }
+ ],
+ "value": [
+ {
+ "kind": "text",
+ "text": "The trait value. Traits are visible in dashboard and tooling output and must not contain secrets."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/TraitAnnotation.cs",
+ "sourceLines": "19-26"
+ },
+ {
+ "name": "Name",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public string TraitAnnotation.Name",
+ "returnType": "string",
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Gets the case-sensitive trait name."
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/TraitAnnotation.cs",
+ "sourceLines": "29-29"
+ },
+ {
+ "name": "Value",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public string TraitAnnotation.Value",
+ "returnType": "string",
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Gets the trait value."
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/ApplicationModel/TraitAnnotation.cs",
+ "sourceLines": "32-32"
}
]
},
@@ -88575,7 +91804,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "377-377",
+ "sourceLines": "402-402",
"members": [
{
"name": ".ctor",
@@ -88620,7 +91849,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "377-377"
+ "sourceLines": "402-402"
},
{
"name": "$",
@@ -88916,7 +92145,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "348-348",
+ "sourceLines": "373-373",
"members": [
{
"name": ".ctor",
@@ -88968,7 +92197,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "348-353"
+ "sourceLines": "373-378"
},
{
"name": "$",
@@ -89002,7 +92231,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "365-369"
+ "sourceLines": "390-394"
},
{
"name": "Equals",
@@ -89962,7 +93191,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "387-387",
+ "sourceLines": "412-412",
"members": [
{
"name": ".ctor",
@@ -90044,7 +93273,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs",
- "sourceLines": "387-387"
+ "sourceLines": "412-412"
},
{
"name": "$",
@@ -90672,7 +93901,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/ContainerFilesExtensions.cs",
- "sourceLines": "12-12",
+ "sourceLines": "11-11",
"members": [
{
"name": "AddContainerFiles",
@@ -90708,15 +93937,6 @@
"arguments": {
"Reason": "Polyglot-facing wrappers are exported from DockerfileBuilderExports with a curated signature."
}
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"docs": {
@@ -90887,7 +94107,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/ContainerFilesExtensions.cs",
- "sourceLines": "84-119"
+ "sourceLines": "81-116"
},
{
"name": "AddContainerFilesStages",
@@ -90919,15 +94139,6 @@
"arguments": {
"Reason": "Polyglot-facing wrappers are exported from DockerfileBuilderExports with a curated signature."
}
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"docs": {
@@ -90965,7 +94176,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/ContainerFilesExtensions.cs",
- "sourceLines": "26-49"
+ "sourceLines": "24-47"
}
]
},
@@ -90986,19 +94197,10 @@
"attributes": [
{
"name": "Aspire.Hosting.AspireExportAttribute"
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileBuilder.cs",
- "sourceLines": "13-13",
+ "sourceLines": "10-10",
"members": [
{
"name": ".ctor",
@@ -91023,7 +94225,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileBuilder.cs",
- "sourceLines": "15-23"
+ "sourceLines": "12-20"
},
{
"name": "Arg",
@@ -91037,17 +94239,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -91077,7 +94268,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileBuilder.cs",
- "sourceLines": "42-45"
+ "sourceLines": "38-41"
},
{
"name": "Arg",
@@ -91095,17 +94286,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -91141,7 +94321,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileBuilder.cs",
- "sourceLines": "61-65"
+ "sourceLines": "56-60"
},
{
"name": "From",
@@ -91159,17 +94339,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -91199,7 +94368,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileBuilder.cs",
- "sourceLines": "77-82"
+ "sourceLines": "71-76"
},
{
"name": "From",
@@ -91213,17 +94382,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -91247,7 +94405,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileBuilder.cs",
- "sourceLines": "93-97"
+ "sourceLines": "86-90"
},
{
"name": "WriteAsync",
@@ -91311,7 +94469,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileBuilder.cs",
- "sourceLines": "108-134"
+ "sourceLines": "101-127"
},
{
"name": "Stages",
@@ -91329,7 +94487,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileBuilder.cs",
- "sourceLines": "28-28"
+ "sourceLines": "25-25"
}
]
},
@@ -91351,19 +94509,10 @@
"attributes": [
{
"name": "Aspire.Hosting.AspireExportAttribute"
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "13-13",
+ "sourceLines": "10-10",
"members": [
{
"name": ".ctor",
@@ -91413,7 +94562,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "15-28"
+ "sourceLines": "12-25"
},
{
"name": "Arg",
@@ -91427,17 +94576,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -91461,7 +94599,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "48-50"
+ "sourceLines": "44-46"
},
{
"name": "Arg",
@@ -91479,17 +94617,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -91519,7 +94646,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "62-65"
+ "sourceLines": "57-60"
},
{
"name": "Cmd",
@@ -91533,17 +94660,6 @@
"type": "string[]"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -91567,7 +94683,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "198-204"
+ "sourceLines": "184-190"
},
{
"name": "Comment",
@@ -91581,17 +94697,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -91621,7 +94726,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "275-277"
+ "sourceLines": "256-258"
},
{
"name": "Copy",
@@ -91639,17 +94744,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -91679,7 +94773,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "103-106"
+ "sourceLines": "95-98"
},
{
"name": "Copy",
@@ -91701,17 +94795,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -91747,7 +94830,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "136-140"
+ "sourceLines": "126-130"
},
{
"name": "CopyFrom",
@@ -91769,17 +94852,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -91815,7 +94887,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "119-123"
+ "sourceLines": "110-114"
},
{
"name": "CopyFrom",
@@ -91841,17 +94913,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -91893,7 +94954,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "154-159"
+ "sourceLines": "143-148"
},
{
"name": "EmptyLine",
@@ -91901,17 +94962,6 @@
"accessibility": "public",
"signature": "public DockerfileStage DockerfileStage.EmptyLine()",
"returnType": "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage",
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -91927,7 +94977,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "259-260"
+ "sourceLines": "241-242"
},
{
"name": "Entrypoint",
@@ -91941,17 +94991,6 @@
"type": "string[]"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -91975,7 +95014,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "215-221"
+ "sourceLines": "200-206"
},
{
"name": "Env",
@@ -91993,17 +95032,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -92033,7 +95061,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "171-174"
+ "sourceLines": "159-162"
},
{
"name": "Expose",
@@ -92047,17 +95075,6 @@
"type": "int"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -92081,7 +95098,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "185-187"
+ "sourceLines": "172-174"
},
{
"name": "Run",
@@ -92095,17 +95112,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -92129,7 +95135,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "89-91"
+ "sourceLines": "82-84"
},
{
"name": "RunWithMounts",
@@ -92148,17 +95154,6 @@
"modifier": "params"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -92188,7 +95183,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "233-236"
+ "sourceLines": "217-220"
},
{
"name": "User",
@@ -92202,17 +95197,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -92236,7 +95220,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "247-249"
+ "sourceLines": "230-232"
},
{
"name": "WorkDir",
@@ -92250,17 +95234,6 @@
"type": "string"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -92284,7 +95257,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "76-78"
+ "sourceLines": "70-72"
},
{
"name": "WriteStatementAsync",
@@ -92333,7 +95306,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "283-287"
+ "sourceLines": "264-268"
},
{
"name": "StageName",
@@ -92352,7 +95325,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "33-33"
+ "sourceLines": "30-30"
},
{
"name": "Statements",
@@ -92370,7 +95343,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStage.cs",
- "sourceLines": "38-38"
+ "sourceLines": "35-35"
}
]
},
@@ -92389,19 +95362,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREDOCKERFILEBUILDER001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/ApplicationModel/Docker/DockerfileStatement.cs",
- "sourceLines": "12-12",
+ "sourceLines": "9-9",
"members": [
{
"name": "WriteStatementAsync",
@@ -94315,19 +97277,8 @@
]
}
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES002"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/DeploymentStateSection.cs",
- "sourceLines": "19-19",
+ "sourceLines": "17-17",
"members": [
{
"name": ".ctor",
@@ -94393,7 +97344,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/DeploymentStateSection.cs",
- "sourceLines": "19-49"
+ "sourceLines": "17-47"
},
{
"name": "SetValue",
@@ -94424,7 +97375,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/DeploymentStateSection.cs",
- "sourceLines": "57-59"
+ "sourceLines": "55-57"
},
{
"name": "Data",
@@ -94456,7 +97407,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/DeploymentStateSection.cs",
- "sourceLines": "38-38"
+ "sourceLines": "36-36"
},
{
"name": "SectionName",
@@ -94474,7 +97425,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/DeploymentStateSection.cs",
- "sourceLines": "29-29"
+ "sourceLines": "27-27"
},
{
"name": "Version",
@@ -94533,19 +97484,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/DistributedApplicationPipelineExtensions.cs",
- "sourceLines": "12-12",
+ "sourceLines": "9-9",
"members": [
{
"name": "DisableBuildOnlyContainerValidation",
@@ -94612,7 +97552,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/DistributedApplicationPipelineExtensions.cs",
- "sourceLines": "74-83"
+ "sourceLines": "71-80"
},
{
"name": "WithFinalAction",
@@ -94747,7 +97687,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/DistributedApplicationPipelineExtensions.cs",
- "sourceLines": "40-58"
+ "sourceLines": "37-55"
}
]
},
@@ -94765,19 +97705,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES002"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/IDeploymentStateManager.cs",
- "sourceLines": "12-12",
+ "sourceLines": "9-9",
"members": [
{
"name": "AcquireCurrentSectionAsync",
@@ -94840,7 +97769,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/IDeploymentStateManager.cs",
- "sourceLines": "39-39"
+ "sourceLines": "36-36"
},
{
"name": "AcquireSectionAsync",
@@ -95058,19 +97987,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/IDistributedApplicationPipeline.cs",
- "sourceLines": "14-14",
+ "sourceLines": "9-9",
"members": [
{
"name": "AddPipelineConfiguration",
@@ -95248,19 +98166,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/IPipelineActivityReporter.cs",
- "sourceLines": "12-12",
+ "sourceLines": "9-9",
"members": [
{
"name": "CompletePublishAsync",
@@ -95415,7 +98322,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/IPipelineActivityReporter.cs",
- "sourceLines": "31-31"
+ "sourceLines": "28-28"
},
{
"name": "CreateStepAsync",
@@ -95485,37 +98392,143 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/IPipelineActivityReporter.cs",
- "sourceLines": "31-31"
+ "sourceLines": "28-28"
}
]
},
{
- "name": "IPipelineOutputService",
- "fullName": "Aspire.Hosting.Pipelines.IPipelineOutputService",
+ "name": "IPipelineOutputComparer",
+ "fullName": "Aspire.Hosting.Pipelines.IPipelineOutputComparer",
"namespace": "Aspire.Hosting.Pipelines",
"kind": "interface",
"accessibility": "public",
+ "isGeneric": true,
+ "genericParameters": [
+ {
+ "name": "TSnapshot",
+ "constraints": [
+ "notnull"
+ ]
+ }
+ ],
"docs": {
"summary": [
{
"kind": "text",
- "text": " Service for managing pipeline output directories. "
+ "text": " Compares pipeline output snapshots and reports differences as "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.Pipelines.PipelineOutputChange"
+ },
+ {
+ "kind": "text",
+ "text": " values. "
}
- ]
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Implementations should rely on the supplied snapshots rather than mutable live output. "
+ }
+ ],
+ "typeParameters": {
+ "TSnapshot": [
+ {
+ "kind": "text",
+ "text": "The captured representation shared with the matching snapshotter."
+ }
+ ]
+ }
},
"attributes": [
{
"name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
"constructorArguments": [
- "ASPIREPIPELINES004"
+ "ASPIREPIPELINES005"
],
"arguments": {
"UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
}
}
],
+ "sourceFile": "src/Aspire.Hosting/Pipelines/IPipelineOutputComparer.cs",
+ "sourceLines": "16-16",
+ "members": [
+ {
+ "name": "CompareAsync",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public abstract Task> IPipelineOutputComparer.CompareAsync(TSnapshot before, TSnapshot after, CancellationToken cancellationToken)",
+ "returnType": "System.Threading.Tasks.Task>",
+ "isAbstract": true,
+ "parameters": [
+ {
+ "name": "before",
+ "type": "TSnapshot"
+ },
+ {
+ "name": "after",
+ "type": "TSnapshot"
+ },
+ {
+ "name": "cancellationToken",
+ "type": "System.Threading.CancellationToken"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Compares output captured before and after artifact generation. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The changes with output-directory-relative paths. An empty list passes the output check."
+ }
+ ],
+ "parameters": {
+ "after": [
+ {
+ "kind": "text",
+ "text": "The snapshot captured after generation."
+ }
+ ],
+ "before": [
+ {
+ "kind": "text",
+ "text": "The snapshot captured before generation."
+ }
+ ],
+ "cancellationToken": [
+ {
+ "kind": "text",
+ "text": "The cancellation token."
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ {
+ "name": "IPipelineOutputService",
+ "fullName": "Aspire.Hosting.Pipelines.IPipelineOutputService",
+ "namespace": "Aspire.Hosting.Pipelines",
+ "kind": "interface",
+ "accessibility": "public",
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Service for managing pipeline output directories. "
+ }
+ ]
+ },
"sourceFile": "src/Aspire.Hosting/Pipelines/IPipelineOutputService.cs",
- "sourceLines": "13-13",
+ "sourceLines": "11-11",
"members": [
{
"name": "GetOutputDirectory",
@@ -95644,35 +98657,123 @@
]
},
{
- "name": "IReportingStep",
- "fullName": "Aspire.Hosting.Pipelines.IReportingStep",
+ "name": "IPipelineOutputSnapshotter",
+ "fullName": "Aspire.Hosting.Pipelines.IPipelineOutputSnapshotter",
"namespace": "Aspire.Hosting.Pipelines",
"kind": "interface",
"accessibility": "public",
- "interfaces": [
- "System.IAsyncDisposable"
+ "isGeneric": true,
+ "genericParameters": [
+ {
+ "name": "TSnapshot",
+ "constraints": [
+ "notnull"
+ ]
+ }
],
"docs": {
"summary": [
{
"kind": "text",
- "text": " Represents a publishing step, which can contain multiple tasks. "
+ "text": " Captures pipeline output as provider-defined snapshots. "
}
- ]
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Implementations may replace default filesystem capture entirely. "
+ }
+ ],
+ "typeParameters": {
+ "TSnapshot": [
+ {
+ "kind": "text",
+ "text": "The captured representation shared with the matching comparer."
+ }
+ ]
+ }
},
"attributes": [
{
"name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
"constructorArguments": [
- "ASPIREPIPELINES001"
+ "ASPIREPIPELINES005"
],
"arguments": {
"UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
}
}
],
+ "sourceFile": "src/Aspire.Hosting/Pipelines/IPipelineOutputSnapshotter.cs",
+ "sourceLines": "16-16",
+ "members": [
+ {
+ "name": "CaptureAsync",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public abstract Task IPipelineOutputSnapshotter.CaptureAsync(string outputDirectory, CancellationToken cancellationToken)",
+ "returnType": "System.Threading.Tasks.Task",
+ "isAbstract": true,
+ "parameters": [
+ {
+ "name": "outputDirectory",
+ "type": "string"
+ },
+ {
+ "name": "cancellationToken",
+ "type": "System.Threading.CancellationToken"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Captures the output at the supplied directory. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A snapshot of the captured output."
+ }
+ ],
+ "parameters": {
+ "cancellationToken": [
+ {
+ "kind": "text",
+ "text": "The cancellation token."
+ }
+ ],
+ "outputDirectory": [
+ {
+ "kind": "text",
+ "text": "The output directory resolved for this capture."
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ {
+ "name": "IReportingStep",
+ "fullName": "Aspire.Hosting.Pipelines.IReportingStep",
+ "namespace": "Aspire.Hosting.Pipelines",
+ "kind": "interface",
+ "accessibility": "public",
+ "interfaces": [
+ "System.IAsyncDisposable"
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Represents a publishing step, which can contain multiple tasks. "
+ }
+ ]
+ },
"sourceFile": "src/Aspire.Hosting/Pipelines/IReportingStep.cs",
- "sourceLines": "13-13",
+ "sourceLines": "11-11",
"members": [
{
"name": "CompleteAsync",
@@ -96031,19 +99132,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/IReportingTask.cs",
- "sourceLines": "12-12",
+ "sourceLines": "9-9",
"members": [
{
"name": "CompleteAsync",
@@ -96296,19 +99386,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/MarkdownString.cs",
- "sourceLines": "28-28",
+ "sourceLines": "25-25",
"members": [
{
"name": ".ctor",
@@ -96374,7 +99453,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/MarkdownString.cs",
- "sourceLines": "35-39"
+ "sourceLines": "32-36"
},
{
"name": "ToString",
@@ -96398,7 +99477,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/MarkdownString.cs",
- "sourceLines": "47-47"
+ "sourceLines": "44-44"
},
{
"name": "Value",
@@ -96416,7 +99495,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/MarkdownString.cs",
- "sourceLines": "44-44"
+ "sourceLines": "41-41"
}
]
},
@@ -96446,19 +99525,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/NullPipelineActivityReporter.cs",
- "sourceLines": "15-15",
+ "sourceLines": "11-11",
"members": [
{
"name": ".ctor",
@@ -96509,7 +99577,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/NullPipelineActivityReporter.cs",
- "sourceLines": "26-26"
+ "sourceLines": "22-22"
},
{
"name": "CompletePublishAsync",
@@ -96573,7 +99641,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/NullPipelineActivityReporter.cs",
- "sourceLines": "33-33"
+ "sourceLines": "29-29"
},
{
"name": "CreateStepAsync",
@@ -96621,7 +99689,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/NullPipelineActivityReporter.cs",
- "sourceLines": "20-20"
+ "sourceLines": "16-16"
}
]
},
@@ -96642,19 +99710,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineConfigurationAnnotation.cs",
- "sourceLines": "16-16",
+ "sourceLines": "12-12",
"members": [
{
"name": ".ctor",
@@ -96748,7 +99805,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineConfigurationAnnotation.cs",
- "sourceLines": "21-21"
+ "sourceLines": "17-17"
}
]
},
@@ -96767,21 +99824,12 @@
]
},
"attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- },
{
"name": "Aspire.Hosting.AspireExportAttribute"
}
],
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineConfigurationContext.cs",
- "sourceLines": "16-16",
+ "sourceLines": "14-14",
"members": [
{
"name": ".ctor",
@@ -96790,7 +99838,7 @@
"signature": "public PipelineConfigurationContext.PipelineConfigurationContext()",
"returnType": "void",
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineConfigurationContext.cs",
- "sourceLines": "47-47"
+ "sourceLines": "45-45"
},
{
"name": "GetSteps",
@@ -96832,7 +99880,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineConfigurationContext.cs",
- "sourceLines": "71-72"
+ "sourceLines": "69-70"
},
{
"name": "GetSteps",
@@ -96891,7 +99939,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineConfigurationContext.cs",
- "sourceLines": "84-86"
+ "sourceLines": "82-84"
},
{
"name": "GetSteps",
@@ -96960,7 +100008,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineConfigurationContext.cs",
- "sourceLines": "99-101"
+ "sourceLines": "97-99"
},
{
"name": "Model",
@@ -97069,15 +100117,6 @@
}
},
"attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- },
{
"name": "Aspire.Hosting.AspireExportAttribute",
"arguments": {
@@ -97086,7 +100125,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineContext.cs",
- "sourceLines": "20-20",
+ "sourceLines": "18-18",
"members": [
{
"name": ".ctor",
@@ -97157,7 +100196,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineContext.cs",
- "sourceLines": "20-67"
+ "sourceLines": "18-87"
},
{
"name": "CancellationToken",
@@ -97192,106 +100231,617 @@
}
]
},
- "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineContext.cs",
- "sourceLines": "35-35"
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineContext.cs",
+ "sourceLines": "33-33"
+ },
+ {
+ "name": "Logger",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public ILogger PipelineContext.Logger",
+ "returnType": "Microsoft.Extensions.Logging.ILogger",
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the logger for pipeline operations. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineContext.cs",
+ "sourceLines": "43-43"
+ },
+ {
+ "name": "Model",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public DistributedApplicationModel PipelineContext.Model",
+ "returnType": "Aspire.Hosting.ApplicationModel.DistributedApplicationModel",
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the distributed application model to be deployed. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineContext.cs",
+ "sourceLines": "28-28"
+ },
+ {
+ "name": "SelectedSteps",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public IReadOnlyList PipelineContext.SelectedSteps",
+ "returnType": "System.Collections.Generic.IReadOnlyList",
+ "hasGet": true,
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "The selected execution graph is runtime-only pipeline metadata."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the resolved steps selected for this execution, including transitive dependencies. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " This list is populated before step actions execute. It is empty before pipeline execution. Unlike the application model, it excludes steps outside the selected target's dependency graph. "
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.Pipeline.AddStep(\"inspect-deployment\", context =>\n {\n foreach (var step in context.PipelineContext.SelectedSteps)\n {\n context.Logger.LogInformation(\"Selected step: {StepName}\", step.Name);\n }\n return Task.CompletedTask;\n }, requiredBy: WellKnownPipelineSteps.Deploy);\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineContext.cs"
+ },
+ {
+ "name": "Services",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public IServiceProvider PipelineContext.Services",
+ "returnType": "System.IServiceProvider",
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the service provider for dependency resolution. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineContext.cs",
+ "sourceLines": "38-38"
+ },
+ {
+ "name": "Summary",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public PipelineSummary PipelineContext.Summary",
+ "returnType": "Aspire.Hosting.Pipelines.PipelineSummary",
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the pipeline summary that steps can add information to. The summary will be displayed to users after pipeline execution completes. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Pipeline steps can add key-value pairs to the summary to provide useful information about the pipeline execution, such as deployment targets, resource names, URLs, etc. "
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n // In a pipeline step\n context.PipelineContext.Summary.Add(\"βοΈ Target\", \"Azure\");\n context.PipelineContext.Summary.Add(\"\uD83D\uDCE6 Resource Group\", \"rg-myapp\");\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineContext.cs",
+ "sourceLines": "65-65"
+ }
+ ]
+ },
+ {
+ "name": "PipelineOptions",
+ "fullName": "Aspire.Hosting.Pipelines.PipelineOptions",
+ "namespace": "Aspire.Hosting.Pipelines",
+ "kind": "class",
+ "accessibility": "public",
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Represents the options for executing a pipeline. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOptions.cs",
+ "sourceLines": "9-9",
+ "members": [
+ {
+ "name": ".ctor",
+ "kind": "constructor",
+ "accessibility": "public",
+ "signature": "public PipelineOptions.PipelineOptions()",
+ "returnType": "void"
+ },
+ {
+ "name": "ClearCache",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public bool PipelineOptions.ClearCache",
+ "returnType": "bool",
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets a value indicating whether to clear the deployment cache. When true, deployment state will not be saved or used. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOptions.cs"
+ },
+ {
+ "name": "LogLevel",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public string? PipelineOptions.LogLevel",
+ "returnType": "string?",
+ "isReturnNullable": true,
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets the minimum log level for pipeline execution. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOptions.cs"
+ },
+ {
+ "name": "OutputPath",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public string? PipelineOptions.OutputPath",
+ "returnType": "string?",
+ "isReturnNullable": true,
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets the path to the directory where the pipeline output will be written. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOptions.cs"
+ },
+ {
+ "name": "SkipConfirmation",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public bool PipelineOptions.SkipConfirmation",
+ "returnType": "bool",
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets a value indicating whether to skip confirmation prompts for destructive operations. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOptions.cs"
+ },
+ {
+ "name": "Step",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public string? PipelineOptions.Step",
+ "returnType": "string?",
+ "isReturnNullable": true,
+ "hasGet": true,
+ "hasSet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets or sets the name of a specific pipeline step to run. When specified, only this step and its dependencies will be executed. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOptions.cs"
+ }
+ ]
+ },
+ {
+ "name": "PipelineOutputChange",
+ "fullName": "Aspire.Hosting.Pipelines.PipelineOutputChange",
+ "namespace": "Aspire.Hosting.Pipelines",
+ "kind": "class",
+ "accessibility": "public",
+ "isSealed": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Describes a changed output file. "
+ }
+ ]
+ },
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREPIPELINES005"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOutputChange.cs",
+ "sourceLines": "13-13",
+ "members": [
+ {
+ "name": ".ctor",
+ "kind": "constructor",
+ "accessibility": "public",
+ "signature": "public PipelineOutputChange.PipelineOutputChange(PipelineOutputChangeKind kind, string path)",
+ "returnType": "void",
+ "parameters": [
+ {
+ "name": "kind",
+ "type": "Aspire.Hosting.Pipelines.PipelineOutputChangeKind"
+ },
+ {
+ "name": "path",
+ "type": "string"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Initializes a new instance of the "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.Pipelines.PipelineOutputChange"
+ },
+ {
+ "kind": "text",
+ "text": " class. "
+ }
+ ],
+ "parameters": {
+ "kind": [
+ {
+ "kind": "text",
+ "text": "The kind of change."
+ }
+ ],
+ "path": [
+ {
+ "kind": "text",
+ "text": "The reporting path relative to the output directory. Custom coverage may use parent segments."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "The path is blank or invalid."
+ }
+ ]
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOutputChange.cs",
+ "sourceLines": "21-30"
},
{
- "name": "Logger",
+ "name": "Kind",
"kind": "property",
"accessibility": "public",
- "signature": "public ILogger PipelineContext.Logger",
- "returnType": "Microsoft.Extensions.Logging.ILogger",
+ "signature": "public PipelineOutputChangeKind PipelineOutputChange.Kind",
+ "returnType": "Aspire.Hosting.Pipelines.PipelineOutputChangeKind",
"hasGet": true,
"docs": {
"summary": [
{
"kind": "text",
- "text": " Gets the logger for pipeline operations. "
+ "text": " Gets the kind of change. "
}
]
},
- "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineContext.cs",
- "sourceLines": "45-45"
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOutputChange.cs",
+ "sourceLines": "35-35"
},
{
- "name": "Model",
+ "name": "Path",
"kind": "property",
"accessibility": "public",
- "signature": "public DistributedApplicationModel PipelineContext.Model",
- "returnType": "Aspire.Hosting.ApplicationModel.DistributedApplicationModel",
+ "signature": "public string PipelineOutputChange.Path",
+ "returnType": "string",
"hasGet": true,
"docs": {
"summary": [
{
"kind": "text",
- "text": " Gets the distributed application model to be deployed. "
+ "text": " Gets the file path relative to the output directory. "
}
]
},
- "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineContext.cs",
- "sourceLines": "30-30"
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOutputChange.cs",
+ "sourceLines": "40-40"
+ }
+ ]
+ },
+ {
+ "name": "PipelineOutputChangeKind",
+ "fullName": "Aspire.Hosting.Pipelines.PipelineOutputChangeKind",
+ "namespace": "Aspire.Hosting.Pipelines",
+ "kind": "enum",
+ "accessibility": "public",
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Specifies how an output file changed between captures. "
+ }
+ ]
+ },
+ "enumMembers": [
+ {
+ "name": "Added",
+ "value": 0,
+ "description": "The file exists only in the later capture."
},
{
- "name": "Services",
+ "name": "Changed",
+ "value": 1,
+ "description": "An existing file is reported as changed."
+ },
+ {
+ "name": "Removed",
+ "value": 2,
+ "description": "The file exists only in the earlier capture."
+ }
+ ],
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREPIPELINES005"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOutputChangeKind.cs",
+ "members": []
+ },
+ {
+ "name": "PipelineOutputDiffMode",
+ "fullName": "Aspire.Hosting.Pipelines.PipelineOutputDiffMode",
+ "namespace": "Aspire.Hosting.Pipelines",
+ "kind": "enum",
+ "accessibility": "public",
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Selects membership and fingerprinting for pipeline output comparison. "
+ }
+ ]
+ },
+ "enumMembers": [
+ {
+ "name": "Auto",
+ "value": 0,
+ "description": "Uses Git when the executable and a usable worktree are available; otherwise uses FileSystem."
+ },
+ {
+ "name": "Git",
+ "value": 1,
+ "description": "Requires Git membership and canonical fingerprints, failing if Git or a usable worktree is unavailable."
+ },
+ {
+ "name": "FileSystem",
+ "value": 2,
+ "description": "Uses filesystem membership and raw-byte XxHash3, including matching ignored files, without invoking Git."
+ }
+ ],
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREPIPELINES005"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOutputDiffMode.cs",
+ "sourceLines": "12-12",
+ "members": []
+ },
+ {
+ "name": "PipelineOutputDiffOptions",
+ "fullName": "Aspire.Hosting.Pipelines.PipelineOutputDiffOptions",
+ "namespace": "Aspire.Hosting.Pipelines",
+ "kind": "class",
+ "accessibility": "public",
+ "isSealed": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Controls selection and built-in fingerprinting for the default pipeline output differ. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Configured through the "
+ },
+ {
+ "kind": "code",
+ "text": "Pipeline:OutputDiff"
+ },
+ {
+ "kind": "text",
+ "text": " configuration section or ordinary options registration. The comparison target remains opt-in through "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.PipelineOutputDiffingExtensions.WithOutputDiffing(Aspire.Hosting.IDistributedApplicationBuilder,System.String,System.String,System.String)"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREPIPELINES005"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOutputDiffOptions.cs",
+ "sourceLines": "16-16",
+ "members": [
+ {
+ "name": ".ctor",
+ "kind": "constructor",
+ "accessibility": "public",
+ "signature": "public PipelineOutputDiffOptions.PipelineOutputDiffOptions()",
+ "returnType": "void",
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOutputDiffOptions.cs",
+ "sourceLines": "35-35"
+ },
+ {
+ "name": "Mode",
"kind": "property",
"accessibility": "public",
- "signature": "public IServiceProvider PipelineContext.Services",
- "returnType": "System.IServiceProvider",
+ "signature": "public PipelineOutputDiffMode PipelineOutputDiffOptions.Mode",
+ "returnType": "Aspire.Hosting.Pipelines.PipelineOutputDiffMode",
"hasGet": true,
+ "hasSet": true,
"docs": {
"summary": [
{
"kind": "text",
- "text": " Gets the service provider for dependency resolution. "
+ "text": " Gets or sets the membership and fingerprinting strategy. Defaults to "
+ },
+ {
+ "kind": "cref",
+ "value": "F:Aspire.Hosting.Pipelines.PipelineOutputDiffMode.Auto"
+ },
+ {
+ "kind": "text",
+ "text": ". "
}
]
},
- "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineContext.cs",
- "sourceLines": "40-40"
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOutputDiffOptions.cs"
},
{
- "name": "Summary",
+ "name": "Rules",
"kind": "property",
"accessibility": "public",
- "signature": "public PipelineSummary PipelineContext.Summary",
- "returnType": "Aspire.Hosting.Pipelines.PipelineSummary",
+ "signature": "public IList PipelineOutputDiffOptions.Rules",
+ "returnType": "System.Collections.Generic.IList",
"hasGet": true,
"docs": {
"summary": [
{
"kind": "text",
- "text": " Gets the pipeline summary that steps can add information to. The summary will be displayed to users after pipeline execution completes. "
+ "text": " Gets the ordered include and exclude glob rules, relative to the global output directory. "
}
],
"remarks": [
{
"kind": "text",
- "text": " Pipeline steps can add key-value pairs to the summary to provide useful information about the pipeline execution, such as deployment targets, resource names, URLs, etc. "
- }
- ],
- "examples": [
+ "text": " An empty collection selects all files with "
+ },
{
- "code": "\n // In a pipeline step\n context.PipelineContext.Summary.Add(\"βοΈ Target\", \"Azure\");\n context.PipelineContext.Summary.Add(\"\uD83D\uDCE6 Resource Group\", \"rg-myapp\");\n ",
- "language": "csharp"
+ "kind": "code",
+ "text": "Include **/*"
+ },
+ {
+ "kind": "text",
+ "text": ". A nonempty collection replaces that default: only included paths are selected, and the last matching rule wins. To exclude from a broad scope, first add "
+ },
+ {
+ "kind": "code",
+ "text": "Include **/*"
+ },
+ {
+ "kind": "text",
+ "text": ", then the exclusions. Git membership filtering applies after these rules when "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.Pipelines.PipelineOutputDiffOptions.Mode"
+ },
+ {
+ "kind": "text",
+ "text": " selects Git; an include cannot restore an ignored, untracked file. When Git is not used, these rules also control selection of Git metadata. Rules affect comparison only, not generation. The policy is compiled from validated options when the default differ is resolved; membership is reevaluated at each capture. "
}
]
},
- "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineContext.cs",
- "sourceLines": "67-67"
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOutputDiffOptions.cs",
+ "sourceLines": "35-35"
}
]
},
{
- "name": "PipelineOptions",
- "fullName": "Aspire.Hosting.Pipelines.PipelineOptions",
+ "name": "PipelineOutputDiffRule",
+ "fullName": "Aspire.Hosting.Pipelines.PipelineOutputDiffRule",
"namespace": "Aspire.Hosting.Pipelines",
"kind": "class",
"accessibility": "public",
+ "isSealed": true,
"docs": {
"summary": [
{
"kind": "text",
- "text": " Represents the options for executing a pipeline. "
+ "text": " Includes or excludes matching files from pipeline output comparison. "
}
]
},
@@ -97299,115 +100849,92 @@
{
"name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
"constructorArguments": [
- "ASPIREPIPELINES001"
+ "ASPIREPIPELINES005"
],
"arguments": {
"UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
}
}
],
- "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOptions.cs",
- "sourceLines": "12-12",
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOutputDiffOptions.cs",
+ "sourceLines": "42-42",
"members": [
{
"name": ".ctor",
"kind": "constructor",
"accessibility": "public",
- "signature": "public PipelineOptions.PipelineOptions()",
- "returnType": "void"
+ "signature": "public PipelineOutputDiffRule.PipelineOutputDiffRule()",
+ "returnType": "void",
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOutputDiffOptions.cs",
+ "sourceLines": "47-53"
},
{
- "name": "ClearCache",
+ "name": "Action",
"kind": "property",
"accessibility": "public",
- "signature": "public bool PipelineOptions.ClearCache",
- "returnType": "bool",
+ "signature": "public string PipelineOutputDiffRule.Action",
+ "returnType": "string",
"hasGet": true,
"hasSet": true,
"docs": {
"summary": [
{
"kind": "text",
- "text": " Gets or sets a value indicating whether to clear the deployment cache. When true, deployment state will not be saved or used. "
- }
- ]
- },
- "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOptions.cs"
- },
- {
- "name": "LogLevel",
- "kind": "property",
- "accessibility": "public",
- "signature": "public string? PipelineOptions.LogLevel",
- "returnType": "string?",
- "isReturnNullable": true,
- "hasGet": true,
- "hasSet": true,
- "docs": {
- "summary": [
+ "text": " Gets or sets the action, "
+ },
+ {
+ "kind": "code",
+ "text": "Include"
+ },
{
"kind": "text",
- "text": " Gets or sets the minimum log level for pipeline execution. "
- }
- ]
- },
- "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOptions.cs"
- },
- {
- "name": "OutputPath",
- "kind": "property",
- "accessibility": "public",
- "signature": "public string? PipelineOptions.OutputPath",
- "returnType": "string?",
- "isReturnNullable": true,
- "hasGet": true,
- "hasSet": true,
- "docs": {
- "summary": [
+ "text": " or "
+ },
+ {
+ "kind": "code",
+ "text": "Exclude"
+ },
{
"kind": "text",
- "text": " Gets or sets the path to the directory where the pipeline output will be written. "
+ "text": ", matched without regard to case. "
}
]
},
- "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOptions.cs"
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOutputDiffOptions.cs"
},
{
- "name": "SkipConfirmation",
+ "name": "Pattern",
"kind": "property",
"accessibility": "public",
- "signature": "public bool PipelineOptions.SkipConfirmation",
- "returnType": "bool",
+ "signature": "public string PipelineOutputDiffRule.Pattern",
+ "returnType": "string",
"hasGet": true,
"hasSet": true,
"docs": {
"summary": [
{
"kind": "text",
- "text": " Gets or sets a value indicating whether to skip confirmation prompts for destructive operations. "
- }
- ]
- },
- "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOptions.cs"
- },
- {
- "name": "Step",
- "kind": "property",
- "accessibility": "public",
- "signature": "public string? PipelineOptions.Step",
- "returnType": "string?",
- "isReturnNullable": true,
- "hasGet": true,
- "hasSet": true,
- "docs": {
- "summary": [
+ "text": " Gets or sets a nonempty relative glob pattern, such as "
+ },
+ {
+ "kind": "code",
+ "text": "src/**"
+ },
{
"kind": "text",
- "text": " Gets or sets the name of a specific pipeline step to run. When specified, only this step and its dependencies will be executed. "
+ "text": " or "
+ },
+ {
+ "kind": "code",
+ "text": "**/*.tmp"
+ },
+ {
+ "kind": "text",
+ "text": ". Patterns cannot be rooted or contain parent-directory segments. "
}
]
},
- "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOptions.cs"
+ "sourceFile": "src/Aspire.Hosting/Pipelines/PipelineOutputDiffOptions.cs"
}
]
},
@@ -97426,15 +100953,6 @@
]
},
"attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- },
{
"name": "Aspire.Hosting.AspireExportAttribute",
"arguments": {
@@ -97443,7 +100961,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStep.cs",
- "sourceLines": "18-18",
+ "sourceLines": "14-14",
"members": [
{
"name": ".ctor",
@@ -97452,7 +100970,7 @@
"signature": "public PipelineStep.PipelineStep()",
"returnType": "void",
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStep.cs",
- "sourceLines": "20-57"
+ "sourceLines": "16-53"
},
{
"name": "DependsOn",
@@ -97488,7 +101006,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStep.cs",
- "sourceLines": "72-73"
+ "sourceLines": "68-69"
},
{
"name": "DependsOn",
@@ -97519,7 +101037,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStep.cs",
- "sourceLines": "81-82"
+ "sourceLines": "77-78"
},
{
"name": "RequiredBy",
@@ -97555,7 +101073,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStep.cs",
- "sourceLines": "92-93"
+ "sourceLines": "88-89"
},
{
"name": "RequiredBy",
@@ -97586,7 +101104,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStep.cs",
- "sourceLines": "113-114"
+ "sourceLines": "109-110"
},
{
"name": "Action",
@@ -97755,19 +101273,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepAnnotation.cs",
- "sourceLines": "15-15",
+ "sourceLines": "11-11",
"members": [
{
"name": ".ctor",
@@ -97956,7 +101463,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepAnnotation.cs",
- "sourceLines": "60-60"
+ "sourceLines": "56-56"
}
]
},
@@ -97982,15 +101489,6 @@
]
},
"attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- },
{
"name": "Aspire.Hosting.AspireExportAttribute",
"arguments": {
@@ -97999,7 +101497,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepContext.cs",
- "sourceLines": "19-19",
+ "sourceLines": "17-17",
"members": [
{
"name": ".ctor",
@@ -98024,7 +101522,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepContext.cs",
- "sourceLines": "57-57"
+ "sourceLines": "55-55"
},
{
"name": "ExecutionContext",
@@ -98042,7 +101540,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepContext.cs",
- "sourceLines": "42-42"
+ "sourceLines": "40-40"
},
{
"name": "Logger",
@@ -98060,7 +101558,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepContext.cs",
- "sourceLines": "52-52"
+ "sourceLines": "50-50"
},
{
"name": "Model",
@@ -98078,7 +101576,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepContext.cs",
- "sourceLines": "37-37"
+ "sourceLines": "35-35"
},
{
"name": "PipelineContext",
@@ -98148,7 +101646,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepContext.cs",
- "sourceLines": "47-47"
+ "sourceLines": "45-45"
},
{
"name": "Summary",
@@ -98178,7 +101676,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepContext.cs",
- "sourceLines": "74-74"
+ "sourceLines": "72-72"
}
]
},
@@ -98197,19 +101695,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepExtensions.cs",
- "sourceLines": "12-12",
+ "sourceLines": "9-9",
"members": [
{
"name": "DependsOn",
@@ -98268,7 +101755,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepExtensions.cs",
- "sourceLines": "23-33"
+ "sourceLines": "20-30"
},
{
"name": "DependsOn",
@@ -98326,7 +101813,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepExtensions.cs",
- "sourceLines": "45-55"
+ "sourceLines": "42-52"
},
{
"name": "DependsOn",
@@ -98384,7 +101871,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepExtensions.cs",
- "sourceLines": "67-75"
+ "sourceLines": "64-72"
},
{
"name": "RequiredBy",
@@ -98443,7 +101930,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepExtensions.cs",
- "sourceLines": "87-97"
+ "sourceLines": "84-94"
},
{
"name": "RequiredBy",
@@ -98501,7 +101988,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepExtensions.cs",
- "sourceLines": "109-119"
+ "sourceLines": "106-116"
},
{
"name": "RequiredBy",
@@ -98559,7 +102046,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepExtensions.cs",
- "sourceLines": "131-139"
+ "sourceLines": "128-136"
}
]
},
@@ -98586,15 +102073,6 @@
]
},
"attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- },
{
"name": "Aspire.Hosting.AspireExportAttribute",
"arguments": {
@@ -98603,7 +102081,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepFactoryContext.cs",
- "sourceLines": "15-15",
+ "sourceLines": "13-13",
"members": [
{
"name": ".ctor",
@@ -98667,19 +102145,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepFactoryExtensions.cs",
- "sourceLines": "13-13",
+ "sourceLines": "11-11",
"members": [
{
"name": "WithPipelineConfiguration",
@@ -99267,7 +102734,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineStepFactoryExtensions.cs",
- "sourceLines": "113-126"
+ "sourceLines": "111-124"
}
]
},
@@ -99338,15 +102805,6 @@
]
},
"attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics#{0}"
- }
- },
{
"name": "Aspire.Hosting.AspireExportAttribute",
"arguments": {
@@ -99355,7 +102813,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineSummary.cs",
- "sourceLines": "58-58",
+ "sourceLines": "56-56",
"members": [
{
"name": ".ctor",
@@ -99364,7 +102822,7 @@
"signature": "public PipelineSummary.PipelineSummary()",
"returnType": "void",
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineSummary.cs",
- "sourceLines": "60-61"
+ "sourceLines": "58-59"
},
{
"name": "Add",
@@ -99470,7 +102928,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineSummary.cs",
- "sourceLines": "71-75"
+ "sourceLines": "69-73"
}
]
},
@@ -99525,19 +102983,8 @@
]
}
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineSummaryItem.cs",
- "sourceLines": "16-16",
+ "sourceLines": "13-13",
"members": [
{
"name": ".ctor",
@@ -99604,7 +103051,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineSummaryItem.cs",
- "sourceLines": "16-32"
+ "sourceLines": "13-29"
},
{
"name": "EnableMarkdown",
@@ -99630,7 +103077,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineSummaryItem.cs",
- "sourceLines": "32-32"
+ "sourceLines": "29-29"
},
{
"name": "Key",
@@ -99648,7 +103095,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineSummaryItem.cs",
- "sourceLines": "21-21"
+ "sourceLines": "18-18"
},
{
"name": "Value",
@@ -99666,7 +103113,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Pipelines/PipelineSummaryItem.cs",
- "sourceLines": "26-26"
+ "sourceLines": "23-23"
}
]
},
@@ -99685,19 +103132,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/PublishCompletionOptions.cs",
- "sourceLines": "12-12",
+ "sourceLines": "9-9",
"members": [
{
"name": ".ctor",
@@ -99805,15 +103241,6 @@
]
},
"attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- },
{
"name": "Aspire.Hosting.AspireExportIgnoreAttribute",
"arguments": {
@@ -99822,7 +103249,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/Publishing/PublishingExtensions.cs",
- "sourceLines": "15-15",
+ "sourceLines": "10-10",
"members": [
{
"name": "FailAsync",
@@ -100693,19 +104120,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/WellKnownPipelineSteps.cs",
- "sourceLines": "12-12",
+ "sourceLines": "9-9",
"members": [
{
"name": "BeforeStart",
@@ -100979,19 +104395,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREPIPELINES001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting/Pipelines/WellKnownPipelineTags.cs",
- "sourceLines": "12-12",
+ "sourceLines": "9-9",
"members": [
{
"name": "BuildCompute",
@@ -102135,7 +105540,7 @@
}
],
"sourceFile": "src/Aspire.Hosting/Publishing/ResourceContainerImageManager.cs",
- "sourceLines": "104-104",
+ "sourceLines": "101-101",
"members": [
{
"name": ".ctor",
@@ -104292,7 +107697,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs",
- "sourceLines": "23-23",
+ "sourceLines": "25-25",
"members": [
{
"name": ".ctor",
@@ -104354,7 +107759,89 @@
}
},
"sourceFile": "src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs",
- "sourceLines": "23-55"
+ "sourceLines": "25-79"
+ },
+ {
+ "name": "GetManifestExpression",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public string ManifestPublishingContext.GetManifestExpression(IManifestExpressionProvider value)",
+ "returnType": "string",
+ "parameters": [
+ {
+ "name": "value",
+ "type": "Aspire.Hosting.ApplicationModel.IManifestExpressionProvider"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the manifest representation of a value, registering any generated values or required inputs. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Manifest callbacks should use this method rather than writing "
+ },
+ {
+ "kind": "cref",
+ "value": "P:Aspire.Hosting.ApplicationModel.IManifestExpressionProvider.ValueExpression"
+ },
+ {
+ "kind": "text",
+ "text": " directly when a value may require lowering. Opaque tokens from custom providers are preserved without concrete evaluation. Call "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.Publishing.ManifestPublishingContext.TryAddDependentResources(System.Object)"
+ },
+ {
+ "kind": "text",
+ "text": " to include its referenced resources. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The expression to write into the manifest."
+ }
+ ],
+ "parameters": {
+ "value": [
+ {
+ "kind": "text",
+ "text": "The symbolic value to represent in the manifest."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "paramref",
+ "value": "value"
+ },
+ {
+ "kind": "text",
+ "text": " is "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ]
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs",
+ "sourceLines": "789-790"
},
{
"name": "GetManifestRelativePath",
@@ -104404,7 +107891,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs",
- "sourceLines": "66-77"
+ "sourceLines": "90-101"
},
{
"name": "TryAddDependentResources",
@@ -104452,7 +107939,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs",
- "sourceLines": "677-705"
+ "sourceLines": "736-742"
},
{
"name": "WriteBindings",
@@ -104515,7 +108002,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs",
- "sourceLines": "499-535"
+ "sourceLines": "556-592"
},
{
"name": "WriteCommandLineArgumentsAsync",
@@ -104592,7 +108079,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs",
- "sourceLines": "581-608"
+ "sourceLines": "638-665"
},
{
"name": "WriteConnectionString",
@@ -104631,7 +108118,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs",
- "sourceLines": "483-489"
+ "sourceLines": "540-546"
},
{
"name": "WriteContainerAsync",
@@ -104681,7 +108168,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs",
- "sourceLines": "325-374"
+ "sourceLines": "382-431"
},
{
"name": "WriteEnvironmentVariablesAsync",
@@ -104744,7 +108231,7 @@
}
},
"sourceFile": "src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs",
- "sourceLines": "543-572"
+ "sourceLines": "600-629"
},
{
"name": "CancellationToken",
@@ -104762,7 +108249,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs",
- "sourceLines": "43-43"
+ "sourceLines": "45-45"
},
{
"name": "ExecutionContext",
@@ -104780,7 +108267,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs",
- "sourceLines": "28-28"
+ "sourceLines": "30-30"
},
{
"name": "ManifestPath",
@@ -104798,7 +108285,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs",
- "sourceLines": "33-33"
+ "sourceLines": "35-35"
},
{
"name": "Writer",
@@ -104816,7 +108303,7 @@
]
},
"sourceFile": "src/Aspire.Hosting/Publishing/ManifestPublishingContext.cs",
- "sourceLines": "38-38"
+ "sourceLines": "40-40"
}
]
},
diff --git a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.17.0.0.json
similarity index 93%
rename from src/frontend/src/data/pkgs/Aspire.Hosting.Azure.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Hosting.Azure.17.0.0.json
index d6851e79a0..a53fcdecf1 100644
--- a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Hosting.Azure",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
@@ -1720,7 +1720,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/Provisioning/AzureProvisionerExtensions.cs",
- "sourceLines": "29-82"
+ "sourceLines": "28-80"
}
]
},
@@ -2996,7 +2996,7 @@
},
"examples": [
{
- "code": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var keyVault = builder.AddAzureKeyVault(\"keyvault\")\n .RunAsExisting(\"kv-dev-secrets\", \"rg-keyvault\")\n .ClearDefaultRoleAssignments();\n \n var api = builder.AddProject(\"api\")\n .WithReference(keyVault);\n ",
+ "code": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var keyVault = builder.AddAzureKeyVault(\"keyvault\")\n .RunAsExisting(\"kv-dev-secrets\", \"rg-keyvault\")\n .ClearDefaultRoleAssignments();\n \n var api = builder.AddDotnetProject(\"api\", \"../Api/Api.csproj\")\n .WithReference(keyVault);\n ",
"language": "csharp",
"description": [
{
@@ -3204,6 +3204,12 @@
"text": " Marks the resource as an existing resource in both run and publish modes. "
}
],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Aspire references the existing Azure resource instead of provisioning a new resource. "
+ }
+ ],
"returns": [
{
"kind": "text",
@@ -3248,7 +3254,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "162-164"
+ "sourceLines": "168-170"
},
{
"name": "AsExistingInResourceGroup",
@@ -3342,7 +3348,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "492-494"
+ "sourceLines": "503-505"
},
{
"name": "AsExistingInResourceGroup",
@@ -3436,7 +3442,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "510-512"
+ "sourceLines": "522-524"
},
{
"name": "AsExistingInSubscription",
@@ -3534,7 +3540,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "315-317"
+ "sourceLines": "322-324"
},
{
"name": "AsExistingInSubscription",
@@ -3632,7 +3638,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "333-335"
+ "sourceLines": "340-342"
},
{
"name": "AsExistingInTenant",
@@ -3720,7 +3726,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "655-657"
+ "sourceLines": "668-670"
},
{
"name": "AsExistingInTenant",
@@ -3808,7 +3814,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "672-674"
+ "sourceLines": "685-687"
},
{
"name": "IsExisting",
@@ -3955,7 +3961,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "107-109"
+ "sourceLines": "108-110"
},
{
"name": "PublishAsExisting",
@@ -4048,7 +4054,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "124-126"
+ "sourceLines": "126-128"
},
{
"name": "PublishAsExistingInResourceGroup",
@@ -4142,7 +4148,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "432-434"
+ "sourceLines": "440-442"
},
{
"name": "PublishAsExistingInResourceGroup",
@@ -4236,7 +4242,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "450-452"
+ "sourceLines": "459-461"
},
{
"name": "PublishAsExistingInSubscription",
@@ -4334,7 +4340,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "258-260"
+ "sourceLines": "265-267"
},
{
"name": "PublishAsExistingInSubscription",
@@ -4432,7 +4438,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "276-278"
+ "sourceLines": "283-285"
},
{
"name": "PublishAsExistingInTenant",
@@ -4520,7 +4526,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "603-605"
+ "sourceLines": "616-618"
},
{
"name": "PublishAsExistingInTenant",
@@ -4608,7 +4614,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "620-622"
+ "sourceLines": "633-635"
},
{
"name": "RunAsExisting",
@@ -4888,7 +4894,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "372-374"
+ "sourceLines": "379-381"
},
{
"name": "RunAsExistingInResourceGroup",
@@ -4982,7 +4988,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "390-392"
+ "sourceLines": "397-399"
},
{
"name": "RunAsExistingInSubscription",
@@ -5080,7 +5086,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "201-203"
+ "sourceLines": "208-210"
},
{
"name": "RunAsExistingInSubscription",
@@ -5178,7 +5184,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "219-221"
+ "sourceLines": "226-228"
},
{
"name": "RunAsExistingInTenant",
@@ -5266,7 +5272,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "551-553"
+ "sourceLines": "564-566"
},
{
"name": "RunAsExistingInTenant",
@@ -5354,7 +5360,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/ExistingAzureResourceExtensions.cs",
- "sourceLines": "568-570"
+ "sourceLines": "581-583"
}
]
},
@@ -5626,7 +5632,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "25-25",
+ "sourceLines": "21-21",
"members": [
{
"name": ".ctor",
@@ -5701,7 +5707,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "34-127"
+ "sourceLines": "30-125"
},
{
"name": "GetBicepTemplateFile",
@@ -5774,7 +5780,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "159-197"
+ "sourceLines": "157-195"
},
{
"name": "GetBicepTemplateString",
@@ -5792,7 +5798,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "205-225"
+ "sourceLines": "203-223"
},
{
"name": "WriteToManifest",
@@ -5832,7 +5838,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "233-295"
+ "sourceLines": "231-293"
},
{
"name": "Outputs",
@@ -5850,7 +5856,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "122-122"
+ "sourceLines": "120-120"
},
{
"name": "Parameters",
@@ -5868,7 +5874,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "110-110"
+ "sourceLines": "108-108"
},
{
"name": "ProvisioningTaskCompletionSource",
@@ -5905,7 +5911,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "115-115"
+ "sourceLines": "113-113"
},
{
"name": "Scope",
@@ -5948,7 +5954,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "127-127"
+ "sourceLines": "125-125"
}
]
},
@@ -6581,19 +6587,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREAZURE001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics#{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting.Azure/AzureEnvironmentResource.cs",
- "sourceLines": "26-26",
+ "sourceLines": "23-23",
"members": [
{
"name": ".ctor",
@@ -6682,7 +6677,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureEnvironmentResource.cs",
- "sourceLines": "63-162"
+ "sourceLines": "60-163"
},
{
"name": "PrepareResourcesStepName",
@@ -6792,7 +6787,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureEnvironmentResourceExtensions.cs",
- "sourceLines": "16-16",
+ "sourceLines": "13-13",
"members": [
{
"name": "AddAzureEnvironment",
@@ -6812,15 +6807,6 @@
"attributes": [
{
"name": "Aspire.Hosting.AspireExportAttribute"
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREAZURE001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"docs": {
@@ -6862,7 +6848,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureEnvironmentResourceExtensions.cs",
- "sourceLines": "28-90"
+ "sourceLines": "24-86"
},
{
"name": "WithLocation",
@@ -6886,15 +6872,6 @@
"attributes": [
{
"name": "Aspire.Hosting.AspireExportAttribute"
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREAZURE001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"docs": {
@@ -6948,7 +6925,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureEnvironmentResourceExtensions.cs",
- "sourceLines": "118-123"
+ "sourceLines": "113-118"
},
{
"name": "WithResourceGroup",
@@ -6972,15 +6949,6 @@
"attributes": [
{
"name": "Aspire.Hosting.AspireExportAttribute"
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREAZURE001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"docs": {
@@ -7034,7 +7002,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureEnvironmentResourceExtensions.cs",
- "sourceLines": "143-148"
+ "sourceLines": "137-142"
}
]
},
@@ -7183,7 +7151,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureProvisioningResource.cs",
- "sourceLines": "18-18",
+ "sourceLines": "21-21",
"members": [
{
"name": ".ctor",
@@ -7224,7 +7192,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureProvisioningResource.cs",
- "sourceLines": "19-24"
+ "sourceLines": "22-39"
},
{
"name": "AddAsExistingResource",
@@ -7310,7 +7278,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureProvisioningResource.cs",
- "sourceLines": "38-38"
+ "sourceLines": "53-53"
},
{
"name": "AddRoleAssignments",
@@ -7342,7 +7310,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureProvisioningResource.cs",
- "sourceLines": "46-61"
+ "sourceLines": "61-76"
},
{
"name": "CreateExistingOrNewProvisionableResource",
@@ -7456,7 +7424,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureProvisioningResource.cs",
- "sourceLines": "128-151"
+ "sourceLines": "167-191"
},
{
"name": "GetBicepTemplateFile",
@@ -7529,7 +7497,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureProvisioningResource.cs",
- "sourceLines": "81-99"
+ "sourceLines": "96-138"
},
{
"name": "GetBicepTemplateString",
@@ -7547,7 +7515,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureProvisioningResource.cs",
- "sourceLines": "107-113"
+ "sourceLines": "146-152"
},
{
"name": "TryApplyExistingResourceAnnotation",
@@ -7687,7 +7655,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureProvisioningResource.cs",
- "sourceLines": "169-195"
+ "sourceLines": "209-252"
},
{
"name": "ConfigureInfrastructure",
@@ -7756,19 +7724,8 @@
}
]
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREAZURE001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting.Azure/AzurePublishingContext.cs",
- "sourceLines": "28-28",
+ "sourceLines": "25-25",
"members": [
{
"name": ".ctor",
@@ -7813,7 +7770,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzurePublishingContext.cs",
- "sourceLines": "28-94"
+ "sourceLines": "25-91"
},
{
"name": "WriteModelAsync",
@@ -7871,7 +7828,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzurePublishingContext.cs",
- "sourceLines": "105-134"
+ "sourceLines": "102-131"
},
{
"name": "ExcludeMainBicepFile",
@@ -8007,7 +7964,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzurePublishingContext.cs",
- "sourceLines": "44-44"
+ "sourceLines": "41-41"
},
{
"name": "OutputLookup",
@@ -8055,7 +8012,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzurePublishingContext.cs",
- "sourceLines": "85-85"
+ "sourceLines": "82-82"
},
{
"name": "ParameterLookup",
@@ -8103,7 +8060,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzurePublishingContext.cs",
- "sourceLines": "76-76"
+ "sourceLines": "73-73"
}
]
},
@@ -8140,7 +8097,7 @@
}
],
"sourceFile": "src/Aspire.Hosting.Azure/AzureResourceInfrastructure.cs",
- "sourceLines": "14-14",
+ "sourceLines": "15-15",
"members": [
{
"name": "AspireResource",
@@ -8174,7 +8131,79 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureResourceInfrastructure.cs",
- "sourceLines": "33-33"
+ "sourceLines": "34-34"
+ },
+ {
+ "name": "BicepExtensions",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public Dictionary AzureResourceInfrastructure.BicepExtensions",
+ "returnType": "System.Collections.Generic.Dictionary",
+ "hasGet": true,
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "Bicep extension declarations are configured through C# infrastructure callbacks."
+ }
+ },
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREAZURE004"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the Bicep extension declarations for this infrastructure, keyed by namespace alias. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Each value is an extension reference, such as "
+ },
+ {
+ "kind": "code",
+ "text": "br:mcr.microsoft.com/bicep/extensions/microsoftgraph/v1.0:1.0.0"
+ },
+ {
+ "kind": "text",
+ "text": ". Inline references keep generated modules independent of a "
+ },
+ {
+ "kind": "code",
+ "text": "bicepconfig.json"
+ },
+ {
+ "kind": "text",
+ "text": " file. This experimental API works around the lack of native extension support in Azure.Provisioning. See "
+ },
+ {
+ "kind": "href",
+ "text": "the Azure SDK feature request",
+ "value": "https://github.com/Azure/azure-sdk-for-net/issues/63848"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n builder.AddAzureInfrastructure(\"graph\", infrastructure =>\n {\n infrastructure.BicepExtensions[\"microsoftGraphV1\"] =\n \"br:mcr.microsoft.com/bicep/extensions/microsoftgraph/v1.0:1.0.0\";\n });\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure/AzureResourceInfrastructure.cs",
+ "sourceLines": "57-57"
}
]
},
@@ -8236,7 +8265,15 @@
},
{
"kind": "text",
- "text": ", the role assignments are global and are granted to the deployment principal. "
+ "text": ", the principal is supplied by "
+ },
+ {
+ "kind": "paramref",
+ "value": "configureInfrastructure"
+ },
+ {
+ "kind": "text",
+ "text": ", for example the deployment principal or an externally owned identity. "
}
],
"parameters": {
@@ -8257,7 +8294,7 @@
},
{
"kind": "text",
- "text": " for global role assignments granted to the deployment principal."
+ "text": " when the principal is supplied by the infrastructure callback."
}
],
"name": [
@@ -8277,7 +8314,7 @@
},
{
"kind": "text",
- "text": " for global role assignments granted to the deployment principal."
+ "text": " when the principal is supplied by the infrastructure callback."
}
],
"targetAzureResource": [
@@ -8288,19 +8325,8 @@
]
}
},
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREAZURE003"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"sourceFile": "src/Aspire.Hosting.Azure/AzureRoleAssignmentResource.cs",
- "sourceLines": "24-24",
+ "sourceLines": "22-22",
"members": [
{
"name": ".ctor",
@@ -8382,7 +8408,15 @@
},
{
"kind": "text",
- "text": ", the role assignments are global and are granted to the deployment principal. "
+ "text": ", the principal is supplied by "
+ },
+ {
+ "kind": "paramref",
+ "value": "configureInfrastructure"
+ },
+ {
+ "kind": "text",
+ "text": ", for example the deployment principal or an externally owned identity. "
}
],
"parameters": {
@@ -8403,7 +8437,7 @@
},
{
"kind": "text",
- "text": " for global role assignments granted to the deployment principal."
+ "text": " when the principal is supplied by the infrastructure callback."
}
],
"name": [
@@ -8423,7 +8457,7 @@
},
{
"kind": "text",
- "text": " for global role assignments granted to the deployment principal."
+ "text": " when the principal is supplied by the infrastructure callback."
}
],
"targetAzureResource": [
@@ -8435,7 +8469,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureRoleAssignmentResource.cs",
- "sourceLines": "30-53"
+ "sourceLines": "28-51"
},
{
"name": "IdentityResource",
@@ -8457,12 +8491,12 @@
},
{
"kind": "text",
- "text": " for global role assignments that are granted to the deployment principal. "
+ "text": " when the principal is supplied by the infrastructure callback. "
}
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureRoleAssignmentResource.cs",
- "sourceLines": "53-53"
+ "sourceLines": "51-51"
},
{
"name": "OwnerResource",
@@ -8484,7 +8518,7 @@
},
{
"kind": "text",
- "text": " for global role assignments that are granted to the deployment principal. "
+ "text": " when the principal is supplied by the infrastructure callback. "
}
],
"remarks": [
@@ -8527,7 +8561,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureRoleAssignmentResource.cs",
- "sourceLines": "47-47"
+ "sourceLines": "45-45"
},
{
"name": "TargetAzureResource",
@@ -8545,7 +8579,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureRoleAssignmentResource.cs",
- "sourceLines": "35-35"
+ "sourceLines": "33-33"
}
]
},
@@ -8886,7 +8920,7 @@
},
"examples": [
{
- "code": "\n var identity = builder.AddAzureUserAssignedIdentity(\"myIdentity\");\n var app = builder.AddProject(\"myApp\")\n .WithAzureUserAssignedIdentity(identity);\n ",
+ "code": "\n var identity = builder.AddAzureUserAssignedIdentity(\"myIdentity\");\n var app = builder.AddDotnetProject(\"myApp\", \"../MyApp/MyApp.csproj\")\n .WithAzureUserAssignedIdentity(identity);\n ",
"language": "csharp"
}
]
@@ -9172,7 +9206,7 @@
}
],
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "580-580",
+ "sourceLines": "588-588",
"members": [
{
"name": ".ctor",
@@ -9221,7 +9255,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "580-590"
+ "sourceLines": "588-598"
},
{
"name": "GetHashCode",
@@ -9245,7 +9279,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "637-637"
+ "sourceLines": "645-645"
},
{
"name": "GetValueAsync",
@@ -9285,7 +9319,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "600-607"
+ "sourceLines": "608-615"
},
{
"name": "Name",
@@ -9303,7 +9337,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "585-585"
+ "sourceLines": "593-593"
},
{
"name": "Resource",
@@ -9321,7 +9355,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "590-590"
+ "sourceLines": "598-598"
},
{
"name": "Value",
@@ -9340,7 +9374,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "616-621"
+ "sourceLines": "624-629"
},
{
"name": "ValueExpression",
@@ -9358,7 +9392,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "628-628"
+ "sourceLines": "636-636"
}
]
},
@@ -9414,7 +9448,7 @@
}
],
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "525-525",
+ "sourceLines": "533-533",
"members": [
{
"name": ".ctor",
@@ -9463,7 +9497,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "525-535"
+ "sourceLines": "533-543"
},
{
"name": "GetValueAsync",
@@ -9503,7 +9537,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "543-549"
+ "sourceLines": "551-557"
},
{
"name": "Name",
@@ -9521,7 +9555,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "530-530"
+ "sourceLines": "538-538"
},
{
"name": "Resource",
@@ -9539,7 +9573,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "535-535"
+ "sourceLines": "543-543"
},
{
"name": "Value",
@@ -9558,7 +9592,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "558-562"
+ "sourceLines": "566-570"
},
{
"name": "ValueExpression",
@@ -9576,7 +9610,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "569-569"
+ "sourceLines": "577-577"
}
]
},
@@ -9614,7 +9648,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "500-500",
+ "sourceLines": "508-508",
"members": [
{
"name": ".ctor",
@@ -9655,7 +9689,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "505-505"
+ "sourceLines": "513-513"
},
{
"name": "Dispose",
@@ -9680,7 +9714,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "512-516"
+ "sourceLines": "520-524"
},
{
"name": "Path",
@@ -9698,7 +9732,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "505-505"
+ "sourceLines": "513-513"
}
]
},
@@ -10505,8 +10539,8 @@
]
},
{
- "name": "IAzureComputeEnvironmentResource",
- "fullName": "Aspire.Hosting.Azure.IAzureComputeEnvironmentResource",
+ "name": "IAzureCdnPrivateLinkTarget",
+ "fullName": "Aspire.Hosting.Azure.IAzureCdnPrivateLinkTarget",
"namespace": "Aspire.Hosting.Azure",
"kind": "interface",
"accessibility": "public",
@@ -10518,95 +10552,298 @@
"summary": [
{
"kind": "text",
- "text": " Represents an Azure compute environment resource. "
+ "text": " Represents a compute environment that an Azure CDN profile, such as Azure Front Door, can reach over Private Link. "
}
- ]
- },
- "sourceFile": "src/Aspire.Hosting.Azure/IAzureComputeEnvironmentResource.cs",
- "sourceLines": "11-11",
- "members": [
- {
- "name": "ContainerRegistry",
- "kind": "property",
- "accessibility": "public",
- "signature": "public virtual IAzureContainerRegistryResource? IAzureComputeEnvironmentResource.ContainerRegistry",
- "returnType": "Aspire.Hosting.Azure.IAzureContainerRegistryResource?",
- "isReturnNullable": true,
- "isVirtual": true,
- "hasGet": true,
- "docs": {
- "summary": [
+ ],
+ "remarks": [
+ {
+ "kind": "para",
+ "children": [
{
"kind": "text",
- "text": " Gets the Azure Container Registry resource used by this compute environment. "
+ "text": " Implement this interface on a compute environment that can supply the Azure resource a CDN profile's managed private endpoint connects to, such as an Azure Container Apps environment or an individual App Service website. When "
+ },
+ {
+ "kind": "code",
+ "text": "WithAzureFrontDoorPrivateLink"
+ },
+ {
+ "kind": "text",
+ "text": " connects an Azure Front Door to the environment, every Front Door origin that runs in the environment becomes a Private Link origin that targets "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.Azure.IAzureCdnPrivateLinkTarget.GetPrivateLinkResourceId(Aspire.Hosting.ApplicationModel.IResource)"
+ },
+ {
+ "kind": "text",
+ "text": ". "
}
]
},
- "sourceFile": "src/Aspire.Hosting.Azure/IAzureComputeEnvironmentResource.cs",
- "sourceLines": "16-16"
- }
- ]
- },
- {
- "name": "IAzureContainerRegistry",
- "fullName": "Aspire.Hosting.Azure.IAzureContainerRegistry",
- "namespace": "Aspire.Hosting.Azure",
- "kind": "interface",
- "accessibility": "public",
- "interfaces": [
- "Aspire.Hosting.ApplicationModel.IContainerRegistry"
- ],
- "docs": {
- "summary": [
{
- "kind": "text",
- "text": " Represents Azure Container Registry information for deployment targets. "
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " The connecting profile adds a "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.Azure.PrivateEndpointTargetAnnotation"
+ },
+ {
+ "kind": "text",
+ "text": " to the environment, as for a private endpoint to any other Azure resource. The implementation should react to that annotation by disabling public network access. The outputs returned by this interface must exist when Private Link is configured. "
+ }
+ ]
}
]
},
"attributes": [
{
- "name": "System.ObsoleteAttribute",
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
"constructorArguments": [
- "Use IAzureContainerRegistryResource instead and access container registry through IAzureComputeEnvironmentResource.ContainerRegistry property."
- ]
+ "ASPIREAZURE003"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics#{0}"
+ }
}
],
- "sourceFile": "src/Aspire.Hosting.Azure/IAzureContainerRegistry.cs",
- "sourceLines": "12-12",
+ "sourceFile": "src/Aspire.Hosting.Azure/IAzureCdnPrivateLinkTarget.cs",
+ "sourceLines": "26-26",
"members": [
{
- "name": "ManagedIdentityId",
- "kind": "property",
+ "name": "GetPrivateLinkLocation",
+ "kind": "method",
"accessibility": "public",
- "signature": "public abstract ReferenceExpression IAzureContainerRegistry.ManagedIdentityId",
- "returnType": "Aspire.Hosting.ApplicationModel.ReferenceExpression",
+ "signature": "public abstract BicepOutputReference IAzureCdnPrivateLinkTarget.GetPrivateLinkLocation(IResource origin)",
+ "returnType": "Aspire.Hosting.Azure.BicepOutputReference",
"isAbstract": true,
- "hasGet": true,
+ "parameters": [
+ {
+ "name": "origin",
+ "type": "Aspire.Hosting.ApplicationModel.IResource"
+ }
+ ],
"docs": {
"summary": [
{
"kind": "text",
- "text": " Gets the managed identity ID associated with the container registry. "
+ "text": " Gets the region output reference for the Azure resource that the CDN profile connects to for an origin. "
}
- ]
- }
- }
- ]
- },
- {
- "name": "IAzureContainerRegistryResource",
- "fullName": "Aspire.Hosting.Azure.IAzureContainerRegistryResource",
- "namespace": "Aspire.Hosting.Azure",
- "kind": "interface",
- "accessibility": "public",
- "interfaces": [
- "Aspire.Hosting.ApplicationModel.IAzureResource",
- "Aspire.Hosting.ApplicationModel.IContainerRegistry",
- "Aspire.Hosting.ApplicationModel.IResource"
- ],
- "docs": {
- "summary": [
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " The output must be the programmatic region name of the resource, in lowercase without spaces, such as "
+ },
+ {
+ "kind": "code",
+ "text": "westus2"
+ },
+ {
+ "kind": "text",
+ "text": ", not a display name such as "
+ },
+ {
+ "kind": "code",
+ "text": "West US 2"
+ },
+ {
+ "kind": "text",
+ "text": ". The CDN profile creates its private endpoint in this region, or in a nearby supported region when the CDN doesn't offer Private Link in this one. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The Azure region of the Private Link target."
+ }
+ ],
+ "parameters": {
+ "origin": [
+ {
+ "kind": "text",
+ "text": "The compute resource added as an origin to the CDN profile."
+ }
+ ]
+ }
+ }
+ },
+ {
+ "name": "GetPrivateLinkResourceId",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public abstract BicepOutputReference IAzureCdnPrivateLinkTarget.GetPrivateLinkResourceId(IResource origin)",
+ "returnType": "Aspire.Hosting.Azure.BicepOutputReference",
+ "isAbstract": true,
+ "parameters": [
+ {
+ "name": "origin",
+ "type": "Aspire.Hosting.ApplicationModel.IResource"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the resource ID output reference for the Azure resource that the CDN profile connects to for an origin. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Container Apps origins share their environment's private endpoint. App Service origins each require a private endpoint to their own website, rather than to the App Service plan. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The resource ID of the Private Link target, not necessarily the compute environment itself."
+ }
+ ],
+ "parameters": {
+ "origin": [
+ {
+ "kind": "text",
+ "text": "The compute resource added as an origin to the CDN profile."
+ }
+ ]
+ }
+ }
+ },
+ {
+ "name": "PrivateLinkGroupId",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public abstract string IAzureCdnPrivateLinkTarget.PrivateLinkGroupId",
+ "returnType": "string",
+ "isAbstract": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the sub-resource (group ID) of the Azure resource that the CDN profile connects to, such as "
+ },
+ {
+ "kind": "code",
+ "text": "managedEnvironments"
+ },
+ {
+ "kind": "text",
+ "text": " for an Azure Container Apps environment. "
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "name": "IAzureComputeEnvironmentResource",
+ "fullName": "Aspire.Hosting.Azure.IAzureComputeEnvironmentResource",
+ "namespace": "Aspire.Hosting.Azure",
+ "kind": "interface",
+ "accessibility": "public",
+ "interfaces": [
+ "Aspire.Hosting.ApplicationModel.IComputeEnvironmentResource",
+ "Aspire.Hosting.ApplicationModel.IResource"
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Represents an Azure compute environment resource. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure/IAzureComputeEnvironmentResource.cs",
+ "sourceLines": "11-11",
+ "members": [
+ {
+ "name": "ContainerRegistry",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public virtual IAzureContainerRegistryResource? IAzureComputeEnvironmentResource.ContainerRegistry",
+ "returnType": "Aspire.Hosting.Azure.IAzureContainerRegistryResource?",
+ "isReturnNullable": true,
+ "isVirtual": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the Azure Container Registry resource used by this compute environment. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure/IAzureComputeEnvironmentResource.cs",
+ "sourceLines": "16-16"
+ }
+ ]
+ },
+ {
+ "name": "IAzureContainerRegistry",
+ "fullName": "Aspire.Hosting.Azure.IAzureContainerRegistry",
+ "namespace": "Aspire.Hosting.Azure",
+ "kind": "interface",
+ "accessibility": "public",
+ "interfaces": [
+ "Aspire.Hosting.ApplicationModel.IContainerRegistry"
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Represents Azure Container Registry information for deployment targets. "
+ }
+ ]
+ },
+ "attributes": [
+ {
+ "name": "System.ObsoleteAttribute",
+ "constructorArguments": [
+ "Use IAzureContainerRegistryResource instead and access container registry through IAzureComputeEnvironmentResource.ContainerRegistry property."
+ ]
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting.Azure/IAzureContainerRegistry.cs",
+ "sourceLines": "12-12",
+ "members": [
+ {
+ "name": "ManagedIdentityId",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public abstract ReferenceExpression IAzureContainerRegistry.ManagedIdentityId",
+ "returnType": "Aspire.Hosting.ApplicationModel.ReferenceExpression",
+ "isAbstract": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the managed identity ID associated with the container registry. "
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "name": "IAzureContainerRegistryResource",
+ "fullName": "Aspire.Hosting.Azure.IAzureContainerRegistryResource",
+ "namespace": "Aspire.Hosting.Azure",
+ "kind": "interface",
+ "accessibility": "public",
+ "interfaces": [
+ "Aspire.Hosting.ApplicationModel.IAzureResource",
+ "Aspire.Hosting.ApplicationModel.IContainerRegistry",
+ "Aspire.Hosting.ApplicationModel.IResource"
+ ],
+ "docs": {
+ "summary": [
{
"kind": "text",
"text": " Represents an Azure Container Registry resource. "
@@ -10667,6 +10904,102 @@
}
]
},
+ {
+ "name": "IAzureInternalIngressResource",
+ "fullName": "Aspire.Hosting.Azure.IAzureInternalIngressResource",
+ "namespace": "Aspire.Hosting.Azure",
+ "kind": "interface",
+ "accessibility": "public",
+ "interfaces": [
+ "Aspire.Hosting.ApplicationModel.IResource",
+ "Aspire.Hosting.Azure.IAzureDelegatedSubnetResource"
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Represents an Azure resource that supports an internal load balancer and a private DNS zone. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Implementations apply "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.Azure.InternalLoadBalancerAnnotation"
+ },
+ {
+ "kind": "text",
+ "text": " when provisioning and expose the resulting domain and IP address so the network integration can configure private DNS. The domain and static IP references are intended for internal environments configured with that annotation, not for unsupported configurations such as Azure Container Apps Express. "
+ }
+ ]
+ },
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREAZURE003"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics#{0}"
+ }
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting.Azure/IAzureInternalIngressResource.cs",
+ "sourceLines": "19-19",
+ "members": [
+ {
+ "name": "DefaultDomain",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public abstract ReferenceExpression IAzureInternalIngressResource.DefaultDomain",
+ "returnType": "Aspire.Hosting.ApplicationModel.ReferenceExpression",
+ "isAbstract": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default domain used as the private DNS zone name. "
+ }
+ ]
+ }
+ },
+ {
+ "name": "StaticIp",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public abstract ReferenceExpression IAzureInternalIngressResource.StaticIp",
+ "returnType": "Aspire.Hosting.ApplicationModel.ReferenceExpression",
+ "isAbstract": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the internal load balancer's static IP address. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Valid only when the resource is configured with "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.Azure.InternalLoadBalancerAnnotation"
+ },
+ {
+ "kind": "text",
+ "text": " and supports internal networking. The backing output need not exist for other configurations. "
+ }
+ ]
+ }
+ }
+ ]
+ },
{
"name": "IAzureKeyVaultResource",
"fullName": "Aspire.Hosting.Azure.IAzureKeyVaultResource",
@@ -10961,7 +11294,184 @@
"summary": [
{
"kind": "text",
- "text": " Gets the \"id\" output reference from the Azure resource. "
+ "text": " Gets the \"id\" output reference from the Azure resource. "
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "name": "IAzurePrivateEndpointTarget",
+ "fullName": "Aspire.Hosting.Azure.IAzurePrivateEndpointTarget",
+ "namespace": "Aspire.Hosting.Azure",
+ "kind": "interface",
+ "accessibility": "public",
+ "interfaces": [
+ "Aspire.Hosting.ApplicationModel.IResource"
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Represents an Azure resource that can be connected to via a private endpoint. "
+ }
+ ]
+ },
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREAZURE003"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics#{0}"
+ }
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting.Azure/IAzurePrivateEndpointTarget.cs",
+ "sourceLines": "13-13",
+ "members": [
+ {
+ "name": "GetPrivateDnsZoneNames",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public abstract IEnumerable IAzurePrivateEndpointTarget.GetPrivateDnsZoneNames()",
+ "returnType": "System.Collections.Generic.IEnumerable",
+ "isAbstract": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the private DNS zone names for this resource type (e.g., \"privatelink.blob.core.windows.net\" for blob storage). "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A collection of private DNS zone names for the private endpoint."
+ }
+ ]
+ }
+ },
+ {
+ "name": "GetPrivateLinkGroupIds",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public abstract IEnumerable IAzurePrivateEndpointTarget.GetPrivateLinkGroupIds()",
+ "returnType": "System.Collections.Generic.IEnumerable",
+ "isAbstract": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the group IDs for the private link service connection (e.g., \"blob\", \"file\" for storage). "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A collection of group IDs for the private link service connection."
+ }
+ ]
+ }
+ },
+ {
+ "name": "Id",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public abstract BicepOutputReference IAzurePrivateEndpointTarget.Id",
+ "returnType": "Aspire.Hosting.Azure.BicepOutputReference",
+ "isAbstract": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the \"id\" output reference from the Azure resource. "
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "name": "IBicepOutputReferenceProvider",
+ "fullName": "Aspire.Hosting.Azure.IBicepOutputReferenceProvider",
+ "namespace": "Aspire.Hosting.Azure",
+ "kind": "interface",
+ "accessibility": "public",
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Represents a value that is published as a "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.Azure.BicepOutputReference"
+ },
+ {
+ "kind": "text",
+ "text": ", but whose output is not known when the value is created. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Azure publishers treat a value that implements this interface as the output it returns, as if the value were that "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.Azure.BicepOutputReference"
+ },
+ {
+ "kind": "text",
+ "text": " itself. This lets a value, such as a client ID of an identity that is created while the application model is prepared for publishing, be handed out before the output exists. "
+ }
+ ]
+ },
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREAZURE005"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting.Azure/IBicepOutputReferenceProvider.cs",
+ "sourceLines": "18-18",
+ "members": [
+ {
+ "name": "GetOutputReference",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public abstract BicepOutputReference? IBicepOutputReferenceProvider.GetOutputReference()",
+ "returnType": "Aspire.Hosting.Azure.BicepOutputReference?",
+ "isReturnNullable": true,
+ "isAbstract": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the output that this value is published as. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The output, or "
+ },
+ {
+ "kind": "langword",
+ "value": "null"
+ },
+ {
+ "kind": "text",
+ "text": " if it is not available yet."
}
]
}
@@ -10969,21 +11479,30 @@
]
},
{
- "name": "IAzurePrivateEndpointTarget",
- "fullName": "Aspire.Hosting.Azure.IAzurePrivateEndpointTarget",
+ "name": "InternalLoadBalancerAnnotation",
+ "fullName": "Aspire.Hosting.Azure.InternalLoadBalancerAnnotation",
"namespace": "Aspire.Hosting.Azure",
- "kind": "interface",
+ "kind": "class",
"accessibility": "public",
+ "isSealed": true,
"interfaces": [
- "Aspire.Hosting.ApplicationModel.IResource"
+ "Aspire.Hosting.ApplicationModel.IResourceAnnotation"
],
"docs": {
"summary": [
{
"kind": "text",
- "text": " Represents an Azure resource that can be connected to via a private endpoint. "
+ "text": " Configures an internal load balancer whose private DNS zone is linked to a virtual network. "
}
- ]
+ ],
+ "parameters": {
+ "virtualNetwork": [
+ {
+ "kind": "text",
+ "text": "The virtual network containing the resource's delegated subnet."
+ }
+ ]
+ }
},
"attributes": [
{
@@ -10996,69 +11515,57 @@
}
}
],
- "sourceFile": "src/Aspire.Hosting.Azure/IAzurePrivateEndpointTarget.cs",
- "sourceLines": "13-13",
+ "sourceFile": "src/Aspire.Hosting.Azure/InternalLoadBalancerAnnotation.cs",
+ "sourceLines": "14-14",
"members": [
{
- "name": "GetPrivateDnsZoneNames",
- "kind": "method",
- "accessibility": "public",
- "signature": "public abstract IEnumerable IAzurePrivateEndpointTarget.GetPrivateDnsZoneNames()",
- "returnType": "System.Collections.Generic.IEnumerable",
- "isAbstract": true,
- "docs": {
- "summary": [
- {
- "kind": "text",
- "text": " Gets the private DNS zone names for this resource type (e.g., \"privatelink.blob.core.windows.net\" for blob storage). "
- }
- ],
- "returns": [
- {
- "kind": "text",
- "text": "A collection of private DNS zone names for the private endpoint."
- }
- ]
- }
- },
- {
- "name": "GetPrivateLinkGroupIds",
- "kind": "method",
+ "name": ".ctor",
+ "kind": "constructor",
"accessibility": "public",
- "signature": "public abstract IEnumerable IAzurePrivateEndpointTarget.GetPrivateLinkGroupIds()",
- "returnType": "System.Collections.Generic.IEnumerable",
- "isAbstract": true,
+ "signature": "public InternalLoadBalancerAnnotation.InternalLoadBalancerAnnotation(IAzureResource virtualNetwork)",
+ "returnType": "void",
+ "parameters": [
+ {
+ "name": "virtualNetwork",
+ "type": "Aspire.Hosting.ApplicationModel.IAzureResource"
+ }
+ ],
"docs": {
"summary": [
{
"kind": "text",
- "text": " Gets the group IDs for the private link service connection (e.g., \"blob\", \"file\" for storage). "
+ "text": " Configures an internal load balancer whose private DNS zone is linked to a virtual network. "
}
],
- "returns": [
- {
- "kind": "text",
- "text": "A collection of group IDs for the private link service connection."
- }
- ]
- }
+ "parameters": {
+ "virtualNetwork": [
+ {
+ "kind": "text",
+ "text": "The virtual network containing the resource's delegated subnet."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure/InternalLoadBalancerAnnotation.cs",
+ "sourceLines": "14-19"
},
{
- "name": "Id",
+ "name": "VirtualNetwork",
"kind": "property",
"accessibility": "public",
- "signature": "public abstract BicepOutputReference IAzurePrivateEndpointTarget.Id",
- "returnType": "Aspire.Hosting.Azure.BicepOutputReference",
- "isAbstract": true,
+ "signature": "public IAzureResource InternalLoadBalancerAnnotation.VirtualNetwork",
+ "returnType": "Aspire.Hosting.ApplicationModel.IAzureResource",
"hasGet": true,
"docs": {
"summary": [
{
"kind": "text",
- "text": " Gets the \"id\" output reference from the Azure resource. "
+ "text": " Gets the virtual network linked to the private DNS zone. "
}
]
- }
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure/InternalLoadBalancerAnnotation.cs",
+ "sourceLines": "19-19"
}
]
},
@@ -11439,7 +11946,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs",
- "sourceLines": "407-407",
+ "sourceLines": "405-405",
"members": [
{
"name": "KeyVaultName",
@@ -11565,6 +12072,38 @@
},
"sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs"
},
+ {
+ "name": "TenantResourceSuffix",
+ "kind": "field",
+ "accessibility": "public",
+ "signature": "public static readonly string KnownParameters.TenantResourceSuffix",
+ "returnType": "string",
+ "isStatic": true,
+ "isReadOnly": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " The optional suffix used to distinguish tenant-wide resources created by this application. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Local provisioning resolves this value from "
+ },
+ {
+ "kind": "code",
+ "text": "Azure:TenantResourceSuffix"
+ },
+ {
+ "kind": "text",
+ "text": " and saved Azure context. Published templates expose it as a deployment parameter. An empty value leaves resource names unchanged. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure/AzureBicepResource.cs"
+ },
{
"name": "UserPrincipalId",
"kind": "field",
@@ -11591,6 +12130,69 @@
}
]
},
+ {
+ "name": "ManagedIdentityRequiredAnnotation",
+ "fullName": "Aspire.Hosting.Azure.ManagedIdentityRequiredAnnotation",
+ "namespace": "Aspire.Hosting.Azure",
+ "kind": "class",
+ "accessibility": "public",
+ "isSealed": true,
+ "interfaces": [
+ "Aspire.Hosting.ApplicationModel.IResourceAnnotation"
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Indicates that a compute resource needs a user-assigned managed identity when it is published, even if it has no Azure role assignments. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Resources that reference Azure resources get a managed identity so that role assignments can be applied to it. Some integrations need the identity for another reason, such as an Entra ID application registration that trusts it. Add this annotation so the Azure resource preparer creates the identity, or reuses the one added with "
+ },
+ {
+ "kind": "code",
+ "text": "WithAzureUserAssignedIdentity"
+ },
+ {
+ "kind": "text",
+ "text": ". The identity is available from the resource's "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.Azure.AppIdentityAnnotation"
+ },
+ {
+ "kind": "text",
+ "text": " once the preparer has run. Environments that do not support managed identities do not create one. "
+ }
+ ]
+ },
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREAZURE006"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting.Azure/ManagedIdentityRequiredAnnotation.cs",
+ "sourceLines": "21-21",
+ "members": [
+ {
+ "name": ".ctor",
+ "kind": "constructor",
+ "accessibility": "public",
+ "signature": "public ManagedIdentityRequiredAnnotation.ManagedIdentityRequiredAnnotation()",
+ "returnType": "void"
+ }
+ ]
+ },
{
"name": "PrivateEndpointTargetAnnotation",
"fullName": "Aspire.Hosting.Azure.PrivateEndpointTargetAnnotation",
@@ -12473,6 +13075,129 @@
"sourceFile": "src/Aspire.Hosting.Azure/RoleDefinition.cs"
}
]
+ },
+ {
+ "name": "TenantScopedResourceAnnotation",
+ "fullName": "Aspire.Hosting.Azure.TenantScopedResourceAnnotation",
+ "namespace": "Aspire.Hosting.Azure",
+ "kind": "class",
+ "accessibility": "public",
+ "isSealed": true,
+ "interfaces": [
+ "Aspire.Hosting.ApplicationModel.IResourceAnnotation"
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Identifies a Bicep module that creates tenant-scoped resources outside Azure Resource Manager. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " This annotation describes the created resources, not the ARM deployment scope. Annotated resources participate in tenant resource suffix configuration. Provisioning, deployment cancellation, and local state management remain available, but ARM resource inspection, relocation, deletion, and drift probes do not apply. Resource-group deletion leaves these resources and their cached identification outputs intact, and reports them for provider-specific cleanup. "
+ }
+ ]
+ },
+ "attributes": [
+ {
+ "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
+ "constructorArguments": [
+ "ASPIREAZURE007"
+ ],
+ "arguments": {
+ "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
+ }
+ }
+ ],
+ "sourceFile": "src/Aspire.Hosting.Azure/TenantScopedResourceAnnotation.cs",
+ "sourceLines": "21-21",
+ "members": [
+ {
+ "name": ".ctor",
+ "kind": "constructor",
+ "accessibility": "public",
+ "signature": "public TenantScopedResourceAnnotation.TenantScopedResourceAnnotation(IReadOnlyDictionary resourceIdOutputs)",
+ "returnType": "void",
+ "parameters": [
+ {
+ "name": "resourceIdOutputs",
+ "type": "System.Collections.Generic.IReadOnlyDictionary"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Initializes an annotation describing the tenant-scoped objects created by a module. "
+ }
+ ],
+ "parameters": {
+ "resourceIdOutputs": [
+ {
+ "kind": "text",
+ "text": " A mapping from provider resource types to Bicep output names containing their object IDs. Only non-secret identification outputs should be included because they are reported in deletion results. "
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when "
+ },
+ {
+ "kind": "paramref",
+ "value": "resourceIdOutputs"
+ },
+ {
+ "kind": "text",
+ "text": " is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when a resource type or output name is empty."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n resource.Annotations.Add(new TenantScopedResourceAnnotation(new Dictionary\n {\n [\"Microsoft.Graph/applications\"] = \"objectId\",\n [\"Microsoft.Graph/servicePrincipals\"] = \"servicePrincipalId\"\n }));\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure/TenantScopedResourceAnnotation.cs",
+ "sourceLines": "41-53"
+ },
+ {
+ "name": "ResourceIdOutputs",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public IReadOnlyDictionary TenantScopedResourceAnnotation.ResourceIdOutputs",
+ "returnType": "System.Collections.Generic.IReadOnlyDictionary",
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the provider resource types and the output names used to identify objects left after resource-group deletion. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure/TenantScopedResourceAnnotation.cs",
+ "sourceLines": "58-58"
+ }
+ ]
}
]
}
\ No newline at end of file
diff --git a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppConfiguration.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppConfiguration.17.0.0.json
similarity index 90%
rename from src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppConfiguration.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppConfiguration.17.0.0.json
index 8fadb56c7d..430686bf01 100644
--- a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppConfiguration.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppConfiguration.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Hosting.Azure.AppConfiguration",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
@@ -496,7 +496,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var appStore = builder.AddAzureAppConfiguration(\"appStore\");\n \n var api = builder.AddProject(\"api\")\n .WithRoleAssignments(appStore, AppConfigurationBuiltInRole.AppConfigurationDataReader)\n .WithReference(appStore);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var appStore = builder.AddAzureAppConfiguration(\"appStore\");\n \n var api = builder.AddDotnetProject(\"api\", \"../Api/Api.csproj\")\n .WithRoleAssignments(appStore, AppConfigurationBuiltInRole.AppConfigurationDataReader)\n .WithReference(appStore);\n ",
"language": "csharp"
}
],
@@ -613,7 +613,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppConfiguration/AzureAppConfigurationEmulatorResource.cs",
- "sourceLines": "12-14"
+ "sourceLines": "12-17"
},
{
"name": "Annotations",
@@ -632,7 +632,40 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppConfiguration/AzureAppConfigurationEmulatorResource.cs",
- "sourceLines": "17-17"
+ "sourceLines": "20-20"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AzureAppConfigurationEmulatorResource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.AppConfiguration/AzureAppConfigurationEmulatorResource.cs",
+ "sourceLines": "15-15"
}
]
},
@@ -803,7 +836,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppConfiguration/AzureAppConfigurationResource.cs",
- "sourceLines": "54-77"
+ "sourceLines": "57-80"
},
{
"name": "ConnectionStringExpression",
@@ -821,7 +854,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppConfiguration/AzureAppConfigurationResource.cs",
- "sourceLines": "47-49"
+ "sourceLines": "50-52"
},
{
"name": "Endpoint",
@@ -839,7 +872,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppConfiguration/AzureAppConfigurationResource.cs",
- "sourceLines": "31-31"
+ "sourceLines": "34-34"
},
{
"name": "Id",
@@ -857,7 +890,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppConfiguration/AzureAppConfigurationResource.cs",
- "sourceLines": "41-41"
+ "sourceLines": "44-44"
},
{
"name": "IsEmulator",
@@ -875,7 +908,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppConfiguration/AzureAppConfigurationResource.cs",
- "sourceLines": "26-26"
+ "sourceLines": "29-29"
},
{
"name": "NameOutputReference",
@@ -893,7 +926,40 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppConfiguration/AzureAppConfigurationResource.cs",
- "sourceLines": "36-36"
+ "sourceLines": "39-39"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AzureAppConfigurationResource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.AppConfiguration/AzureAppConfigurationResource.cs",
+ "sourceLines": "22-22"
}
]
}
diff --git a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppContainers.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppContainers.17.0.0.json
similarity index 92%
rename from src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppContainers.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppContainers.17.0.0.json
index 1b9520f3ec..a8ae222707 100644
--- a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppContainers.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppContainers.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Hosting.Azure.AppContainers",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
@@ -239,7 +239,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppExtensions.cs",
- "sourceLines": "31-31",
+ "sourceLines": "29-29",
"members": [
{
"name": "AddAzureContainerAppEnvironment",
@@ -294,7 +294,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppExtensions.cs",
- "sourceLines": "270-678"
+ "sourceLines": "268-711"
},
{
"name": "AddAzureContainerAppsInfrastructure",
@@ -336,7 +336,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppExtensions.cs",
- "sourceLines": "42-42"
+ "sourceLines": "40-40"
},
{
"name": "AsExpress",
@@ -377,7 +377,7 @@
"remarks": [
{
"kind": "text",
- "text": " Express defaults to zero minimum replicas and does not provision the managed Aspire dashboard. Explicit replica settings and infrastructure customization are preserved. Azure validates service compatibility. App-to-app references require explicitly public HTTP endpoints. References to apps in Express environments use HTTPS; cross-environment references preserve the producer's configured scheme. Local execution is unchanged. When combined with existing-resource configuration, the existing environment must already use Express. "
+ "text": " Express defaults to zero minimum replicas and does not provision the managed Aspire dashboard. Explicit replica settings and infrastructure customization are preserved. Azure validates service compatibility. App-to-app references require explicitly public HTTP endpoints. References to apps in Express environments use HTTPS; cross-environment references preserve the producer's configured scheme. Local execution is unchanged. When combined with existing-resource configuration, the existing environment must already use Express. Internal load balancer configuration is rejected during infrastructure generation because Express environments do not provide the static IP output required by private DNS. "
}
],
"returns": [
@@ -421,7 +421,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppExtensions.cs",
- "sourceLines": "1045-1048"
+ "sourceLines": "1118-1121"
},
{
"name": "WithAcrPullIdentity",
@@ -682,7 +682,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppExtensions.cs",
- "sourceLines": "1155-1160"
+ "sourceLines": "1228-1233"
},
{
"name": "WithAzdResourceNaming",
@@ -737,7 +737,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppExtensions.cs",
- "sourceLines": "930-931"
+ "sourceLines": "1004-1005"
},
{
"name": "WithAzureLogAnalyticsWorkspace",
@@ -827,7 +827,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppExtensions.cs",
- "sourceLines": "1097-1103"
+ "sourceLines": "1170-1176"
},
{
"name": "WithCompactResourceNaming",
@@ -847,15 +847,6 @@
"attributes": [
{
"name": "Aspire.Hosting.AspireExportAttribute"
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREACANAMING001"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"docs": {
@@ -974,7 +965,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppExtensions.cs",
- "sourceLines": "962-963"
+ "sourceLines": "1035-1036"
},
{
"name": "WithDashboard",
@@ -1031,7 +1022,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppExtensions.cs",
- "sourceLines": "1061-1062"
+ "sourceLines": "1134-1135"
},
{
"name": "WithHttpsUpgrade",
@@ -1102,7 +1093,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppExtensions.cs",
- "sourceLines": "1082-1083"
+ "sourceLines": "1155-1156"
},
{
"name": "WithUniqueResourceNaming",
@@ -1122,15 +1113,6 @@
"attributes": [
{
"name": "Aspire.Hosting.AspireExportAttribute"
- },
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIREACANAMING002"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
}
],
"docs": {
@@ -1362,7 +1344,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppExtensions.cs",
- "sourceLines": "1016-1019"
+ "sourceLines": "1088-1091"
}
]
},
@@ -1434,9 +1416,21 @@
"kind": "text",
"text": " This method adds the necessary infrastructure for container apps to the application builder and applies the specified configuration to the container app. "
},
+ {
+ "kind": "text",
+ "text": " This example uses the legacy "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.ProjectResource"
+ },
+ {
+ "kind": "text",
+ "text": " overload. "
+ },
{
"kind": "codeblock",
- "text": "\n builder.AddProject.PublishAsAzureContainerApp((infrastructure, app) =>\n {\n // Configure the container app here\n });\n ",
+ "text": "\n builder.AddProject(\"api\").PublishAsAzureContainerApp((infrastructure, app) =>\n {\n // Configure the container app here\n });\n ",
"language": "csharp"
}
],
@@ -1470,7 +1464,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppProjectExtensions.cs",
- "sourceLines": "39-51"
+ "sourceLines": "40-52"
}
]
},
@@ -1659,7 +1653,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder();\n var customDomain = builder.AddParameter(\"customDomain\"); // Value provided at first deployment.\n var certificateName = builder.AddParameter(\"certificateName\"); // Value provided at second and subsequent deployments.\n builder.AddProject(\"inventory\")\n .PublishAsAzureContainerApp((module, app) =>\n {\n app.ConfigureCustomDomain(customDomain, certificateName);\n });\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder();\n var customDomain = builder.AddParameter(\"customDomain\"); // Value provided at first deployment.\n var certificateName = builder.AddParameter(\"certificateName\"); // Value provided at second and subsequent deployments.\n builder.AddDotnetProject(\"inventory\", \"../InventoryService/InventoryService.csproj\")\n .PublishAsAzureContainerApp((module, app) =>\n {\n app.ConfigureCustomDomain(customDomain, certificateName);\n });\n ",
"language": "csharp"
}
],
@@ -1755,7 +1749,7 @@
},
{
"kind": "codeblock",
- "text": "\n builder.AddProject.PublishAsAzureContainerAppJob((infrastructure, job) =>\n {\n // Configure the container app job here\n job.Configuration.TriggerType = ContainerAppJobTriggerType.Schedule;\n job.Configuration.ScheduleTriggerConfig.CronExpression = \"0 0 * * *\"; // every day at midnight\n });\n ",
+ "text": "\n builder.AddDotnetProject(\"api\", \"../Api/Api.csproj\").PublishAsAzureContainerAppJob((infrastructure, job) =>\n {\n // Configure the container app job here\n job.Configuration.TriggerType = ContainerAppJobTriggerType.Schedule;\n job.Configuration.ScheduleTriggerConfig.CronExpression = \"0 0 * * *\"; // every day at midnight\n });\n ",
"language": "csharp"
},
{
@@ -1845,7 +1839,7 @@
},
{
"kind": "codeblock",
- "text": "\n builder.AddProject(\"processor-job\")\n .PublishAsAzureContainerAppJob(); // Manual trigger (default)\n ",
+ "text": "\n builder.AddDotnetProject(\"processor-job\", \"../ProcessorJob/ProcessorJob.csproj\")\n .PublishAsAzureContainerAppJob(); // Manual trigger (default)\n ",
"language": "csharp"
}
],
@@ -1938,7 +1932,7 @@
},
{
"kind": "codeblock",
- "text": "\n builder.AddProject(\"job\")\n .PublishAsScheduledAzureContainerAppJob(\"0 0 * * *\"); // Run every day at midnight\n ",
+ "text": "\n builder.AddDotnetProject(\"job\", \"../ProcessorJob/ProcessorJob.csproj\")\n .PublishAsScheduledAzureContainerAppJob(\"0 0 * * *\"); // Run every day at midnight\n ",
"language": "csharp"
},
{
@@ -2131,9 +2125,11 @@
"Aspire.Hosting.ApplicationModel.IComputeEnvironmentWithVolumeMounts",
"Aspire.Hosting.ApplicationModel.IContainerRegistry",
"Aspire.Hosting.ApplicationModel.IResource",
+ "Aspire.Hosting.Azure.IAzureCdnPrivateLinkTarget",
"Aspire.Hosting.Azure.IAzureComputeEnvironmentResource",
"Aspire.Hosting.Azure.IAzureContainerRegistry",
- "Aspire.Hosting.Azure.IAzureDelegatedSubnetResource"
+ "Aspire.Hosting.Azure.IAzureDelegatedSubnetResource",
+ "Aspire.Hosting.Azure.IAzureInternalIngressResource"
],
"docs": {
"summary": [
@@ -2144,7 +2140,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppEnvironmentResource.cs",
- "sourceLines": "25-25",
+ "sourceLines": "22-22",
"members": [
{
"name": ".ctor",
@@ -2193,7 +2189,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppEnvironmentResource.cs",
- "sourceLines": "38-309"
+ "sourceLines": "53-343"
},
{
"name": "AddAsExistingResource",
@@ -2279,7 +2275,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppEnvironmentResource.cs",
- "sourceLines": "445-469"
+ "sourceLines": "489-513"
},
{
"name": "GetEndpointPropertyExpression",
@@ -2293,17 +2289,6 @@
"type": "Aspire.Hosting.ApplicationModel.EndpointReferenceExpression"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRECOMPUTE002"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -2346,7 +2331,15 @@
},
{
"kind": "text",
- "text": ", the endpoint scheme, and endpoint ports. HTTP and HTTPS endpoints use ports 80 and 443 respectively when no explicit port is configured. "
+ "text": ", the endpoint scheme, and endpoint ports. HTTP and HTTPS endpoints use ports 80 and 443 respectively when no explicit port is configured. Environments can override this method to provide their own endpoint-property mappings. Host-dependent properties require an implementation of "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ApplicationModel.IComputeEnvironmentResource.GetHostAddressExpression(Aspire.Hosting.ApplicationModel.EndpointReference)"
+ },
+ {
+ "kind": "text",
+ "text": ". "
}
],
"returns": [
@@ -2405,11 +2398,29 @@
"text": "Thrown when the requested endpoint property is unsupported, or when a non-HTTP/HTTPS endpoint does not specify a port."
}
]
+ },
+ {
+ "type": "T:System.NotSupportedException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when the environment does not implement browser-origin resolution."
+ }
+ ]
+ },
+ {
+ "type": "T:System.NotImplementedException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when a host-dependent property is requested and the environment does not implement host-address resolution."
+ }
+ ]
}
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppEnvironmentResource.cs",
- "sourceLines": "393-415"
+ "sourceLines": "425-459"
},
{
"name": "GetHostAddressExpression",
@@ -2423,17 +2434,6 @@
"type": "Aspire.Hosting.ApplicationModel.EndpointReference"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRECOMPUTE002"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -2460,7 +2460,23 @@
"remarks": [
{
"kind": "text",
- "text": " The returned value typically contains only the host name or address, without scheme, port, or path information. "
+ "text": " The returned value typically contains only the host name or address, without scheme, port, or path information. Implementations that support host-address resolution must override this method. The default implementation throws "
+ },
+ {
+ "kind": "cref",
+ "value": "T:System.NotImplementedException"
+ },
+ {
+ "kind": "text",
+ "text": " so environments that do not support this capability can still implement "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.IComputeEnvironmentResource"
+ },
+ {
+ "kind": "text",
+ "text": ". "
}
],
"returns": [
@@ -2484,10 +2500,21 @@
"text": "The endpoint reference for which to retrieve the host address or host name."
}
]
- }
+ },
+ "exceptions": [
+ {
+ "type": "T:System.NotImplementedException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when the environment does not implement host-address resolution."
+ }
+ ]
+ }
+ ]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppEnvironmentResource.cs",
- "sourceLines": "368-386"
+ "sourceLines": "401-419"
},
{
"name": "ContainerRegistry",
@@ -2506,7 +2533,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppEnvironmentResource.cs",
- "sourceLines": "341-356"
+ "sourceLines": "375-390"
},
{
"name": "NameOutputReference",
@@ -2524,7 +2551,40 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppEnvironmentResource.cs",
- "sourceLines": "307-307"
+ "sourceLines": "341-341"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AzureContainerAppEnvironmentResource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppEnvironmentResource.cs",
+ "sourceLines": "27-27"
}
]
},
@@ -2544,7 +2604,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppResource.cs",
- "sourceLines": "17-17",
+ "sourceLines": "15-15",
"members": [
{
"name": ".ctor",
@@ -2603,7 +2663,40 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppResource.cs",
- "sourceLines": "26-101"
+ "sourceLines": "27-102"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AzureContainerAppResource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppResource.cs",
+ "sourceLines": "18-18"
},
{
"name": "TargetResource",
@@ -2621,7 +2714,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppContainers/AzureContainerAppResource.cs",
- "sourceLines": "106-106"
+ "sourceLines": "107-107"
}
]
}
diff --git a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppService.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppService.17.0.0.json
similarity index 91%
rename from src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppService.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppService.17.0.0.json
index 46fa26585b..fdc1f88d05 100644
--- a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppService.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.AppService.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Hosting.Azure.AppService",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
@@ -75,7 +75,7 @@
"remarks": [
{
"kind": "codeblock",
- "text": "\n builder.AddProject(\"name\").PublishAsAzureAppServiceWebsite((infrastructure, app) =>\n {\n // Configure the App Service WebSite resource here\n });\n ",
+ "text": "\n builder.AddDotnetProject(\"name\", \"../Api/Api.csproj\").PublishAsAzureAppServiceWebsite((infrastructure, app) =>\n {\n // Configure the App Service WebSite resource here\n });\n ",
"language": "csharp"
}
],
@@ -213,7 +213,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentExtensions.cs",
- "sourceLines": "25-25",
+ "sourceLines": "23-23",
"members": [
{
"name": "AddAzureAppServiceEnvironment",
@@ -268,7 +268,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentExtensions.cs",
- "sourceLines": "88-307"
+ "sourceLines": "86-305"
},
{
"name": "WithAcrPullIdentity",
@@ -571,7 +571,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentExtensions.cs",
- "sourceLines": "541-546"
+ "sourceLines": "539-544"
},
{
"name": "WithAzureApplicationInsights",
@@ -619,7 +619,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentExtensions.cs",
- "sourceLines": "359-361"
+ "sourceLines": "357-359"
},
{
"name": "WithAzureApplicationInsights",
@@ -791,7 +791,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentExtensions.cs",
- "sourceLines": "423-425"
+ "sourceLines": "421-423"
},
{
"name": "WithDashboard",
@@ -864,7 +864,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentExtensions.cs",
- "sourceLines": "347-348"
+ "sourceLines": "345-346"
},
{
"name": "WithDeploymentSlot",
@@ -1077,7 +1077,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentExtensions.cs",
- "sourceLines": "333-334"
+ "sourceLines": "331-332"
}
]
},
@@ -1092,6 +1092,7 @@
"Aspire.Hosting.ApplicationModel.IComputeEnvironmentResource",
"Aspire.Hosting.ApplicationModel.IContainerRegistry",
"Aspire.Hosting.ApplicationModel.IResource",
+ "Aspire.Hosting.Azure.IAzureCdnPrivateLinkTarget",
"Aspire.Hosting.Azure.IAzureComputeEnvironmentResource",
"Aspire.Hosting.Azure.IAzureContainerRegistry",
"Aspire.Hosting.Azure.IAzureDelegatedSubnetResource"
@@ -1105,7 +1106,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs",
- "sourceLines": "30-30",
+ "sourceLines": "27-27",
"members": [
{
"name": ".ctor",
@@ -1154,7 +1155,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs",
- "sourceLines": "47-399"
+ "sourceLines": "54-438"
},
{
"name": "AddAsExistingResource",
@@ -1240,7 +1241,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs",
- "sourceLines": "548-571"
+ "sourceLines": "593-616"
},
{
"name": "GetEndpointPropertyExpression",
@@ -1254,17 +1255,6 @@
"type": "Aspire.Hosting.ApplicationModel.EndpointReferenceExpression"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRECOMPUTE002"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -1307,7 +1297,15 @@
},
{
"kind": "text",
- "text": ", the endpoint scheme, and endpoint ports. HTTP and HTTPS endpoints use ports 80 and 443 respectively when no explicit port is configured. "
+ "text": ", the endpoint scheme, and endpoint ports. HTTP and HTTPS endpoints use ports 80 and 443 respectively when no explicit port is configured. Environments can override this method to provide their own endpoint-property mappings. Host-dependent properties require an implementation of "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ApplicationModel.IComputeEnvironmentResource.GetHostAddressExpression(Aspire.Hosting.ApplicationModel.EndpointReference)"
+ },
+ {
+ "kind": "text",
+ "text": ". "
}
],
"returns": [
@@ -1366,11 +1364,29 @@
"text": "Thrown when the requested endpoint property is unsupported, or when a non-HTTP/HTTPS endpoint does not specify a port."
}
]
+ },
+ {
+ "type": "T:System.NotSupportedException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when the environment does not implement browser-origin resolution."
+ }
+ ]
+ },
+ {
+ "type": "T:System.NotImplementedException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when a host-dependent property is requested and the environment does not implement host-address resolution."
+ }
+ ]
}
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs",
- "sourceLines": "520-542"
+ "sourceLines": "557-587"
},
{
"name": "GetHostAddressExpression",
@@ -1384,17 +1400,6 @@
"type": "Aspire.Hosting.ApplicationModel.EndpointReference"
}
],
- "attributes": [
- {
- "name": "System.Diagnostics.CodeAnalysis.ExperimentalAttribute",
- "constructorArguments": [
- "ASPIRECOMPUTE002"
- ],
- "arguments": {
- "UrlFormat": "https://aka.ms/aspire/diagnostics/{0}"
- }
- }
- ],
"docs": {
"summary": [
{
@@ -1421,7 +1426,23 @@
"remarks": [
{
"kind": "text",
- "text": " The returned value typically contains only the host name or address, without scheme, port, or path information. "
+ "text": " The returned value typically contains only the host name or address, without scheme, port, or path information. Implementations that support host-address resolution must override this method. The default implementation throws "
+ },
+ {
+ "kind": "cref",
+ "value": "T:System.NotImplementedException"
+ },
+ {
+ "kind": "text",
+ "text": " so environments that do not support this capability can still implement "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.IComputeEnvironmentResource"
+ },
+ {
+ "kind": "text",
+ "text": ". "
}
],
"returns": [
@@ -1445,10 +1466,21 @@
"text": "The endpoint reference for which to retrieve the host address or host name."
}
]
- }
+ },
+ "exceptions": [
+ {
+ "type": "T:System.NotImplementedException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when the environment does not implement host-address resolution."
+ }
+ ]
+ }
+ ]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs",
- "sourceLines": "512-513"
+ "sourceLines": "550-551"
},
{
"name": "AzureAppInsightsConnectionStringReference",
@@ -1466,7 +1498,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs",
- "sourceLines": "451-451"
+ "sourceLines": "490-490"
},
{
"name": "AzureAppInsightsInstrumentationKeyReference",
@@ -1484,7 +1516,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs",
- "sourceLines": "445-445"
+ "sourceLines": "484-484"
},
{
"name": "ContainerRegistry",
@@ -1503,7 +1535,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs",
- "sourceLines": "486-500"
+ "sourceLines": "525-539"
},
{
"name": "DashboardUriReference",
@@ -1521,7 +1553,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs",
- "sourceLines": "439-439"
+ "sourceLines": "478-478"
},
{
"name": "NameOutputReference",
@@ -1539,7 +1571,40 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs",
- "sourceLines": "434-434"
+ "sourceLines": "473-473"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AzureAppServiceEnvironmentResource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceEnvironmentResource.cs",
+ "sourceLines": "37-37"
}
]
},
@@ -1623,7 +1688,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceWebSiteResource.cs",
- "sourceLines": "17-17",
+ "sourceLines": "15-15",
"members": [
{
"name": ".ctor",
@@ -1682,7 +1747,40 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceWebSiteResource.cs",
- "sourceLines": "26-99"
+ "sourceLines": "27-100"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AzureAppServiceWebSiteResource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceWebSiteResource.cs",
+ "sourceLines": "18-18"
},
{
"name": "TargetResource",
@@ -1700,7 +1798,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.AppService/AzureAppServiceWebSiteResource.cs",
- "sourceLines": "104-104"
+ "sourceLines": "105-105"
}
]
},
diff --git a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ApplicationInsights.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ApplicationInsights.17.0.0.json
similarity index 92%
rename from src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ApplicationInsights.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ApplicationInsights.17.0.0.json
index 4cea6d1121..0f2bb55603 100644
--- a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ApplicationInsights.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ApplicationInsights.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Hosting.Azure.ApplicationInsights",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
@@ -553,7 +553,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.ApplicationInsights/AzureApplicationInsightsResource.cs",
- "sourceLines": "41-64"
+ "sourceLines": "44-67"
},
{
"name": "ConnectionString",
@@ -571,7 +571,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.ApplicationInsights/AzureApplicationInsightsResource.cs",
- "sourceLines": "27-27"
+ "sourceLines": "30-30"
},
{
"name": "ConnectionStringExpression",
@@ -589,7 +589,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.ApplicationInsights/AzureApplicationInsightsResource.cs",
- "sourceLines": "33-33"
+ "sourceLines": "36-36"
},
{
"name": "NameOutputReference",
@@ -607,7 +607,40 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.ApplicationInsights/AzureApplicationInsightsResource.cs",
- "sourceLines": "22-22"
+ "sourceLines": "25-25"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AzureApplicationInsightsResource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.ApplicationInsights/AzureApplicationInsightsResource.cs",
+ "sourceLines": "20-20"
}
]
}
diff --git a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.CognitiveServices.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.CognitiveServices.17.0.0.json
similarity index 92%
rename from src/frontend/src/data/pkgs/Aspire.Hosting.Azure.CognitiveServices.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Hosting.Azure.CognitiveServices.17.0.0.json
index 53078dcc2e..024a7adbd4 100644
--- a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.CognitiveServices.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.CognitiveServices.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Hosting.Azure.CognitiveServices",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
@@ -443,7 +443,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var openai = builder.AddAzureOpenAI(\"openai\");\n \n var api = builder.AddProject(\"api\")\n .WithRoleAssignments(openai, CognitiveServicesBuiltInRole.CognitiveServicesOpenAIUser)\n .WithReference(openai);\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var openai = builder.AddAzureOpenAI(\"openai\");\n \n var api = builder.AddDotnetProject(\"api\", \"../Api/Api.csproj\")\n .WithRoleAssignments(openai, CognitiveServicesBuiltInRole.CognitiveServicesOpenAIUser)\n .WithReference(openai);\n ",
"language": "csharp"
}
],
@@ -830,7 +830,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIDeploymentResource.cs",
- "sourceLines": "34-95"
+ "sourceLines": "37-98"
},
{
"name": "ConnectionStringExpression",
@@ -848,7 +848,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIDeploymentResource.cs",
- "sourceLines": "105-105"
+ "sourceLines": "108-108"
},
{
"name": "DeploymentName",
@@ -934,7 +934,40 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIDeploymentResource.cs",
- "sourceLines": "100-100"
+ "sourceLines": "103-103"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AzureOpenAIDeploymentResource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIDeploymentResource.cs",
+ "sourceLines": "16-16"
},
{
"name": "SkuCapacity",
@@ -1080,7 +1113,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIResource.cs",
- "sourceLines": "19-24"
+ "sourceLines": "19-27"
},
{
"name": "AddAsExistingResource",
@@ -1166,7 +1199,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIResource.cs",
- "sourceLines": "88-111"
+ "sourceLines": "91-114"
},
{
"name": "ConnectionString",
@@ -1184,7 +1217,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIResource.cs",
- "sourceLines": "29-29"
+ "sourceLines": "32-32"
},
{
"name": "ConnectionStringExpression",
@@ -1202,7 +1235,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIResource.cs",
- "sourceLines": "59-59"
+ "sourceLines": "62-62"
},
{
"name": "Deployments",
@@ -1228,7 +1261,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIResource.cs",
- "sourceLines": "68-68"
+ "sourceLines": "71-71"
},
{
"name": "Endpoint",
@@ -1246,7 +1279,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIResource.cs",
- "sourceLines": "34-34"
+ "sourceLines": "37-37"
},
{
"name": "Id",
@@ -1264,7 +1297,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIResource.cs",
- "sourceLines": "44-44"
+ "sourceLines": "47-47"
},
{
"name": "NameOutputReference",
@@ -1282,7 +1315,40 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIResource.cs",
- "sourceLines": "39-39"
+ "sourceLines": "42-42"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AzureOpenAIResource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIResource.cs",
+ "sourceLines": "23-23"
},
{
"name": "UriExpression",
@@ -1306,7 +1372,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CognitiveServices/AzureOpenAIResource.cs",
- "sourceLines": "53-53"
+ "sourceLines": "56-56"
}
]
}
diff --git a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ConnectorNamespace.13.6.5-preview.1.26559.7.json b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ConnectorNamespace.17.0.0-preview.1.26565.2.json
similarity index 99%
rename from src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ConnectorNamespace.13.6.5-preview.1.26559.7.json
rename to src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ConnectorNamespace.17.0.0-preview.1.26565.2.json
index 19680a19ee..f26a0c5eab 100644
--- a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ConnectorNamespace.13.6.5-preview.1.26559.7.json
+++ b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ConnectorNamespace.17.0.0-preview.1.26565.2.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Hosting.Azure.ConnectorNamespace",
- "version": "13.6.5-preview.1.26559.7",
+ "version": "17.0.0-preview.1.26565.2",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
diff --git a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ContainerRegistry.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ContainerRegistry.17.0.0.json
similarity index 90%
rename from src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ContainerRegistry.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ContainerRegistry.17.0.0.json
index 97a687a5b5..47190314f2 100644
--- a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ContainerRegistry.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.ContainerRegistry.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Hosting.Azure.ContainerRegistry",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
@@ -451,7 +451,29 @@
"summary": [
{
"kind": "text",
- "text": " Adds a scheduled ACR purge task to remove old or unused container images from the registry. "
+ "text": " Adds a scheduled ACR purge task to remove image tags and eligible untagged manifests. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Tag removal alone does not reclaim storage. The task also deletes eligible previously untagged manifests and can break digest-based pulls and rollbacks. Tags younger than "
+ },
+ {
+ "kind": "paramref",
+ "value": "ago"
+ },
+ {
+ "kind": "text",
+ "text": " are also retained, so more than "
+ },
+ {
+ "kind": "paramref",
+ "value": "keep"
+ },
+ {
+ "kind": "text",
+ "text": " tags can remain. Eligible untagged manifests are deleted regardless of age. Locked artifacts and dependencies of retained images are protected. "
}
],
"returns": [
@@ -480,31 +502,15 @@
},
{
"kind": "text",
- "text": ". Images older than this duration will be considered for removal. Uses Go-style duration format (e.g., "
- },
- {
- "kind": "code",
- "text": "2d3h6m"
- },
- {
- "kind": "text",
- "text": "). Defaults to "
+ "text": ". Tags last modified before this duration are eligible for removal unless protected by "
},
{
- "kind": "code",
- "text": "0d"
+ "kind": "paramref",
+ "value": "keep"
},
{
"kind": "text",
- "text": " when "
- },
- {
- "kind": "langword",
- "value": "null"
- },
- {
- "kind": "text",
- "text": "."
+ "text": ". Defaults to zero when null."
}
],
"builder": [
@@ -554,7 +560,7 @@
"keep": [
{
"kind": "text",
- "text": "The number of most recent images to keep per repository, regardless of age. Must be greater than zero. Defaults to 3."
+ "text": "The minimum number of newest matching tags to retain per repository, regardless of age. Must be greater than zero. Defaults to 3."
}
],
"schedule": [
@@ -678,14 +684,14 @@
"description": [
{
"kind": "text",
- "text": "This example configures a daily purge task that removes images older than 7 days, keeping the 5 most recent:"
+ "text": "This example schedules a daily purge of tags older than 7 days, protecting the 5 newest matching tags per repository and removing eligible untagged manifests:"
}
]
}
]
},
"sourceFile": "src/Aspire.Hosting.Azure.ContainerRegistry/AzureContainerRegistryExtensions.cs",
- "sourceLines": "162-240"
+ "sourceLines": "171-250"
},
{
"name": "WithRoleAssignments",
@@ -818,7 +824,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.ContainerRegistry/AzureContainerRegistryResource.cs",
- "sourceLines": "18-18",
+ "sourceLines": "17-17",
"members": [
{
"name": ".ctor",
@@ -867,7 +873,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.ContainerRegistry/AzureContainerRegistryResource.cs",
- "sourceLines": "26-48"
+ "sourceLines": "28-51"
},
{
"name": "AddAsExistingResource",
@@ -953,7 +959,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.ContainerRegistry/AzureContainerRegistryResource.cs",
- "sourceLines": "74-97"
+ "sourceLines": "77-100"
},
{
"name": "Id",
@@ -971,7 +977,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.ContainerRegistry/AzureContainerRegistryResource.cs",
- "sourceLines": "63-63"
+ "sourceLines": "66-66"
},
{
"name": "NameOutputReference",
@@ -989,7 +995,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.ContainerRegistry/AzureContainerRegistryResource.cs",
- "sourceLines": "53-53"
+ "sourceLines": "56-56"
},
{
"name": "RegistryEndpoint",
@@ -1007,7 +1013,40 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.ContainerRegistry/AzureContainerRegistryResource.cs",
- "sourceLines": "58-58"
+ "sourceLines": "61-61"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AzureContainerRegistryResource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.ContainerRegistry/AzureContainerRegistryResource.cs",
+ "sourceLines": "20-20"
}
]
}
diff --git a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.CosmosDB.13.6.5.json b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.CosmosDB.17.0.0.json
similarity index 91%
rename from src/frontend/src/data/pkgs/Aspire.Hosting.Azure.CosmosDB.13.6.5.json
rename to src/frontend/src/data/pkgs/Aspire.Hosting.Azure.CosmosDB.17.0.0.json
index 85829378d6..1bb14659d8 100644
--- a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.CosmosDB.13.6.5.json
+++ b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.CosmosDB.17.0.0.json
@@ -1,10 +1,10 @@
{
"package": {
"name": "Aspire.Hosting.Azure.CosmosDB",
- "version": "13.6.5",
+ "version": "17.0.0",
"targetFramework": "net10.0",
"sourceRepository": "https://github.com/microsoft/aspire",
- "sourceCommit": "b33d222049f1ecc3bc7257ec07b622fe550b2580"
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
},
"types": [
{
@@ -62,7 +62,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBResource.cs",
- "sourceLines": "20-27"
+ "sourceLines": "20-30"
},
{
"name": "AddAsExistingResource",
@@ -148,7 +148,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBResource.cs",
- "sourceLines": "169-192"
+ "sourceLines": "172-195"
},
{
"name": "AddRoleAssignments",
@@ -180,7 +180,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBResource.cs",
- "sourceLines": "200-206"
+ "sourceLines": "203-209"
},
{
"name": "AccountKey",
@@ -205,7 +205,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBResource.cs",
- "sourceLines": "117-121"
+ "sourceLines": "120-124"
},
{
"name": "ConnectionString",
@@ -231,7 +231,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBResource.cs",
- "sourceLines": "35-35"
+ "sourceLines": "38-38"
},
{
"name": "ConnectionStringExpression",
@@ -249,7 +249,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBResource.cs",
- "sourceLines": "127-131"
+ "sourceLines": "130-134"
},
{
"name": "ConnectionStringOutput",
@@ -273,7 +273,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBResource.cs",
- "sourceLines": "45-45"
+ "sourceLines": "48-48"
},
{
"name": "Id",
@@ -291,7 +291,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBResource.cs",
- "sourceLines": "76-76"
+ "sourceLines": "79-79"
},
{
"name": "IsEmulator",
@@ -309,7 +309,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBResource.cs",
- "sourceLines": "88-88"
+ "sourceLines": "91-91"
},
{
"name": "NameOutputReference",
@@ -327,7 +327,40 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBResource.cs",
- "sourceLines": "71-71"
+ "sourceLines": "74-74"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AzureCosmosDBResource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBResource.cs",
+ "sourceLines": "28-28"
},
{
"name": "UriExpression",
@@ -359,7 +392,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBResource.cs",
- "sourceLines": "106-108"
+ "sourceLines": "109-111"
},
{
"name": "UseAccessKeyAuthentication",
@@ -377,7 +410,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBResource.cs",
- "sourceLines": "83-83"
+ "sourceLines": "86-86"
}
]
},
@@ -1154,7 +1187,7 @@
},
{
"kind": "codeblock",
- "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var cosmosdb = builder.AddAzureCosmosDB(\"cache\")\n .WithAccessKeyAuthentication();\n \n builder.AddProject()\n .WithReference(cosmosdb);\n \n builder.Build().Run();\n ",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var cosmosdb = builder.AddAzureCosmosDB(\"cache\")\n .WithAccessKeyAuthentication();\n \n builder.AddDotnetProject(\"productservice\", \"../ProductService/ProductService.csproj\")\n .WithReference(cosmosdb);\n \n builder.Build().Run();\n ",
"language": "csharp"
}
],
@@ -1182,7 +1215,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs",
- "sourceLines": "553-572"
+ "sourceLines": "550-569"
},
{
"name": "WithAccessKeyAuthentication",
@@ -1248,7 +1281,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs",
- "sourceLines": "599-616"
+ "sourceLines": "596-613"
},
{
"name": "WithDataExplorer",
@@ -1319,7 +1352,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs",
- "sourceLines": "487-526"
+ "sourceLines": "487-523"
},
{
"name": "WithDataVolume",
@@ -1693,7 +1726,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBContainerResource.cs",
- "sourceLines": "28-44"
+ "sourceLines": "31-47"
},
{
"name": ".ctor",
@@ -1762,7 +1795,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBContainerResource.cs",
- "sourceLines": "53-59"
+ "sourceLines": "56-62"
},
{
"name": "ConnectionStringExpression",
@@ -1780,7 +1813,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBContainerResource.cs",
- "sourceLines": "114-114"
+ "sourceLines": "117-117"
},
{
"name": "ContainerName",
@@ -1833,7 +1866,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBContainerResource.cs",
- "sourceLines": "108-108"
+ "sourceLines": "111-111"
},
{
"name": "PartitionKeyPath",
@@ -1870,6 +1903,39 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBContainerResource.cs"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AzureCosmosDBContainerResource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBContainerResource.cs",
+ "sourceLines": "22-22"
}
]
},
@@ -1991,7 +2057,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBDatabaseResource.cs",
- "sourceLines": "19-34"
+ "sourceLines": "19-37"
},
{
"name": "ConnectionStringExpression",
@@ -2009,7 +2075,7 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBDatabaseResource.cs",
- "sourceLines": "40-40"
+ "sourceLines": "43-43"
},
{
"name": "DatabaseName",
@@ -2045,7 +2111,40 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBDatabaseResource.cs",
- "sourceLines": "34-34"
+ "sourceLines": "37-37"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AzureCosmosDBDatabaseResource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBDatabaseResource.cs",
+ "sourceLines": "22-22"
}
]
},
@@ -2120,7 +2219,7 @@
}
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBEmulatorResource.cs",
- "sourceLines": "13-15"
+ "sourceLines": "13-18"
},
{
"name": "Annotations",
@@ -2139,7 +2238,40 @@
]
},
"sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBEmulatorResource.cs",
- "sourceLines": "18-18"
+ "sourceLines": "21-21"
+ },
+ {
+ "name": "ResourceTypeDisplayName",
+ "kind": "property",
+ "accessibility": "public",
+ "signature": "public override string AzureCosmosDBEmulatorResource.ResourceTypeDisplayName",
+ "returnType": "string",
+ "isOverride": true,
+ "hasGet": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Gets the default human-readable name of this resource's type. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Override this property to identify the service, such as Redis or PostgreSQL Server, independently of its technical resource type. The default is the resource type. This label does not change the resource name, service discovery, or OpenTelemetry identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.ResourceBuilderExtensions.WithResourceTypeDisplayName``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{``0},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to override the label for an instance. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBEmulatorResource.cs",
+ "sourceLines": "16-16"
}
]
}
diff --git a/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.EntraId.17.0.0-preview.1.26565.2.json b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.EntraId.17.0.0-preview.1.26565.2.json
new file mode 100644
index 0000000000..2af20d908f
--- /dev/null
+++ b/src/frontend/src/data/pkgs/Aspire.Hosting.Azure.EntraId.17.0.0-preview.1.26565.2.json
@@ -0,0 +1,11829 @@
+{
+ "package": {
+ "name": "Aspire.Hosting.Azure.EntraId",
+ "version": "17.0.0-preview.1.26565.2",
+ "targetFramework": "net10.0",
+ "sourceRepository": "https://github.com/microsoft/aspire",
+ "sourceCommit": "bcfa151cdca6d0a573f22d5d9c23f9c727cb3b2f"
+ },
+ "types": [
+ {
+ "name": "EntraIdResourceExtensions",
+ "fullName": "Aspire.Hosting.EntraIdResourceExtensions",
+ "namespace": "Aspire.Hosting",
+ "kind": "class",
+ "accessibility": "public",
+ "isStatic": true,
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Provides extension methods for adding Microsoft Entra ID resources to the application model. "
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.EntraId/EntraIdResourceExtensions.cs",
+ "sourceLines": "20-20",
+ "members": [
+ {
+ "name": "AddEntraIdApplication",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder EntraIdResourceExtensions.AddEntraIdApplication(this IDistributedApplicationBuilder builder, string name)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.IDistributedApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "name",
+ "type": "string"
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportAttribute"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Adds a Microsoft Entra ID application registration resource to the application model. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " The Entra ID application resource injects configuration as environment variables into consuming services. For .NET programs, the variables default to the "
+ },
+ {
+ "kind": "code",
+ "text": "AzureAd"
+ },
+ {
+ "kind": "text",
+ "text": " configuration section that Microsoft.Identity.Web reads natively. "
+ }
+ ]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " By default, Aspire provisions an application and service principal using the Microsoft Graph Bicep extension. This requires Azure provisioning configuration and permission to create registrations in the subscription's tenant. Call "
+ },
+ {
+ "kind": "code",
+ "text": "AddExistingEntraIdApplication"
+ },
+ {
+ "kind": "text",
+ "text": " to reference an existing registration without Azure or Graph access. "
+ }
+ ]
+ },
+ {
+ "kind": "codeblock",
+ "text": "\n var builder = DistributedApplication.CreateBuilder(args);\n \n var entraApi = builder.AddEntraIdApplication(\"entra-api\");\n \n builder.AddDotnetProject(\"api\", \"../Api/Api.csproj\")\n .WithReference(entraApi);\n ",
+ "language": "csharp"
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A reference to the "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.IResourceBuilder`1"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.IDistributedApplicationBuilder"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "name": [
+ {
+ "kind": "text",
+ "text": "The name of the resource."
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.EntraId/EntraIdResourceExtensions.cs",
+ "sourceLines": "63-74"
+ },
+ {
+ "name": "AddExistingEntraIdApplication",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder EntraIdResourceExtensions.AddExistingEntraIdApplication(this IDistributedApplicationBuilder builder, string name, IResourceBuilder tenantId, IResourceBuilder clientId)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.IDistributedApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "name": "tenantId",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder"
+ },
+ {
+ "name": "clientId",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder"
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "The addExistingEntraIdApplication export accepts literal or parameter IDs independently."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Adds a reference to an existing Microsoft Entra ID application registration without enabling Azure provisioning. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " Both the tenant ID and client ID are required to identify an existing Entra ID application. Unlike ARM resources that can be identified by name and resource group, Entra ID app registrations live in a specific tenant directory and are uniquely identified by their client ID within that tenant. "
+ }
+ ]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " The parameter values are validated when the application starts. The tenant ID must be a GUID or a domain such as "
+ },
+ {
+ "kind": "code",
+ "text": "contoso.onmicrosoft.com"
+ },
+ {
+ "kind": "text",
+ "text": ", and the client ID must be a GUID. When a value is missing or malformed, the resource reports "
+ },
+ {
+ "kind": "code",
+ "text": "FailedToStart"
+ },
+ {
+ "kind": "text",
+ "text": " and logs the reason. "
+ }
+ ]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " The registration is used only for configuration. Aspire does not deploy Bicep or query Microsoft Graph for this resource. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.EntraIdResourceExtensions.AddEntraIdApplication(Aspire.Hosting.IDistributedApplicationBuilder,System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to create a registration instead. "
+ }
+ ]
+ },
+ {
+ "kind": "codeblock",
+ "text": "\n var tenantId = builder.AddParameter(\"EntraTenantId\");\n var clientId = builder.AddParameter(\"EntraClientId\");\n var identity = builder.AddExistingEntraIdApplication(\"identity\", tenantId, clientId);\n builder.AddDotnetProject(\"api\", \"../Api/Api.csproj\").WithReference(identity);\n ",
+ "language": "csharp"
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A reference to the "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.IResourceBuilder`1"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.IDistributedApplicationBuilder"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "clientId": [
+ {
+ "kind": "text",
+ "text": " A parameter containing the application (client) ID, shown as \"Application (client) ID\" on the app registration's Overview page. "
+ }
+ ],
+ "name": [
+ {
+ "kind": "text",
+ "text": "The name of the resource."
+ }
+ ],
+ "tenantId": [
+ {
+ "kind": "text",
+ "text": " A parameter containing the ID of the app's home tenant: the directory where the app is registered, shown as \"Directory (tenant) ID\" on the app registration's Overview page. "
+ }
+ ]
+ }
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.EntraId/EntraIdResourceExtensions.cs"
+ },
+ {
+ "name": "AddExistingEntraIdApplication",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder EntraIdResourceExtensions.AddExistingEntraIdApplication(this IDistributedApplicationBuilder builder, string name, string tenantId, string clientId)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.IDistributedApplicationBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "name",
+ "type": "string"
+ },
+ {
+ "name": "tenantId",
+ "type": "string"
+ },
+ {
+ "name": "clientId",
+ "type": "string"
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "The addExistingEntraIdApplication export accepts literal or parameter IDs independently."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Adds a reference to an existing Microsoft Entra ID application registration without enabling Azure provisioning. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " Both the tenant ID and client ID are required to identify an existing Entra ID application. Unlike ARM resources that can be identified by name and resource group, Entra ID app registrations live in a specific tenant directory and are uniquely identified by their client ID within that tenant. "
+ }
+ ]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " To let accounts from other tenants sign in, keep the home tenant here and call "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.EntraIdResourceExtensions.WithSignInAudience(Aspire.Hosting.ApplicationModel.IResourceBuilder{Aspire.Hosting.Azure.EntraIdApplicationResource},Aspire.Hosting.Azure.EntraIdSignInAudience)"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " The registration is used only for configuration. Aspire does not deploy Bicep or query Microsoft Graph for this resource. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.EntraIdResourceExtensions.AddEntraIdApplication(Aspire.Hosting.IDistributedApplicationBuilder,System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " to create a registration instead. "
+ }
+ ]
+ },
+ {
+ "kind": "codeblock",
+ "text": "\n var identity = builder.AddExistingEntraIdApplication(\n \"identity\",\n tenantId: \"aaaabbbb-0000-cccc-1111-dddd2222eeee\",\n clientId: \"00001111-aaaa-2222-bbbb-3333cccc4444\");\n builder.AddDotnetProject(\"api\", \"../Api/Api.csproj\").WithReference(identity);\n ",
+ "language": "csharp"
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "A reference to the "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.ApplicationModel.IResourceBuilder`1"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The "
+ },
+ {
+ "kind": "cref",
+ "value": "T:Aspire.Hosting.IDistributedApplicationBuilder"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "clientId": [
+ {
+ "kind": "text",
+ "text": " The application (client) ID, shown as \"Application (client) ID\" on the app registration's Overview page. "
+ }
+ ],
+ "name": [
+ {
+ "kind": "text",
+ "text": "The name of the resource."
+ }
+ ],
+ "tenantId": [
+ {
+ "kind": "text",
+ "text": " The ID of the app's home tenant: the directory where the app is registered, shown as \"Directory (tenant) ID\" on the app registration's Overview page. A domain such as "
+ },
+ {
+ "kind": "code",
+ "text": "contoso.onmicrosoft.com"
+ },
+ {
+ "kind": "text",
+ "text": " is also accepted. "
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "text",
+ "text": " Thrown when "
+ },
+ {
+ "kind": "paramref",
+ "value": "tenantId"
+ },
+ {
+ "kind": "text",
+ "text": " is empty, is not a GUID or domain name, or is one of the sign-in audience keywords "
+ },
+ {
+ "kind": "code",
+ "text": "organizations"
+ },
+ {
+ "kind": "text",
+ "text": ", "
+ },
+ {
+ "kind": "code",
+ "text": "common"
+ },
+ {
+ "kind": "text",
+ "text": " or "
+ },
+ {
+ "kind": "code",
+ "text": "consumers"
+ },
+ {
+ "kind": "text",
+ "text": "; or when "
+ },
+ {
+ "kind": "paramref",
+ "value": "clientId"
+ },
+ {
+ "kind": "text",
+ "text": " is empty or is not a GUID. "
+ }
+ ]
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.EntraId/EntraIdResourceExtensions.cs"
+ },
+ {
+ "name": "AsExistingApplication",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder EntraIdResourceExtensions.AsExistingApplication(this IResourceBuilder builder, IResourceBuilder tenantId, IResourceBuilder clientId)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "tenantId",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder"
+ },
+ {
+ "name": "clientId",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder"
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "The asExistingApplication export accepts literal or parameter IDs independently."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Configures this resource to reference an existing Microsoft Entra ID application registration. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " Parameter values are validated when the application starts. The tenant ID must be a GUID or a domain such as "
+ },
+ {
+ "kind": "code",
+ "text": "contoso.onmicrosoft.com"
+ },
+ {
+ "kind": "text",
+ "text": ", and the client ID must be a GUID. "
+ }
+ ]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.EntraIdResourceExtensions.AddEntraIdApplication(Aspire.Hosting.IDistributedApplicationBuilder,System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " enables Azure provisioning before this method is called. This method does not disable that setup, so deployment can still require Azure authentication and provisioning configuration. To reference an existing registration without enabling Azure provisioning, use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.EntraIdResourceExtensions.AddExistingEntraIdApplication(Aspire.Hosting.IDistributedApplicationBuilder,System.String,Aspire.Hosting.ApplicationModel.IResourceBuilder{Aspire.Hosting.ApplicationModel.ParameterResource},Aspire.Hosting.ApplicationModel.IResourceBuilder{Aspire.Hosting.ApplicationModel.ParameterResource})"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ {
+ "kind": "codeblock",
+ "text": "\n var identity = builder.AddEntraIdApplication(\"identity\")\n .AsExistingApplication(builder.AddParameter(\"TenantId\"), builder.AddParameter(\"ClientId\"));\n ",
+ "language": "csharp"
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The resource builder for chaining."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ],
+ "clientId": [
+ {
+ "kind": "text",
+ "text": "A parameter containing the registration's application (client) ID."
+ }
+ ],
+ "tenantId": [
+ {
+ "kind": "text",
+ "text": "A parameter containing the registration's home tenant ID."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.InvalidOperationException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Registration-only configuration is already applied to this resource."
+ }
+ ]
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.EntraId/EntraIdResourceExtensions.cs"
+ },
+ {
+ "name": "AsExistingApplication",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder EntraIdResourceExtensions.AsExistingApplication(this IResourceBuilder builder, string tenantId, string clientId)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "tenantId",
+ "type": "string"
+ },
+ {
+ "name": "clientId",
+ "type": "string"
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "The asExistingApplication export accepts literal or parameter IDs independently."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Configures this resource to reference an existing Microsoft Entra ID application registration. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " Pass the home tenant ID, not a sign-in keyword such as "
+ },
+ {
+ "kind": "code",
+ "text": "organizations"
+ },
+ {
+ "kind": "text",
+ "text": ". Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.EntraIdResourceExtensions.WithSignInAudience(Aspire.Hosting.ApplicationModel.IResourceBuilder{Aspire.Hosting.Azure.EntraIdApplicationResource},Aspire.Hosting.Azure.EntraIdSignInAudience)"
+ },
+ {
+ "kind": "text",
+ "text": " to allow accounts from other tenants to sign in. "
+ }
+ ]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.EntraIdResourceExtensions.AddEntraIdApplication(Aspire.Hosting.IDistributedApplicationBuilder,System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " enables Azure provisioning before this method is called. This method does not disable that setup, so deployment can still require Azure authentication and provisioning configuration. To reference an existing registration without enabling Azure provisioning, use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.EntraIdResourceExtensions.AddExistingEntraIdApplication(Aspire.Hosting.IDistributedApplicationBuilder,System.String,System.String,System.String)"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ {
+ "kind": "codeblock",
+ "text": "\n var identity = builder.AddEntraIdApplication(\"identity\")\n .AsExistingApplication(\n tenantId: \"aaaabbbb-0000-cccc-1111-dddd2222eeee\",\n clientId: \"00001111-aaaa-2222-bbbb-3333cccc4444\");\n ",
+ "language": "csharp"
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The resource builder for chaining."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ],
+ "clientId": [
+ {
+ "kind": "text",
+ "text": "The registration's application (client) ID."
+ }
+ ],
+ "tenantId": [
+ {
+ "kind": "text",
+ "text": "The registration's home tenant ID, as a GUID or a domain such as "
+ },
+ {
+ "kind": "code",
+ "text": "contoso.onmicrosoft.com"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "A tenant ID or client ID is empty or invalid."
+ }
+ ]
+ },
+ {
+ "type": "T:System.InvalidOperationException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Registration-only configuration is already applied to this resource."
+ }
+ ]
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.EntraId/EntraIdResourceExtensions.cs"
+ },
+ {
+ "name": "PublishWithAppRoleAssignment",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder EntraIdResourceExtensions.PublishWithAppRoleAssignment(this IResourceBuilder builder, IResourceBuilder identity, params string[] roleValues)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "identity",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder"
+ },
+ {
+ "name": "roleValues",
+ "type": "string[]",
+ "modifier": "params"
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "The publishWithAppRoleAssignment export accepts an identity or compute resource using a union."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " When published, assigns application roles of this API to a user-assigned managed identity. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " This explicitly grants access to the identity's service-principal object ID, not its client ID. The caller authenticates directly as its managed identity; no caller registration or federated credential is created. This does not attach the identity to a workload or configure its token acquisition. The API must validate tokens and enforce the required role. "
+ }
+ ]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " Assignments are published only; this has no effect during local run. Removing this call does not revoke a deployed assignment: remove it explicitly with Microsoft Graph or the Entra admin center. Already-issued tokens remain valid until expiration, and managed-identity token caches can delay revocation. "
+ }
+ ]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " Deployment requires the Microsoft Graph permissions "
+ },
+ {
+ "kind": "code",
+ "text": "AppRoleAssignment.ReadWrite.All"
+ },
+ {
+ "kind": "text",
+ "text": " and "
+ },
+ {
+ "kind": "code",
+ "text": "Application.Read.All"
+ },
+ {
+ "kind": "text",
+ "text": " (or a higher permission covering application reads), with administrator consent. Delegated deployments also need a supported Entra directory role. Azure RBAC permissions alone do not authorize directory assignments. See "
+ },
+ {
+ "kind": "href",
+ "value": "https://learn.microsoft.com/graph/api/serviceprincipal-post-approleassignedto"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The API registration builder for chaining."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The API registration builder."
+ }
+ ],
+ "identity": [
+ {
+ "kind": "text",
+ "text": "The managed identity receiving the roles. Workloads attach it with "
+ },
+ {
+ "kind": "code",
+ "text": "WithAzureUserAssignedIdentity"
+ },
+ {
+ "kind": "text",
+ "text": "."
+ }
+ ],
+ "roleValues": [
+ {
+ "kind": "text",
+ "text": "The values of enabled roles declared with "
+ },
+ {
+ "kind": "code",
+ "text": "WithAppRole"
+ },
+ {
+ "kind": "text",
+ "text": " that allow "
+ },
+ {
+ "kind": "code",
+ "text": "Application"
+ },
+ {
+ "kind": "text",
+ "text": " members."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when an argument is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when no roles are supplied or a role is unknown, disabled, or does not allow application members."
+ }
+ ]
+ },
+ {
+ "type": "T:System.InvalidOperationException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when the API references an existing registration."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n var identity = builder.AddAzureUserAssignedIdentity(\"worker-identity\");\n var apiRegistration = builder.AddEntraIdApplication(\"orders-api\")\n .WithApplicationIdUri()\n .WithAppRole(new EntraIdAppRole(\"Orders.Read\", \"Read orders\", \"Read orders.\", [\"Application\"]))\n .PublishWithAppRoleAssignment(identity, \"Orders.Read\");\n var api = builder.AddDotnetProject(\"api\", \"../Api/Api.csproj\")\n .WithReference(apiRegistration);\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.EntraId/EntraIdResourceExtensions.cs",
+ "sourceLines": "2033-2035"
+ },
+ {
+ "name": "PublishWithAppRoleAssignment",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder EntraIdResourceExtensions.PublishWithAppRoleAssignment(this IResourceBuilder builder, IResourceBuilder computeResource, params string[] roleValues)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "computeResource",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder"
+ },
+ {
+ "name": "roleValues",
+ "type": "string[]",
+ "modifier": "params"
+ }
+ ],
+ "genericParameters": [
+ {
+ "name": "T",
+ "constraints": [
+ "Aspire.Hosting.ApplicationModel.IComputeResource"
+ ]
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "The publishWithAppRoleAssignment export accepts an identity or compute resource using a union."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " When published, assigns application roles of this API to a compute resource's user-assigned managed identity. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " The Azure environment reuses the compute resource's attached identity or creates one during deployment preparation. The identity is resolved after preparation; the compute resource need not reference this registration. An excluded compute resource receives no assignment. This does not configure federation or token acquisition. Like the explicit-identity overload, this is publish-only, requires directory assignment privileges, and does not revoke assignments when a call is removed. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The API registration builder for chaining."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The API registration builder."
+ }
+ ],
+ "computeResource": [
+ {
+ "kind": "text",
+ "text": "The compute resource whose managed identity receives the roles."
+ }
+ ],
+ "roleValues": [
+ {
+ "kind": "text",
+ "text": "The values of enabled roles declared with "
+ },
+ {
+ "kind": "code",
+ "text": "WithAppRole"
+ },
+ {
+ "kind": "text",
+ "text": " that allow "
+ },
+ {
+ "kind": "code",
+ "text": "Application"
+ },
+ {
+ "kind": "text",
+ "text": " members."
+ }
+ ]
+ },
+ "typeParameters": {
+ "T": [
+ {
+ "kind": "text",
+ "text": "The type of the compute resource."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.ArgumentNullException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when an argument is null."
+ }
+ ]
+ },
+ {
+ "type": "T:System.ArgumentException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when no roles are supplied or a role is unknown, disabled, or does not allow application members."
+ }
+ ]
+ },
+ {
+ "type": "T:System.InvalidOperationException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "Thrown when the API references an existing registration or the published compute resource has no user-assigned managed identity."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n var worker = builder.AddDotnetProject(\"worker\", \"../Worker/Worker.csproj\");\n var apiRegistration = builder.AddEntraIdApplication(\"orders-api\")\n .WithApplicationIdUri()\n .WithAppRole(new EntraIdAppRole(\"Orders.Read\", \"Read orders\", \"Read orders.\", [\"Application\"]));\n var api = builder.AddDotnetProject(\"api\", \"../Api/Api.csproj\")\n .WithReference(apiRegistration);\n \n apiRegistration.PublishWithAppRoleAssignment(worker, \"Orders.Read\");\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.EntraId/EntraIdResourceExtensions.cs",
+ "sourceLines": "2075-2077"
+ },
+ {
+ "name": "PublishWithFederatedManagedIdentityCredential",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder EntraIdResourceExtensions.PublishWithFederatedManagedIdentityCredential(this IResourceBuilder builder)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "The publishWithFederatedManagedIdentityCredential export selects consumer, compute resource, or explicit identity using a union."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " When published, authenticates this Entra ID application as each referencing resource's own user-assigned managed identity, without a client secret or certificate. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " A single call covers every resource that references this application, including resources that reference it after this call, and the application trusts each resource's own identity. Use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.EntraIdResourceExtensions.PublishWithFederatedManagedIdentityCredential``1(Aspire.Hosting.ApplicationModel.IResourceBuilder{Aspire.Hosting.Azure.EntraIdApplicationResource},Aspire.Hosting.ApplicationModel.IResourceBuilder{``0})"
+ },
+ {
+ "kind": "text",
+ "text": " to trust a single resource instead. The method adds one credential entry to the application's configuration, and Aspire creates one federated identity credential on the registration for each trusted identity. "
+ }
+ ]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " Every resource that references this application with "
+ },
+ {
+ "kind": "code",
+ "text": "WithReference"
+ },
+ {
+ "kind": "text",
+ "text": " is given a managed identity when published, and the application trusts it. The identity is the one the resource already has, for example from "
+ },
+ {
+ "kind": "code",
+ "text": "WithAzureUserAssignedIdentity"
+ },
+ {
+ "kind": "text",
+ "text": " or because it references other Azure resources; otherwise the Azure environment creates one. For an application that Aspire creates, Aspire adds a federated identity credential to the registration for each identity: the issuer is the tenant's v2.0 endpoint, the subject is the identity's object (principal) ID, and the audience is the token exchange audience of the application's cloud. The resource receives the identity's client ID as "
+ },
+ {
+ "kind": "code",
+ "text": "ManagedIdentityClientId"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " This is only for registrations that Aspire creates. For an existing registration ("
+ },
+ {
+ "kind": "code",
+ "text": "AddExistingEntraIdApplication"
+ },
+ {
+ "kind": "text",
+ "text": "), which Aspire never modifies, this method throws; use "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.EntraIdResourceExtensions.WithFederatedManagedIdentityCredential(Aspire.Hosting.ApplicationModel.IResourceBuilder{Aspire.Hosting.Azure.EntraIdApplicationResource},System.String)"
+ },
+ {
+ "kind": "text",
+ "text": " instead. "
+ }
+ ]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " Managed identities exist only in Azure, so the credential is not used when running locally. Add another credential, such as a client secret, for local development. Supported clouds are Azure public, Azure US Government and Azure China. Only user-assigned managed identities are supported. See "
+ },
+ {
+ "kind": "href",
+ "value": "https://learn.microsoft.com/entra/workload-id/workload-identity-federation-config-app-trust-managed-identity"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The resource builder for chaining."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ]
+ },
+ "examples": [
+ {
+ "code": "\n var entra = builder.AddEntraIdApplication(\"entra-web\")\n .PublishWithFederatedManagedIdentityCredential();\n \n builder.AddDotnetProject(\"web\", \"../Web/Web.csproj\")\n .WithReference(entra);\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.EntraId/EntraIdResourceExtensions.cs",
+ "sourceLines": "868-887"
+ },
+ {
+ "name": "PublishWithFederatedManagedIdentityCredential",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder EntraIdResourceExtensions.PublishWithFederatedManagedIdentityCredential(this IResourceBuilder builder, IResourceBuilder computeResource)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "computeResource",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder"
+ }
+ ],
+ "genericParameters": [
+ {
+ "name": "T",
+ "constraints": [
+ "Aspire.Hosting.ApplicationModel.IComputeResource"
+ ]
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "The publishWithFederatedManagedIdentityCredential export selects consumer, compute resource, or explicit identity using a union."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " When published, authenticates this Entra ID application as a compute resource's user-assigned managed identity, without a client secret or certificate. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " Only "
+ },
+ {
+ "kind": "paramref",
+ "value": "computeResource"
+ },
+ {
+ "kind": "text",
+ "text": "'s identity is trusted, and only it receives the managed identity credential. The resource's identity is resolved after the Azure environment has prepared it, as described in "
+ },
+ {
+ "kind": "cref",
+ "value": "M:Aspire.Hosting.EntraIdResourceExtensions.PublishWithFederatedManagedIdentityCredential(Aspire.Hosting.ApplicationModel.IResourceBuilder{Aspire.Hosting.Azure.EntraIdApplicationResource})"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The resource builder for chaining."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ],
+ "computeResource": [
+ {
+ "kind": "text",
+ "text": " The compute resource to trust. It must reference this application with "
+ },
+ {
+ "kind": "code",
+ "text": "WithReference"
+ },
+ {
+ "kind": "text",
+ "text": ". Only this resource receives the managed identity credential. "
+ }
+ ]
+ },
+ "typeParameters": {
+ "T": [
+ {
+ "kind": "text",
+ "text": "The type of the compute resource."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.InvalidOperationException",
+ "description": [
+ {
+ "kind": "text",
+ "text": " Thrown when the registration is existing or "
+ },
+ {
+ "kind": "paramref",
+ "value": "computeResource"
+ },
+ {
+ "kind": "text",
+ "text": " does not reference this application. "
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n var entra = builder.AddEntraIdApplication(\"entra-web\");\n var web = builder.AddDotnetProject(\"web\", \"../Web/Web.csproj\")\n .WithReference(entra);\n \n entra.PublishWithFederatedManagedIdentityCredential(web);\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.EntraId/EntraIdResourceExtensions.cs",
+ "sourceLines": "924-943"
+ },
+ {
+ "name": "PublishWithFederatedManagedIdentityCredential",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder EntraIdResourceExtensions.PublishWithFederatedManagedIdentityCredential(this IResourceBuilder builder, IResourceBuilder identity)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ },
+ {
+ "name": "identity",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder"
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportIgnoreAttribute",
+ "arguments": {
+ "Reason": "The publishWithFederatedManagedIdentityCredential export selects consumer, compute resource, or explicit identity using a union."
+ }
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " When published, authenticates this Entra ID application as a specific user-assigned managed identity, without a client secret or certificate. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "text",
+ "text": " The federated identity credential uses the identity's principal ID as the subject and consumers receive its client ID. Throws for an existing registration, which Aspire never modifies. The credential is not used when running locally. "
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The resource builder for chaining."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ],
+ "identity": [
+ {
+ "kind": "text",
+ "text": " The user-assigned managed identity to trust. Every resource that references this application must use it, for example with "
+ },
+ {
+ "kind": "code",
+ "text": "WithAzureUserAssignedIdentity"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ "examples": [
+ {
+ "code": "\n var identity = builder.AddAzureUserAssignedIdentity(\"web-identity\");\n var entra = builder.AddEntraIdApplication(\"entra-web\")\n .PublishWithFederatedManagedIdentityCredential(identity);\n \n builder.AddDotnetProject(\"web\", \"../Web/Web.csproj\")\n .WithAzureUserAssignedIdentity(identity)\n .WithReference(entra);\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.EntraId/EntraIdResourceExtensions.cs",
+ "sourceLines": "977-995"
+ },
+ {
+ "name": "RunWithLocalDeveloperCertificateCredential",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder EntraIdResourceExtensions.RunWithLocalDeveloperCertificateCredential(this IResourceBuilder builder)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "modifier": "this"
+ }
+ ],
+ "attributes": [
+ {
+ "name": "Aspire.Hosting.AspireExportAttribute"
+ }
+ ],
+ "docs": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": " Creates and provisions a short-lived certificate credential for local development. "
+ }
+ ],
+ "remarks": [
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " Each application gets a dedicated certificate in the AppHost's local store. Certificates last two days; on a subsequent run, a certificate with one day or less remaining is replaced by overwriting its PFX file. Only the public certificate is provisioned in Entra. Referencing applications receive the private credential as a secret "
+ },
+ {
+ "kind": "code",
+ "text": "Base64EncodedValue"
+ },
+ {
+ "kind": "text",
+ "text": " in Microsoft.Identity.Web's "
+ },
+ {
+ "kind": "code",
+ "text": "ClientCredentials"
+ },
+ {
+ "kind": "text",
+ "text": " configuration. Aspire replaces the registration's entire "
+ },
+ {
+ "kind": "code",
+ "text": "keyCredentials"
+ },
+ {
+ "kind": "text",
+ "text": " collection with the selected certificate. Existing certificate credentials are not retained, so older sessions must restart after renewal. "
+ }
+ ]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " Development and production must use separate Entra registrations. Never register developer certificates on a production application. Different resource groups do not isolate tenant-scoped registrations: use distinct registration names or tenant-resource suffixes. This method does not provision or emit a credential when publishing; omitting a credential from publish does not revoke a key previously registered against the same application. In either mode, this configuration prevents conversion to an existing registration with "
+ },
+ {
+ "kind": "code",
+ "text": "AsExistingApplication"
+ },
+ {
+ "kind": "text",
+ "text": ". "
+ }
+ ]
+ },
+ {
+ "kind": "para",
+ "children": [
+ {
+ "kind": "text",
+ "text": " Renewal is checked at AppHost startup, not in the background. Restart long-running development sessions before the certificate expires. Use "
+ },
+ {
+ "kind": "code",
+ "text": "PublishWithFederatedManagedIdentityCredential"
+ },
+ {
+ "kind": "text",
+ "text": " for deployed workloads. "
+ }
+ ]
+ }
+ ],
+ "returns": [
+ {
+ "kind": "text",
+ "text": "The resource builder for chaining."
+ }
+ ],
+ "parameters": {
+ "builder": [
+ {
+ "kind": "text",
+ "text": "The resource builder."
+ }
+ ]
+ },
+ "exceptions": [
+ {
+ "type": "T:System.InvalidOperationException",
+ "description": [
+ {
+ "kind": "text",
+ "text": "The registration is an existing application, which Aspire never modifies."
+ }
+ ]
+ }
+ ],
+ "examples": [
+ {
+ "code": "\n // Use different Azure:TenantResourceSuffix values for development and production.\n var entra = builder.AddEntraIdApplication(\"entra-web\")\n .RunWithLocalDeveloperCertificateCredential()\n .PublishWithFederatedManagedIdentityCredential();\n \n builder.AddDotnetProject(\"web\", \"../Web/Web.csproj\").WithReference(entra);\n ",
+ "language": "csharp"
+ }
+ ]
+ },
+ "sourceFile": "src/Aspire.Hosting.Azure.EntraId/EntraIdResourceExtensions.cs",
+ "sourceLines": "687-700"
+ },
+ {
+ "name": "WithAdminConsent",
+ "kind": "method",
+ "accessibility": "public",
+ "signature": "public static IResourceBuilder EntraIdResourceExtensions.WithAdminConsent(this IResourceBuilder builder, IResourceBuilder api, params string[] scopeNames)",
+ "returnType": "Aspire.Hosting.ApplicationModel.IResourceBuilder",
+ "isStatic": true,
+ "isExtension": true,
+ "parameters": [
+ {
+ "name": "builder",
+ "type": "Aspire.Hosting.ApplicationModel.IResourceBuilder