Skip to content

Commit 2a886c9

Browse files
authored
Merge pull request #293816 from maud-lv/ml-scaidocs
AI articles review
2 parents 66eba42 + db4ebd0 commit 2a886c9

5 files changed

+80
-68
lines changed

articles/service-connector/how-to-integrate-ai-services.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
---
2-
title: Integrate Azure AI services with service connector
2+
title: Connect Azure AI services with other Azure services
3+
titleSuffix: Service Connector
34
description: In this document, learn how to integrate Azure AI Services into your application with Service Connector
45
author: wchigit
56
ms.author: wchi
67
ms.service: service-connector
78
ms.topic: how-to
8-
ms.date: 06/14/2024
9+
ms.date: 01/29/2024
910
ms.collection: ce-skilling-ai-copilot
1011
---
1112

12-
# Integrate Azure AI services with Service Connector
13+
# Connect to Azure AI services using Service Connector
1314

14-
This page shows supported authentication methods and clients, and shows sample code you can use to connect Azure AI Services to other cloud services using Service Connector. You might still be able to connect to Azure AI Services using other methods. This page also shows default environment variable names and values you get when you create the service connection.
15+
This page provides information on supported authentication methods and clients, along with sample code for connecting Azure AI services to other cloud services using Service Connector. This page also lists default environment variable names and values obtained when creating the service connection.
1516

1617
## Supported compute services
1718

@@ -25,7 +26,7 @@ Service Connector can be used to connect the following compute services to Azure
2526

2627
## Supported authentication types and client types
2728

28-
The table below shows which combinations of authentication methods and clients are supported for connecting your compute service to Azure AI Services using Service Connector. A “Yes” indicates that the combination is supported, while a “No” indicates that it is not supported.
29+
The table below indicates which combinations of authentication methods and clients are supported for connecting your compute service to individual Azure AI Services using Service Connector. A “Yes” indicates that the combination is supported, while a “No” indicates that it is not supported.
2930

3031

3132
| Client type | System-assigned managed identity | User-assigned managed identity | Secret/connection string | Service principal |
@@ -40,9 +41,9 @@ This table indicates that all combinations of client types and authentication me
4041

4142
## Default environment variable names or application properties and sample code
4243

43-
Use the connection details below to connect compute services to Azure AI Services. For more information about naming conventions, check the [Service Connector internals](concept-service-connector-internals.md#configuration-naming-convention) article.
44+
Use the connection details below to connect compute services to Azure AI Services. For more information about naming conventions, refer to the [Service Connector internals](concept-service-connector-internals.md#configuration-naming-convention) article.
4445

45-
### System-assigned managed identity
46+
### System-assigned managed identity (recommended)
4647

4748
| Default environment variable name | Description | Sample value |
4849
| --------------------------------- | ---------------------------- | ------------------------------------------------ |
@@ -51,6 +52,7 @@ Use the connection details below to connect compute services to Azure AI Service
5152
| AZURE_AISERVICES_SPEECH_ENDPOINT | Speech to Text (Standard) API endpoint | `https://<location>.stt.speech.microsoft.com` |
5253

5354
#### Sample code
55+
5456
Refer to the steps and code below to connect to Azure AI Services using a system-assigned managed identity.
5557
[!INCLUDE [code sample for app config](./includes/code-ai-services-microsoft-entra-id.md)]
5658

@@ -64,6 +66,7 @@ Refer to the steps and code below to connect to Azure AI Services using a system
6466
| AZURE_AISERVICES_CLIENTID | Your client ID | `<client-ID>` |
6567

6668
#### Sample code
69+
6770
Refer to the steps and code below to connect to Azure AI Services using a user-assigned managed identity.
6871
[!INCLUDE [code sample for azure AI Services](./includes/code-ai-services-microsoft-entra-id.md)]
6972

@@ -77,7 +80,8 @@ Refer to the steps and code below to connect to Azure AI Services using a user-a
7780
> | AZURE_AISERVICES_SPEECH_ENDPOINT | Speech to Text (Standard) API endpoint | `https://<location>.stt.speech.microsoft.com` |
7881
> | AZURE_AISERVICES_KEY | Azure AI Services API key | `<api-key>` |
7982
80-
#### Sample Code
83+
#### Sample code
84+
8185
Refer to the steps and code below to connect to Azure AI Services using a connection string.
8286
[!INCLUDE [code sample for azure AI Services](./includes/code-ai-services-secret.md)]
8387

@@ -94,12 +98,12 @@ Refer to the steps and code below to connect to Azure AI Services using a connec
9498
| AZURE_AISERVICES_TENANTID | Your tenant ID | `<tenant-ID>` |
9599

96100
#### Sample code
101+
97102
Refer to the steps and code below to connect to Azure AI Services using a service principaL.
98103
[!INCLUDE [code sample for azure AI Services](./includes/code-ai-services-microsoft-entra-id.md)]
99104

100-
## Next steps
101-
102-
Follow the tutorial listed below to learn more about Service Connector.
105+
## Related content
103106

104-
> [!div class="nextstepaction"]
105-
> [Learn about Service Connector concepts](./concept-service-connector-internals.md)
107+
* [Connect to an Azure AI multi-service resource](./how-to-integrate-cognitive-services.md)
108+
* [Azure OpenAI Service integration](./how-to-integrate-openai.md)
109+
* [Connect to Azure OpenAI Service in AKS using a Workload Identity](./tutorial-python-aks-openai-workload-identity.md)

articles/service-connector/how-to-integrate-cognitive-services.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
---
2-
title: Integrate an Azure AI multi-service resource with service connector
2+
title: Connect Azure AI multi-service resource with Azure services
3+
titleSuffix: Service Connector
34
description: In this document, learn how to integrate an Azure AI multi-service resource into your application with Service Connector
45
author: wchigit
56
ms.author: wchi
67
ms.service: service-connector
78
ms.topic: how-to
8-
ms.date: 06/14/2024
9+
ms.date: 01/29/2025
910
ms.collection: ce-skilling-ai-copilot
1011
---
1112

12-
# Integrate an Azure AI multi-service resource with Service Connector
13+
# Connect to an Azure AI multi-service resource with Service Connector
1314

14-
This page shows supported authentication methods and clients, and shows sample code you can use to connect an Azure AI multi-service resource to other cloud services using Service Connector. You might still be able to connect to an Azure AI multi-service resource using other methods. This page also shows default environment variable names and values you get when you create the service connection.
15+
This page provides information on supported authentication methods and clients, along with sample code for connecting an Azure AI multi-service resource to other cloud services using Service Connector. This page also lists default environment variable names and values obtained when creating the service connection.
1516

1617
## Supported compute services
1718

@@ -25,7 +26,7 @@ Service Connector can be used to connect the following compute services to an Az
2526

2627
## Supported authentication types and client types
2728

28-
The table below shows which combinations of authentication methods and clients are supported for connecting your compute service to an Azure AI multi-service resource using Service Connector. A “Yes” indicates that the combination is supported, while a “No” indicates that it is not supported.
29+
The table below indicates the authentication methods and clients supported for connecting your compute service to an Azure AI multi-service resource using Service Connector. A “Yes” indicates that the combination is supported, while a “No” indicates that it is not supported.
2930

3031

3132
| Client type | System-assigned managed identity | User-assigned managed identity | Secret/connection string | Service principal |
@@ -40,16 +41,18 @@ This table indicates that all combinations of client types and authentication me
4041

4142
## Default environment variable names or application properties and sample code
4243

43-
Use the connection details below to connect compute services to an Azure AI multi-service resource. For more information about naming conventions, check the [Service Connector internals](concept-service-connector-internals.md#configuration-naming-convention) article.
44+
Use the connection details below to connect compute services to an Azure AI multi-service resource. For more information about naming conventions, refer to the [Service Connector internals](concept-service-connector-internals.md#configuration-naming-convention) article.
4445

45-
### System-assigned managed identity
46+
### System-assigned managed identity (recommended)
4647

4748
| Default environment variable name | Description | Sample value |
4849
| --------------------------------- | ---------------------------- | ------------------------------------------------ |
4950
| AZURE_COGNITIVESERVICES_ENDPOINT | Azure Cognitive Services token provider service | `https://<cognitive-service-name>.cognitiveservices.azure.com/` |
5051

5152
#### Sample code
53+
5254
Refer to the steps and code below to connect to an Azure AI multi-service resource using a system-assigned managed identity.
55+
5356
[!INCLUDE [code sample for an Azure AI multi-service resource](./includes/code-cognitive-microsoft-entra-id.md)]
5457

5558
### User-assigned managed identity
@@ -60,6 +63,7 @@ Refer to the steps and code below to connect to an Azure AI multi-service resour
6063
| AZURE_COGNITIVESERVICES_CLIENTID | Your client ID | `<client-ID>` |
6164

6265
#### Sample code
66+
6367
Refer to the steps and code below to connect to an Azure AI multi-service resource using a user-assigned managed identity.
6468
[!INCLUDE [code sample for an Azure AI multi-service resource](./includes/code-cognitive-microsoft-entra-id.md)]
6569

@@ -71,7 +75,8 @@ Refer to the steps and code below to connect to an Azure AI multi-service resour
7175
> | AZURE_COGNITIVESERVICES_ENDPOINT | Azure Cognitive Services token provider service | `https://<cognitive-service-name>.cognitiveservices.azure.com/` |
7276
> | AZURE_COGNITIVESERVICES_KEY | API key of an Azure AI multi-service resource | `<api-key>` |
7377
74-
#### Sample Code
78+
#### Sample code
79+
7580
Refer to the steps and code below to connect to an Azure AI multi-service resource using a connection string.
7681
[!INCLUDE [code sample for an Azure AI multi-service resource](./includes/code-cognitive-secret.md)]
7782

@@ -86,12 +91,13 @@ Refer to the steps and code below to connect to an Azure AI multi-service resour
8691
| AZURE_COGNITIVESERVICES_TENANTID | Your tenant ID | `<tenant-ID>` |
8792

8893
#### Sample code
94+
8995
Refer to the steps and code below to connect to an Azure AI multi-service resource using a service principaL.
90-
[!INCLUDE [code sample for an Azure AI multi-service resource](./includes/code-cognitive-microsoft-entra-id.md)]
9196

92-
## Next steps
97+
[!INCLUDE [code sample for an Azure AI multi-service resource](./includes/code-cognitive-microsoft-entra-id.md)]
9398

94-
Follow the tutorial listed below to learn more about Service Connector.
99+
## Related content
95100

96-
> [!div class="nextstepaction"]
97-
> [Learn about Service Connector concepts](./concept-service-connector-internals.md)
101+
* [Connect to Azure AI services](./how-to-integrate-ai-services.md)
102+
* [Connect to Azure OpenAI Service](./how-to-integrate-openai.md)
103+
* [Connect to Azure OpenAI Service in AKS using Workload Identity](./tutorial-python-aks-openai-workload-identity.md)

articles/service-connector/how-to-integrate-openai.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
---
2-
title: Integrate Azure OpenAI Service with service connector
2+
title: Connect Azure OpenAI Service to other Azure services
3+
titleSuffix: Service Connector
34
description: In this document, learn how to integrate Azure OpenAI Service into your application with Service Connector
45
author: wchigit
56
ms.author: wchi
67
ms.service: service-connector
78
ms.topic: how-to
8-
ms.date: 06/14/2024
9+
ms.date: 01/29/2025
910
ms.collection: ce-skilling-ai-copilot
1011
---
1112

12-
# Integrate Azure OpenAI Service with Service Connector
13+
# Connect to Azure OpenAI Service using Service Connector
1314

14-
This page shows supported authentication methods and clients, and shows sample code you can use to connect Azure OpenAI Service to other cloud services using Service Connector. You might still be able to connect to Azure OpenAI Service using other methods. This page also shows default environment variable names and values you get when you create the service connection.
15+
This page provides information about supported authentication methods and clients, along with sample code for connecting Azure OpenAI Service to other cloud services using Service Connector. This page also lists default environment variable names and values obtained when creating service connections.
1516

1617
## Supported compute services
1718

@@ -22,6 +23,7 @@ Service Connector can be used to connect the following compute services to Azure
2223
- Azure Functions
2324
- Azure Kubernetes Service (AKS)
2425
- Azure Spring Apps
26+
2527
## Supported authentication types and client types
2628

2729
The table below shows which combinations of authentication methods and clients are supported for connecting your compute service to Azure OpenAI Service using Service Connector. A “Yes” indicates that the combination is supported, while a “No” indicates that it is not supported.
@@ -39,7 +41,7 @@ This table indicates that all combinations of client types and authentication me
3941

4042
## Default environment variable names or application properties and sample code
4143

42-
Use the connection details below to connect compute services to Azure OpenAI Service. For more information about naming conventions, check the [Service Connector internals](concept-service-connector-internals.md#configuration-naming-convention) article.
44+
Use the connection details below to connect compute services to Azure OpenAI Service. For more information about naming conventions, refer to [Service Connector internals](concept-service-connector-internals.md#configuration-naming-convention) article.
4345

4446
### System-assigned managed identity
4547

@@ -59,6 +61,7 @@ Refer to the steps and code below to connect to Azure OpenAI Service using a sys
5961
| AZURE_OPENAI_CLIENTID | Your client ID | `<client-ID>` |
6062

6163
#### Sample code
64+
6265
Refer to the steps and code below to connect to Azure OpenAI Service using a user-assigned managed identity.
6366
[!INCLUDE [code sample for azure openai service](./includes/code-openai-microsoft-entra-id.md)]
6467

@@ -71,6 +74,7 @@ Refer to the steps and code below to connect to Azure OpenAI Service using a use
7174
> | AZURE_OPENAI_KEY | Azure OpenAI Service API key | `<api-key>` |
7275
7376
#### Sample Code
77+
7478
Refer to the steps and code below to connect to Azure OpenAI Service using a connection string.
7579
[!INCLUDE [code sample for azure openai service](./includes/code-openai-secret.md)]
7680

@@ -88,9 +92,8 @@ Refer to the steps and code below to connect to Azure OpenAI Service using a con
8892
Refer to the steps and code below to connect to Azure OpenAI Service using a service principaL.
8993
[!INCLUDE [code sample for azure openai service](./includes/code-openai-microsoft-entra-id.md)]
9094

91-
## Next steps
92-
93-
Follow the tutorial listed below to learn more about Service Connector.
95+
### Related content
9496

95-
> [!div class="nextstepaction"]
96-
> [Learn about Service Connector concepts](./concept-service-connector-internals.md)
97+
* [Connect to Azure OpenAI Service in AKS using Workload Identity](./tutorial-python-aks-openai-workload-identity.md)
98+
* [Connect to an Azure AI multi-service resource](./how-to-integrate-cognitive-services.md)
99+
* [Connect to Azure AI services](./how-to-integrate-ai-services.md)

articles/service-connector/tutorial-python-aks-openai-connection-string.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ ms.service: service-connector
99
ms.custom: devx-track-python, build-2024, devx-track-azurecli
1010
ms.collection: ce-skilling-ai-copilot
1111
ms.topic: tutorial
12-
ms.date: 01/28/2025
12+
ms.date: 01/29/2025
1313
---
1414

1515
# Tutorial: Connect to Azure OpenAI Service in AKS using a connection string
1616

17-
In this tutorial, you learn how to create a pod in an Azure Kubernetes (AKS) cluster, which talks to Azure OpenAI Service using a connection string. You complete the following tasks:
17+
In this tutorial, you learn how to create a pod in an Azure Kubernetes (AKS) cluster that communicates with Azure OpenAI Service using a connection string. You complete the following tasks:
1818

1919
> [!div class="checklist"]
2020
>
@@ -138,16 +138,23 @@ Once the connection has been created, you can view its details in the **Service
138138
139139
## [Azure CLI](#tab/azure-cli)
140140
141-
Use the Azure CLI command to create a service connection to the Azure OpenAI service, providing the following information:
142-
143-
* **Source compute service resource group name:** the resource group name of the AKS cluster.
144-
* **AKS cluster name:** the name of your AKS cluster that connects to the target service.
145-
* **Target service resource group name:** the resource group name of the Azure OpenAI service.
146-
* **OpenAI service name:** the Azure OpenAI service that is connected.
141+
Create a service connection to the Azure OpenAI service in AKS by running the [az aks connection create cognitiveservices](/cli/azure/aks/connection/create#az-aks-connection-create-cognitiveservices) command in the Azure CLI.
147142
148143
```azurecli
149144
az aks connection create cognitiveservices --secret
145+
```
146+
147+
When using the above command, Service Connector prompts you to specify the AKS resource group, AKS cluster name, target service resource group, and cognitive service account name step by step.
148+
149+
Alternatively, you can provide the complete command directly:
150150

151+
```azurecli
152+
az aks connection create cognitiveservices \
153+
--secret \
154+
--resource-group <aks-cluster-resource-group> \
155+
--name <aks-cluster-name> \
156+
--target-resource-group <target-cognitive-services-resource-group> \
157+
--account <target-cognitive-services-account>
151158
```
152159

153160
---
@@ -216,12 +223,8 @@ az group delete \
216223
--resource-group MyResourceGroup
217224
```
218225

219-
## Next steps
220-
221-
Read the following articles to learn more about Service Connector concepts and how it helps AKS connect to Azure services.
222-
223-
> [!div class="nextstepaction"]
224-
> [Learn about Service Connector concepts](./concept-service-connector-internals.md)
226+
## Related content
225227

226-
> [!div class="nextstepaction"]
227-
> [Use Service Connector to connect an AKS cluster to other cloud services](./how-to-use-service-connector-in-aks.md)
228+
* [Connect to Azure OpenAI Service](./how-to-integrate-openai.md)
229+
* [Connect to Azure OpenAI Service in AKS using Workload Identity](./tutorial-python-aks-openai-workload-identity.md)
230+
* [Connect to an Azure AI multi-service resource](./how-to-integrate-cognitive-services.md)

0 commit comments

Comments
 (0)