Skip to content

Commit eab9d30

Browse files
authored
.NET Aspire - Release 8.2 Content (#1484)
1 parent b7124e5 commit eab9d30

File tree

151 files changed

+1346
-1131
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

151 files changed

+1346
-1131
lines changed

Diff for: .openpublishing.redirection.json

+170-6
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,31 @@
66
},
77
{
88
"source_path_from_root": "/docs/storage/azure-storage.md",
9-
"redirect_url": "/dotnet/aspire/storage/azure-storage-components"
9+
"redirect_url": "/dotnet/aspire/storage/azure-storage-integrations"
1010
},
1111
{
1212
"source_path_from_root": "/docs/database/quickstart-sql-server.md",
13-
"redirect_url": "/dotnet/aspire/database/sql-server-components"
13+
"redirect_url": "/dotnet/aspire/database/sql-server-integrations"
1414
},
1515
{
1616
"source_path_from_root": "/docs/get-started/quickstart-build-your-first-aspire-app.md",
1717
"redirect_url": "/dotnet/aspire/get-started/build-your-first-aspire-app"
1818
},
1919
{
2020
"source_path_from_root": "/docs/messaging/quickstart-messaging.md",
21-
"redirect_url": "/dotnet/aspire/messaging/messaging-components"
21+
"redirect_url": "/dotnet/aspire/messaging/messaging-integrations"
2222
},
2323
{
2424
"source_path_from_root": "/docs/caching/quickstart-caching.md",
25-
"redirect_url": "/dotnet/aspire/caching/caching-components"
25+
"redirect_url": "/dotnet/aspire/caching/caching-integrations"
2626
},
2727
{
2828
"source_path_from_root": "/docs/app-host-overview.md",
2929
"redirect_url": "/dotnet/aspire/fundamentals/app-host-overview"
3030
},
3131
{
3232
"source_path_from_root": "/docs/components-overview.md",
33-
"redirect_url": "/dotnet/aspire/fundamentals/components-overview"
33+
"redirect_url": "/dotnet/aspire/fundamentals/integrations-overview"
3434
},
3535
{
3636
"source_path_from_root": "/docs/dashboard.md",
@@ -58,7 +58,11 @@
5858
},
5959
{
6060
"source_path_from_root": "/docs/openai/azureai-openai-component.md",
61-
"redirect_url": "/dotnet/aspire/azureai/azureai-openai-component"
61+
"redirect_url": "/dotnet/aspire/azureai/azureai-openai-integration"
62+
},
63+
{
64+
"source_path_from_root": "/docs/azureai/azureai-openai-component.md",
65+
"redirect_url": "/dotnet/aspire/azureai/azureai-openai-integration"
6266
},
6367
{
6468
"source_path_from_root": "/docs/troubleshooting/allowunsecuredtransport.md",
@@ -87,6 +91,166 @@
8791
{
8892
"source_path_from_root": "/docs/whats-new/preview-7.md",
8993
"redirect_url": "/dotnet/aspire"
94+
},
95+
{
96+
"source_path_from_root": "/docs/authentication/keycloak-component.md",
97+
"redirect_url": "/dotnet/aspire/authentication/keycloak-integration"
98+
},
99+
{
100+
"source_path_from_root": "/docs/azureai/azureai-search-document-component.md",
101+
"redirect_url": "/dotnet/aspire/azureai/azureai-search-document-integration"
102+
},
103+
{
104+
"source_path_from_root": "/docs/caching/caching-components-deployment.md",
105+
"redirect_url": "/dotnet/aspire/caching/caching-integrations-deployment"
106+
},
107+
{
108+
"source_path_from_root": "/docs/caching/caching-components.md",
109+
"redirect_url": "/dotnet/aspire/caching/caching-integrations"
110+
},
111+
{
112+
"source_path_from_root": "/docs/caching/stackexchange-redis-component.md",
113+
"redirect_url": "/dotnet/aspire/caching/stackexchange-redis-integration"
114+
},
115+
{
116+
"source_path_from_root": "/docs/caching/stackexchange-redis-distributed-caching-component.md",
117+
"redirect_url": "/dotnet/aspire/caching/stackexchange-redis-distributed-caching-integration"
118+
},
119+
{
120+
"source_path_from_root": "/docs/caching/stackexchange-redis-output-caching-component.md",
121+
"redirect_url": "/dotnet/aspire/caching/stackexchange-redis-output-caching-integration"
122+
},
123+
{
124+
"source_path_from_root": "/docs/database/azure-cosmos-db-component.md",
125+
"redirect_url": "/dotnet/aspire/database/azure-cosmos-db-integration"
126+
},
127+
{
128+
"source_path_from_root": "/docs/database/azure-cosmos-db-entity-framework-component.md",
129+
"redirect_url": "/dotnet/aspire/database/azure-cosmos-db-entity-framework-integration"
130+
},
131+
{
132+
"source_path_from_root": "/docs/database/milvus-component.md",
133+
"redirect_url": "/dotnet/aspire/database/milvus-integration"
134+
},
135+
{
136+
"source_path_from_root": "/docs/database/mongodb-component.md",
137+
"redirect_url": "/dotnet/aspire/database/mongodb-integration"
138+
},
139+
{
140+
"source_path_from_root": "/docs/database/mysql-component.md",
141+
"redirect_url": "/dotnet/aspire/database/mysql-integration"
142+
},
143+
{
144+
"source_path_from_root": "/docs/database/mysql-entity-framework-component.md",
145+
"redirect_url": "/dotnet/aspire/database/mysql-entity-framework-integration"
146+
},
147+
{
148+
"source_path_from_root": "/docs/database/oracle-entity-framework-component.md",
149+
"redirect_url": "/dotnet/aspire/database/oracle-entity-framework-integration"
150+
},
151+
{
152+
"source_path_from_root": "/docs/database/postgresql-component.md",
153+
"redirect_url": "/dotnet/aspire/database/postgresql-integration"
154+
},
155+
{
156+
"source_path_from_root": "/docs/database/postgresql-entity-framework-component.md",
157+
"redirect_url": "/dotnet/aspire/database/postgresql-entity-framework-integration"
158+
},
159+
{
160+
"source_path_from_root": "/docs/database/qdrant-component.md",
161+
"redirect_url": "/dotnet/aspire/database/qdrant-integration"
162+
},
163+
{
164+
"source_path_from_root": "/docs/database/sql-server-component-deployment.md",
165+
"redirect_url": "/dotnet/aspire/database/sql-server-integration-deployment"
166+
},
167+
{
168+
"source_path_from_root": "/docs/database/sql-server-component.md",
169+
"redirect_url": "/dotnet/aspire/database/sql-server-integration"
170+
},
171+
{
172+
"source_path_from_root": "/docs/database/sql-server-components.md",
173+
"redirect_url": "/dotnet/aspire/database/sql-server-integrations"
174+
},
175+
{
176+
"source_path_from_root": "/docs/database/sql-server-entity-framework-component.md",
177+
"redirect_url": "/dotnet/aspire/database/sql-server-entity-framework-integration"
178+
},
179+
{
180+
"source_path_from_root": "/docs/extensibility/custom-component.md",
181+
"redirect_url": "/dotnet/aspire/extensibility/custom-integration"
182+
},
183+
{
184+
"source_path_from_root": "/docs/extensibility/implement-auth-from-resource-to-component.md",
185+
"redirect_url": "/dotnet/aspire/extensibility/implement-auth-from-resource-to-integration"
186+
},
187+
{
188+
"source_path_from_root": "/docs/fundamentals/components-overview.md",
189+
"redirect_url": "/dotnet/aspire/fundamentals/integrations-overview"
190+
},
191+
{
192+
"source_path_from_root": "/docs/includes/component-health-checks.md",
193+
"redirect_url": "/dotnet/includes/integration-health-checks"
194+
},
195+
{
196+
"source_path_from_root": "/docs/includes/component-observability-and-telemetry.md",
197+
"redirect_url": "/dotnet/includes/integration-observability-and-telemetry"
198+
},
199+
{
200+
"source_path_from_root": "/docs/logging/seq-component.md",
201+
"redirect_url": "/dotnet/aspire/logging/seq-integration"
202+
},
203+
{
204+
"source_path_from_root": "/docs/messaging/azure-event-hubs-component.md",
205+
"redirect_url": "/dotnet/aspire/messaging/azure-event-hubs-integration"
206+
},
207+
{
208+
"source_path_from_root": "/docs/messaging/azure-service-bus-component.md",
209+
"redirect_url": "/dotnet/aspire/messaging/azure-service-bus-integration"
210+
},
211+
{
212+
"source_path_from_root": "/docs/messaging/azure-web-pubsub-component.md",
213+
"redirect_url": "/dotnet/aspire/messaging/azure-web-pubsub-integration"
214+
},
215+
{
216+
"source_path_from_root": "/docs/messaging/kafka-component.md",
217+
"redirect_url": "/dotnet/aspire/messaging/kafka-integration"
218+
},
219+
{
220+
"source_path_from_root": "/docs/messaging/messaging-components.md",
221+
"redirect_url": "/dotnet/aspire/messaging/messaging-integrations"
222+
},
223+
{
224+
"source_path_from_root": "/docs/messaging/nats-component.md",
225+
"redirect_url": "/dotnet/aspire/messaging/nats-integration"
226+
},
227+
{
228+
"source_path_from_root": "/docs/messaging/rabbitmq-client-component.md ",
229+
"redirect_url": "/dotnet/aspire/messaging/rabbitmq-client-integration"
230+
},
231+
{
232+
"source_path_from_root": "/docs/search/elasticsearch-component.md",
233+
"redirect_url": "/dotnet/aspire/search/elasticsearch-integration"
234+
},
235+
{
236+
"source_path_from_root": "/docs/security/azure-security-key-vault-component.md",
237+
"redirect_url": "/dotnet/aspire/security/azure-security-key-vault-integration"
238+
},
239+
{
240+
"source_path_from_root": "/docs/storage/azure-storage-components.md",
241+
"redirect_url": "/dotnet/aspire/storage/azure-storage-integrations"
242+
},
243+
{
244+
"source_path_from_root": "/docs/storage/azure-storage-blobs-component.md",
245+
"redirect_url": "/dotnet/aspire/storage/azure-storage-blobs-integration"
246+
},
247+
{
248+
"source_path_from_root": "/docs/storage/azure-storage-queues-component.md",
249+
"redirect_url": "/dotnet/aspire/storage/azure-storage-queues-integration"
250+
},
251+
{
252+
"source_path_from_root": "/docs/storage/azure-storage-tables-component.md",
253+
"redirect_url": "/dotnet/aspire/storage/azure-storage-tables-integration"
90254
}
91255
]
92256
}

Diff for: docfx.json

+1
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@
167167
"Linux",
168168
"localhost",
169169
"MailDev",
170+
"Milvus",
170171
"MongoDB",
171172
"MySQL",
172173
"NATS",

Diff for: docs/authentication/keycloak-component.md renamed to docs/authentication/keycloak-integration.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: .NET Aspire Keycloak component
3-
description: This article describes the .NET Aspire Keycloak component.
2+
title: .NET Aspire Keycloak integration
3+
description: This article describes the .NET Aspire Keycloak integration.
44
ms.topic: how-to
5-
ms.date: 07/23/2024
5+
ms.date: 08/12/2024
66
---
77

8-
# .NET Aspire Keycloak component
8+
# .NET Aspire Keycloak integration
99

10-
In this article, you learn how to use the .NET Aspire Keycloak component. The `Aspire.Keycloak.Authentication` library registers JwtBearer and OpenId Connect authentication handlers in the DI container for connecting to a Keycloak server.
10+
In this article, you learn how to use the .NET Aspire Keycloak integration. The `Aspire.Keycloak.Authentication` library registers JwtBearer and OpenId Connect authentication handlers in the DI container for connecting to a Keycloak server.
1111

1212
## Prerequisites
1313

@@ -18,7 +18,7 @@ In this article, you learn how to use the .NET Aspire Keycloak component. The `A
1818

1919
## Get started
2020

21-
To get started with the .NET Aspire Keycloak component, install the [Aspire.Keycloak.Authentication](https://www.nuget.org/packages/Aspire.Keycloak.Authentication) NuGet package in the consuming client project.
21+
To get started with the .NET Aspire Keycloak integration, install the [Aspire.Keycloak.Authentication](https://www.nuget.org/packages/Aspire.Keycloak.Authentication) NuGet package in the client-consuming project, i.e., the project for the application that uses the Keycloak client.
2222

2323
### [.NET CLI](#tab/dotnet-cli)
2424

@@ -130,5 +130,5 @@ builder.Services.AddAuthentication(oidcScheme)
130130
## See also
131131

132132
- [Keycloak](https://www.keycloak.org/)
133-
- [.NET Aspire components](../fundamentals/components-overview.md)
133+
- [.NET Aspire integrations](../fundamentals/integrations-overview.md)
134134
- [.NET Aspire GitHub repo](https://github.com/dotnet/aspire)

Diff for: docs/azureai/azureai-openai-component.md renamed to docs/azureai/azureai-openai-integration.md

+13-26
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: .NET Aspire Azure AI OpenAI component
3-
description: Learn how to use the .NET Aspire Azure AI OpenAI component.
2+
title: .NET Aspire Azure AI OpenAI integration
3+
description: Learn how to use the .NET Aspire Azure AI OpenAI integration.
44
ms.topic: how-to
5-
ms.date: 08/20/2024
5+
ms.date: 08/12/2024
66
---
77

8-
# .NET Aspire Azure AI OpenAI component
8+
# .NET Aspire Azure AI OpenAI integration
99

1010
In this article, you learn how to use the .NET Aspire Azure AI OpenAI client. The `Aspire.Azure.AI.OpenAI` library is used to register an `OpenAIClient` in the dependency injection (DI) container for consuming Azure AI OpenAI or OpenAI functionality. It enables corresponding logging and telemetry.
1111

@@ -16,7 +16,7 @@ For more information on using the `OpenAIClient`, see [Quickstart: Get started g
1616
- Azure subscription: [create one for free](https://azure.microsoft.com/free/).
1717
- Azure AI OpenAI or OpenAI account: [create an Azure OpenAI Service resource](/azure/ai-services/openai/how-to/create-resource).
1818

19-
To get started with the .NET Aspire Azure AI OpenAI component, install the [Aspire.Azure.AI.OpenAI](https://www.nuget.org/packages/Aspire.Azure.AI.OpenAI) NuGet package in the consuming client project.
19+
To get started with the .NET Aspire Azure AI OpenAI integration, install the [Aspire.Azure.AI.OpenAI](https://www.nuget.org/packages/Aspire.Azure.AI.OpenAI) NuGet package in the client-consuming project, i.e., the project for the application that uses the Azure AI OpenAI client.
2020

2121
### [.NET CLI](#tab/dotnet-cli)
2222

@@ -37,7 +37,7 @@ For more information, see [dotnet add package](/dotnet/core/tools/dotnet-add-pac
3737

3838
## Example usage
3939

40-
In the _:::no-loc text="Program.cs":::_ file of your component-consuming project, call the extension method to register an `OpenAIClient` for use via the dependency injection container. The method takes a connection name parameter.
40+
In the _:::no-loc text="Program.cs":::_ file of your client-consuming project, call the extension method to register an `OpenAIClient` for use via the dependency injection container. The method takes a connection name parameter.
4141

4242
```csharp
4343
builder.AddAzureOpenAIClient("openAiConnectionName");
@@ -84,28 +84,15 @@ builder.AddProject<Projects.ExampleProject>()
8484
.WithReference(openai);
8585
```
8686

87-
The `AddAzureOpenAI` method reads connection information from the app host's configuration (for example, from "user secrets") under the `ConnectionStrings:openAiConnectionName` config key. The <xref:Aspire.Hosting.ResourceBuilderExtensions.WithReference%2A> method passes that connection information into a connection string named `openAiConnectionName` in the `ExampleProject` project. In the _:::no-loc text="Program.cs":::_ file of ExampleProject, the connection can be consumed using:
87+
The `AddAzureAIOpenAI` method will read connection information from the app host's configuration (for example, from "user secrets") under the `ConnectionStrings:openAiConnectionName` config key. The <xref:Aspire.Hosting.ResourceBuilderExtensions.WithReference%2A> method passes that connection information into a connection string named `openAiConnectionName` in the `ExampleProject` project. In the _:::no-loc text="Program.cs":::_ file of ExampleProject, the connection can be consumed using:
8888

8989
```csharp
90-
builder.AddAzureOpenAI("openAiConnectionName");
91-
```
92-
93-
To add an Azure OpenAI Deployment resource to the application model, chain a call to <xref:Aspire.Hosting.AzureOpenAIExtensions.AddDeployment%2A> method:
94-
95-
```csharp
96-
builder.AddAzureOpenAI("openAiConnectionName")
97-
.AddDeployment(
98-
new AzureOpenAIDeployment(
99-
name: "chatmodel",
100-
modelName: "gpt-4o",
101-
modelVersion: "2024-05-13",
102-
skuName: "Standard",
103-
skuCapacity: 1000));
90+
builder.AddAzureAIOpenAI("openAiConnectionName");
10491
```
10592

10693
## Configuration
10794

108-
The .NET Aspire Azure AI OpenAI component provides multiple options to configure the connection based on the requirements and conventions of your project.
95+
The .NET Aspire Azure AI OpenAI integration provides multiple options to configure the connection based on the requirements and conventions of your project.
10996

11097
### Use a connection string
11198

@@ -145,7 +132,7 @@ In order to connect to the non-Azure OpenAI service, drop the `Endpoint` propert
145132

146133
### Use configuration providers
147134

148-
The .NET Aspire Azure AI OpenAI component supports <xref:Microsoft.Extensions.Configuration>. It loads the `AzureOpenAISettings` from configuration by using the `Aspire:Azure:AI:OpenAI` key. Example _:::no-loc text="appsettings.json":::_ that configures some of the options:
135+
The .NET Aspire Azure AI OpenAI integration supports <xref:Microsoft.Extensions.Configuration>. It loads the `AzureOpenAISettings` from configuration by using the `Aspire:Azure:AI:OpenAI` key. Example _:::no-loc text="appsettings.json":::_ that configures some of the options:
149136

150137
```json
151138
{
@@ -180,11 +167,11 @@ builder.AddAzureAIOpenAI(
180167
options => options.Diagnostics.ApplicationId = "CLIENT_ID"));
181168
```
182169

183-
[!INCLUDE [component-observability-and-telemetry](../includes/component-observability-and-telemetry.md)]
170+
[!INCLUDE [integration-observability-and-telemetry](../includes/integration-observability-and-telemetry.md)]
184171

185172
### Logging
186173

187-
The .NET Aspire Azure AI OpenAI component uses the following log categories:
174+
The .NET Aspire Azure AI OpenAI integration uses the following log categories:
188175

189176
- `Azure`
190177
- `Azure.Core`
@@ -193,5 +180,5 @@ The .NET Aspire Azure AI OpenAI component uses the following log categories:
193180
## See also
194181

195182
- [Azure AI OpenAI docs](/azure/ai-services/openai/overview)
196-
- [.NET Aspire components](../fundamentals/components-overview.md)
183+
- [.NET Aspire integrations](../fundamentals/integrations-overview.md)
197184
- [.NET Aspire GitHub repo](https://github.com/dotnet/aspire)

0 commit comments

Comments
 (0)