Skip to content

Commit 425e26b

Browse files
adding back xrefs (#4158)
* adding back xrefs * adding back xrefs pt 2 * adding back xrefs pt 2 * adding back xrefs pt 2 * adding back xrefs pt 2 * adding back xrefs pt 293487 * Fix learn link * Fix learn links --------- Co-authored-by: Andy (Steve) De George <[email protected]> Co-authored-by: Andy De George (from Dev Box) <[email protected]>
1 parent afc6d53 commit 425e26b

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/whats-new/dotnet-aspire-9.4.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The `aspire deploy` command supports extensible deployment workflows through the
108108

109109
**Key capabilities:**
110110

111-
- **Custom deployment hooks** using `Aspire.Hosting.Publishing.DeployingCallbackAnnotation` to execute custom logic during the `aspire deploy` command
111+
- **Custom deployment hooks** using <xref:Aspire.Hosting.ApplicationModel.DeployingCallbackAnnotation> to execute custom logic during the `aspire deploy` command
112112
- **Workflow activity reporting** via the <xref:Aspire.Hosting.Publishing.IPublishingActivityReporter> to support progress notifications and prompting in commmands
113113
- **Integration with publish** - `aspire deploy` runs `Aspire.Hosting.Publishing.PublishingCallbackAnnotations` to support deploying artifacts emitted by publish steps, if applicable
114114

@@ -199,7 +199,7 @@ This custom deployment logic executes as follows from the `aspire deploy` comman
199199
Now, integration owners can create sophisticated `aspire deploy` workflows. This work also provides a foundation for advanced deployment automation scenarios.
200200

201201
> [!NOTE]
202-
> While the `Aspire.Hosting.Publishing.DeployingCallbackAnnotation` API is available in .NET Aspire 9.4, there are currently no built-in resources that natively support deployment callbacks. Built-in resource support for deployment callbacks will be added in the next version of .NET Aspire.
202+
> While the <xref:Aspire.Hosting.ApplicationModel.DeployingCallbackAnnotation> API is available in .NET Aspire 9.4, there are currently no built-in resources that natively support deployment callbacks. Built-in resource support for deployment callbacks will be added in the next version of .NET Aspire.
203203
204204
> [!IMPORTANT]
205205
> 🧪 **Feature Flag**: The `aspire deploy` command is behind a feature flag and **disabled by default** in this release. It must be explicitly enabled for use with `aspire config set features.deployCommandEnabled true`
@@ -533,7 +533,7 @@ builder.Build().Run();
533533

534534
**Enhanced capabilities:**
535535

536-
- **Improved lifecycle coordination** between `Aspire.Hosting.ResourceBuilderExtensions.WithExplicitStart` and `ContainerLifetime.Persistent`
536+
- **Improved lifecycle coordination** between <xref:Aspire.Hosting.ResourceBuilderExtensions.WithExplicitStart*> and `ContainerLifetime.Persistent`
537537
- **Automatic persistent networking** spun up when persistent containers are detected
538538
- **Container delay start** for more reliable startup sequencing
539539
- **Network isolation** between persistent and session-scoped containers, which now use separate networks for better resource management
@@ -542,7 +542,7 @@ This will greatly improve your experience while building stateful services that
542542

543543
### 🎛️ Resource command service
544544

545-
.NET Aspire 9.4 introduces `Aspire.Hosting.ApplicationModel.ResourceCommandService`, an API for executing commands against resources. You can now easily execute the commands that appear in the dashboard programmatically. For example, when writing unit tests for commands, or having other integrations in Aspire execute commands.
545+
.NET Aspire 9.4 introduces <xref:Aspire.Hosting.ApplicationModel.ResourceCommandService>, an API for executing commands against resources. You can now easily execute the commands that appear in the dashboard programmatically. For example, when writing unit tests for commands, or having other integrations in Aspire execute commands.
546546

547547
The example below uses `ResourceCommandService` to have a command execute other commands.
548548

@@ -638,7 +638,7 @@ public async Task Should_ResetCache_WhenTestStarts()
638638

639639
### 🔄 Resource lifecycle events
640640

641-
.NET Aspire 9.4 introduces convenient extension methods on `Aspire.Hosting.ApplicationModel.IResourceBuilder` that make it much easier to subscribe to [lifecycle events](../app-host/eventing.md#app-host-life-cycle-events) directly on resources, providing a cleaner and more intuitive API.
641+
.NET Aspire 9.4 introduces convenient extension methods on <xref:Aspire.Hosting.ApplicationModel.IResourceBuilder`1> that make it much easier to subscribe to [lifecycle events](../app-host/eventing.md#app-host-life-cycle-events) directly on resources, providing a cleaner and more intuitive API.
642642

643643
```csharp
644644
var builder = DistributedApplication.CreateBuilder(args);
@@ -704,11 +704,11 @@ builder.Build().Run();
704704

705705
**Available lifecycle events:**
706706

707-
- `OnInitializeResource` - Called during early resource initialization
708-
- `OnBeforeResourceStarted` - Called before the resource starts
709-
- `OnConnectionStringAvailable` - Called when connection strings are resolved (requires `IResourceWithConnectionString`)
710-
- `OnResourceEndpointsAllocated` - Called when resource endpoints are allocated (requires `IResourceWithEndpoints`)
711-
- `OnResourceReady` - Called when the resource is fully ready
707+
- <xref:Aspire.Hosting.EventingExtensions.OnInitializeResource*> - Called during early resource initialization
708+
- <xref:Aspire.Hosting.EventingExtensions.OnBeforeResourceStarted*> - Called before the resource starts
709+
- <xref:Aspire.Hosting.EventingExtensions.OnConnectionStringAvailable*> - Called when connection strings are resolved (requires `IResourceWithConnectionString`)
710+
- <xref:Aspire.Hosting.EventingExtensions.OnResourceEndpointsAllocated*> - Called when resource endpoints are allocated (requires `IResourceWithEndpoints`)
711+
- <xref:Aspire.Hosting.EventingExtensions.OnResourceReady*> - Called when the resource is fully ready
712712

713713
The new chainable fluent API, strongly-typed callbacks, and simplified syntax make it intuitive to hook into your resource lifecycles for interactions, commands, custom scripts, and more.
714714

@@ -920,7 +920,7 @@ Aspire only shows notifications when a newer version is available, and the check
920920

921921
Connection strings:
922922

923-
- Appear in the **resource details** panel for any resource that implements `IResourceWithConnectionString`
923+
- Appear in the **resource details** panel for any resource that implements <xref:Aspire.Hosting.ApplicationModel.IResourceWithConnectionString>
924924
- Values are marked as **sensitive** and can be toggled for visibility in the dashboard
925925
- Supports all resource types including databases, message brokers, and custom resources
926926

@@ -1042,7 +1042,7 @@ builder.Build().Run();
10421042

10431043
##### Azure AI Foundry Local support
10441044

1045-
[Azure AI Foundry Local](https://learn.microsoft.com/azure/ai-foundry/foundry-local/) is an on-device AI inference solution that runs models locally on your hardware, providing performance, privacy, and cost advantages without requiring an Azure subscription. It's ideal for scenarios requiring data privacy, offline operation, cost reduction, or low-latency responses.
1045+
[Azure AI Foundry Local](/azure/ai-foundry/foundry-local/) is an on-device AI inference solution that runs models locally on your hardware, providing performance, privacy, and cost advantages without requiring an Azure subscription. It's ideal for scenarios requiring data privacy, offline operation, cost reduction, or low-latency responses.
10461046

10471047
```csharp
10481048
var builder = DistributedApplication.CreateBuilder(args);
@@ -1109,7 +1109,7 @@ builder.AddOpenAIClient("chat")
11091109
- **Azure AI Foundry** - Cloud-hosted models with enterprise-grade scaling, supports all Azure AI model deployments
11101110
- **Foundry Local** - On-device inference with different model selection optimized for local hardware, no Azure subscription required
11111111

1112-
The `RunAsFoundryLocal()` method enables local development scenarios using [Azure AI Foundry Local](https://learn.microsoft.com/azure/ai-foundry/foundry-local/), allowing you to test AI capabilities without requiring cloud resources during development. This supports automatic model downloading, loading, and management through the integrated Foundry Local runtime.
1112+
The `RunAsFoundryLocal()` method enables local development scenarios using [Azure AI Foundry Local](/azure/ai-foundry/foundry-local/), allowing you to test AI capabilities without requiring cloud resources during development. This supports automatic model downloading, loading, and management through the integrated Foundry Local runtime.
11131113

11141114
### 🗄️ Database hosting improvements
11151115

@@ -1139,7 +1139,7 @@ All database providers now support `WithInitFiles()` method, replacing the more
11391139

11401140
### 🏷️ Consistent resource name exposure
11411141

1142-
.NET Aspire 9.4 now consistently exposes the actual names of all Azure resources through `Aspire.Hosting.Azure.NameOutputReference` property. This enables applications to access the real Azure resource names that get generated during deployment, which is essential for scenarios requiring direct Azure resource coordination. This is particularly valuable for external automation scripts and monitoring and alerting systems that reference resources by their actual names.
1142+
.NET Aspire 9.4 now consistently exposes the actual names of all Azure resources through the `NameOutputReference` property. This enables applications to access the real Azure resource names that get generated during deployment, which is essential for scenarios requiring direct Azure resource coordination. This is particularly valuable for external automation scripts and monitoring and alerting systems that reference resources by their actual names.
11431143

11441144
### 🗄️ Azure Cosmos DB
11451145

@@ -1174,7 +1174,7 @@ builder.Build().Run();
11741174
- **Better data distribution** for multi-dimensional datasets
11751175
- **Enhanced scalability** up to 10,000+ RU/s per logical partition prefix
11761176

1177-
For detailed guidance on design patterns and best practices, see the [Azure Cosmos DB hierarchical partition keys documentation](https://learn.microsoft.com/azure/cosmos-db/hierarchical-partition-keys).
1177+
For detailed guidance on design patterns and best practices, see the [Azure Cosmos DB hierarchical partition keys documentation](/azure/cosmos-db/hierarchical-partition-keys).
11781178

11791179
#### Serverless support
11801180

@@ -1199,7 +1199,7 @@ var provisionedCosmos = builder.AddAzureCosmosDB("cosmos")
11991199
**Use serverless for:** Variable workloads, development/testing, applications with low average-to-peak traffic ratios.
12001200
**Use provisioned throughput for:** Sustained traffic requiring predictable performance guarantees.
12011201

1202-
For detailed comparison and limits, see [Azure Cosmos DB serverless documentation](https://learn.microsoft.com/azure/cosmos-db/serverless).
1202+
For detailed comparison and limits, see [Azure Cosmos DB serverless documentation](/azure/cosmos-db/serverless).
12031203

12041204
### 🆔 Consistent user-assigned managed identity support
12051205

@@ -1293,8 +1293,8 @@ var webApi = builder.AddProject<Projects.WebAPI>("webapi")
12931293

12941294
**Key features**:
12951295

1296-
- `Aspire.Hosting.Azure.KeyVault.AzureKeyVaultResourceExtensions.AddSecret` method for adding new secrets to Key Vault from parameters or expressions
1297-
- `Aspire.Hosting.Azure.KeyVault.AzureKeyVaultResourceExtensions.GetSecret` method for referencing existing secrets in Key Vault
1296+
- <xref:Aspire.Hosting.AzureKeyVaultResourceExtensions.AddSecret*> method for adding new secrets to Key Vault from parameters or expressions
1297+
- <xref:Aspire.Hosting.Azure.AzureKeyVaultResource.GetSecret*> method for referencing existing secrets in Key Vault
12981298
- **Strongly-typed secret references** that can be used with `WithEnvironment()` for environment variables
12991299
- **Custom secret naming** support with optional `secretName` parameter
13001300

@@ -1819,7 +1819,7 @@ var resource = builder.AddAzureInfrastructure("custom", infra =>
18191819
});
18201820
```
18211821

1822-
**Migration impact**: Replace auto-injected parameters with explicit resource modeling for better resource graph representation and support for multiple Azure compute environments. See [Azure resource customization docs](https://learn.microsoft.com/dotnet/aspire/azure/customize-azure-resources) for more details.
1822+
**Migration impact**: Replace auto-injected parameters with explicit resource modeling for better resource graph representation and support for multiple Azure compute environments. See [Azure resource customization docs](/dotnet/aspire/azure/customize-azure-resources) for more details.
18231823

18241824
### 🔧 ParameterResource.Value synchronous behavior change
18251825

0 commit comments

Comments
 (0)