你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

使用服务连接器集成 Azure Cosmos DB for NoSQL

此页面显示了支持的身份验证方法和客户端，还演示了可用于使用服务连接器将 Azure Cosmos DB for NoSQL 连接到其他云服务的示例代码。 即使不使用服务连接器，你可能仍然能够使用其他编程语言连接到 Azure Cosmos DB for NoSQL。 此页面还显示了你在创建服务连接时获得的默认环境变量名称和值（或 Spring Boot 配置）。

受支持的计算服务

服务连接器可用于将以下计算服务连接到 Azure Cosmos DB for NoSQL：

• Azure 应用程序服务
• Azure Container Apps
• Azure Functions
• Azure Kubernetes 服务 (AKS)
• Azure Spring Apps

受支持的身份验证类型和客户端类型

下表显示了使用服务连接器将计算服务连接到 Azure Cosmos DB for NoSQL 时支持的客户端类型和身份验证方法的组合。 “是”表示支持该组合，“否”表示不支持该组合。

客户端类型	系统分配的托管标识	用户分配的托管标识	机密/连接字符串	服务主体
.NET	是	是	是	是
Java	是	是	是	是
Java - Spring Boot	是	是	是	是
Node.js	是	是	是	是
Python	是	是	是	是
Go	是	是	是	是
无	是	是	是	是

此表支持表中客户端类型和身份验证方法的所有组合都受到支持。 所有客户端类型都可通过服务连接器使用任何身份验证方法连接到 Azure Cosmos DB for NoSQL。

默认环境变量名称或应用程序属性和示例代码

使用以下连接详细信息将计算服务连接到 Azure Cosmos DB for NoSQL。 对于下面的每个示例，请将占位符文本 <database-server>、<database-name>、<account-key>、<resource-group-name>、<subscription-ID>、<client-ID>、<SQL-server>、<client-secret>、<tenant-id> 和 <access-key> 替换为你自己的信息。 有关命名约定的详细信息，请参阅服务连接器内部一文。

系统分配的托管标识

SpringBoot 客户端类型

使用系统分配的托管标识作为身份验证类型仅适用于 Spring Cloud Azure 4.0 或更高版本。

默认环境变量名称	说明	示例值
spring.cloud.azure.cosmos.credential.managed-identity-enabled	是否要启用托管标识	true
spring.cloud.azure.cosmos.database	你的数据库	https://management.azure.com/.default
spring.cloud.azure.cosmos.endpoint	资源终结点	https://<database-server>.documents.azure.com:443/

其他客户端类型

默认环境变量名称	说明	示例值
AZURE_COSMOS_LISTCONNECTIONSTRINGURL	用户获取连接字符串的 URL	https://management.azure.com/subscriptions/<subscription-ID>/resourceGroups/<resource-group-name>/providers/Microsoft.DocumentDB/databaseAccounts/<database-server>/listConnectionStrings?api-version=2021-04-15
AZURE_COSMOS_SCOPE	托管标识范围	https://management.azure.com/.default
AZURE_COSMOS_RESOURCEENDPOINT	资源终结点	https://<database-server>.documents.azure.com:443/

代码示例

请参阅下面的步骤和代码，以使用系统分配的标识连接到 Azure Cosmos DB for NoSQL。

.NET

1. 安装依赖项。

   dotnet add package Microsoft.Azure.Cosmos
   dotnet add package Azure.Identity
   

2. 使用 Azure.Identity NuGet 包进行身份验证，并从服务连接器添加的环境变量中获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   using Microsoft.Azure.Cosmos;
   using Azure.Core;
   using Azure.Identity;
   using System; 
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned identity.
   // TokenCredential credential = new DefaultAzureCredential();
   
   // For user-assigned identity.
   // TokenCredential credential = new DefaultAzureCredential(
   //     new DefaultAzureCredentialOptions
   //     {
   //         ManagedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTID");
   //     }
   // );
   
   // For service principal.
   // TokenCredential credential = new ClientSecretCredential(
   //     tenantId: Environment.GetEnvironmentVariable("AZURE_COSMOS_TENANTID")!,
   //     clientId: Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTID")!,
   //     clientSecret: Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTSECRET")!,
   //     options: new TokenCredentialOptions()
   // );
   
   // Create a new instance of CosmosClient using the credential above
   using CosmosClient client = new(
       accountEndpoint: Environment.GetEnvironmentVariable("AZURE_COSMOS_RESOURCEENDPOINT")!,
       tokenCredential: credential
   );
   

Java

1. 将以下依赖项添加到 pom.xml 文件：

   <dependency>
   	<groupId>com.azure</groupId>
   	<artifactId>azure-cosmos</artifactId>
   	<version>LATEST</version>
   </dependency>
   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-identity</artifactId>
       <version>1.1.5</version>
   </dependency>
   

2. 通过 azure-identity 进行身份验证，并从服务连接器添加的环境变量中获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   import com.azure.cosmos.CosmosClient;
   import com.azure.cosmos.CosmosClientBuilder;
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned identity
   // DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
   
   // for user-assigned managed identity
   // DefaultAzureCredential credential = new DefaultAzureCredentialBuilder()
   //     .managedIdentityClientId(System.getenv("AZURE_COSMOS_CLIENTID"))
   //     .build();
   
   // for service principal
   // ClientSecretCredential credential = new ClientSecretCredentialBuilder()
   //   .clientId(System.getenv("<AZURE_COSMOS_CLIENTID>"))
   //   .clientSecret(System.getenv("<AZURE_COSMOS_CLIENTSECRET>"))
   //   .tenantId(System.getenv("<AZURE_COSMOS_TENANTID>"))
   //   .build();
   
   String endpoint = System.getenv("AZURE_COSMOS_RESOURCEENDPOINT");
   
   CosmosClient cosmosClient = new CosmosClientBuilder()
       .endpoint(endpoint)
       .credential(credential)
       .buildClient();
   

SpringBoot

请参阅生成用于管理 Azure Cosmos DB for NoSQL 数据的 Spring Data Azure Cosmos DB v3 应用，以设置 Spring 应用程序。 配置属性通过服务连接器添加到 Spring Apps。 托管标识对 Cosmos DB 的支持仅适用于 Spring Cloud Azure 版本 4.0 及更高版本。 有关详细信息，请参阅 Spring Cloud Azure - 参考文档。

Python

1. 安装依赖项。

   pip install azure-identity
   pip install azure-cosmos
   

2. 通过 azure-identity 库进行身份验证，并从服务连接器添加的环境变量获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   import os
   from azure.cosmos import CosmosClient
   from azure.identity import ManagedIdentityCredential, ClientSecretCredential
   
   # Uncomment the following lines corresponding to the authentication type you want to use.
   # system-assigned managed identity
   # cred = ManagedIdentityCredential()
   
   # user-assigned managed identity
   # managed_identity_client_id = os.getenv('AZURE_COSMOS_CLIENTID')
   # cred = ManagedIdentityCredential(client_id=managed_identity_client_id)
   
   # service principal
   # tenant_id = os.getenv('AZURE_COSMOS_TENANTID')
   # client_id = os.getenv('AZURE_COSMOS_CLIENTID')
   # client_secret = os.getenv('AZURE_COSMOS_CLIENTSECRET')
   # cred = ClientSecretCredential(tenant_id=tenant_id, client_id=client_id, client_secret=client_secret)
   
   endpoint = os.environ["AZURE_COSMOS_RESOURCEENDPOINT"]
   client = CosmosClient(url=endpoint, credential=cred)
   
   

Go

1. 安装依赖项。

   go get t github.com/Azure/azure-sdk-for-go/sdk/azidentity
   go get github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos
   

2. 使用 azidentity npm 包进行身份验证，并从服务连接器添加的环境变量中获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   import (
       "os"
   
       "github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos"
       "github.com/Azure/azure-sdk-for-go/sdk/azidentity"
   )
   
   func main() {
       endpoint = os.Getenv("AZURE_COSMOS_RESOURCEENDPOINT")
   
       // Uncomment the following lines corresponding to the authentication type you want to use.
       // For system-assigned identity.
       // cred, err := azidentity.NewDefaultAzureCredential(nil)
   
       // For user-assigned identity.
       // clientid := os.Getenv("AZURE_COSMOS_CLIENTID")
       // azidentity.ManagedIdentityCredentialOptions.ID := clientid
       // options := &azidentity.ManagedIdentityCredentialOptions{ID: clientid}
       // cred, err := azidentity.NewManagedIdentityCredential(options)
   
       // For service principal.
       // clientid := os.Getenv("AZURE_COSMOS_CLIENTID")
       // tenantid := os.Getenv("AZURE_COSMOS_TENANTID")
       // clientsecret := os.Getenv("AZURE_COSMOS_CLIENTSECRET")
       // cred, err := azidentity.NewClientSecretCredential(tenantid, clientid, clientsecret, &azidentity.ClientSecretCredentialOptions{})
   
       client, err := azcosmos.NewClient(endpoint, cred, nil)
   }
   

NodeJS

1. 安装依赖项。

   npm install @azure/identity
   npm install @azure/cosmos
   

2. 使用 @azure/identity npm 包进行身份验证，并从服务连接器添加的环境变量中获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   import { CosmosClient } from "@azure/cosmos";
   const { DefaultAzureCredential } = require("@azure/identity");
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned managed identity.
   // const credential = new DefaultAzureCredential();
   
   // For user-assigned managed identity.
   // const credential = new DefaultAzureCredential({
   //     managedIdentityClientId: process.env.AZURE_COSMOS_CLIENTID
   // });
   
   // For service principal.
   // const credential = new ClientSecretCredential(
   //     tenantId: process.env.AZURE_COSMOS_TENANTID,
   //     clientId: process.env.AZURE_COSMOS_CLIENTID,
   //     clientSecret: process.env.AZURE_COSMOS_CLIENTSECRET
   // );
   
   // Create a new instance of CosmosClient using the credential above
   const cosmosClient = new CosmosClient({ 
       process.env.AZURE_COSMOS_RESOURCEENDPOINT, 
       aadCredentials: credential
   });
   

其他

对于其他语言，可以使用终结点 URL 和服务连接器设置为环境变量的其他属性来连接到 Azure Cosmos DB for NoSQL。 有关环境变量的详细信息，请参阅将 Azure Cosmos DB for NoSQL 与服务连接器集成。

用户分配的托管标识

SpringBoot 客户端类型

使用用户分配的托管标识作为身份验证类型仅适用于 Spring Cloud Azure 4.0 或更高版本。

默认环境变量名称	说明	示例值
spring.cloud.azure.cosmos.credential.managed-identity-enabled	是否要启用托管标识	true
spring.cloud.azure.cosmos.database	你的数据库	https://management.azure.com/.default
spring.cloud.azure.cosmos.endpoint	资源终结点	https://<database-server>.documents.azure.com:443/
spring.cloud.azure.cosmos.credential.client-id	客户端 ID	<client-ID>

其他客户端类型

默认环境变量名称	说明	示例值
AZURE_COSMOS_LISTCONNECTIONSTRINGURL	用户获取连接字符串的 URL	https://management.azure.com/subscriptions/<subscription-ID>/resourceGroups/<resource-group-name>/providers/Microsoft.DocumentDB/databaseAccounts/<database-server>/listConnectionStrings?api-version=2021-04-15
AZURE_COSMOS_SCOPE	托管标识范围	https://management.azure.com/.default
AZURE_COSMOS_CLIENTID	客户端 ID	<client-ID>
AZURE_COSMOS_RESOURCEENDPOINT	资源终结点	https://<database-server>.documents.azure.com:443/

代码示例

请参阅下面的步骤和代码，以使用用户分配的标识连接到 Azure Cosmos DB for NoSQL。

.NET

1. 安装依赖项。

   dotnet add package Microsoft.Azure.Cosmos
   dotnet add package Azure.Identity
   

2. 使用 Azure.Identity NuGet 包进行身份验证，并从服务连接器添加的环境变量中获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   using Microsoft.Azure.Cosmos;
   using Azure.Core;
   using Azure.Identity;
   using System; 
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned identity.
   // TokenCredential credential = new DefaultAzureCredential();
   
   // For user-assigned identity.
   // TokenCredential credential = new DefaultAzureCredential(
   //     new DefaultAzureCredentialOptions
   //     {
   //         ManagedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTID");
   //     }
   // );
   
   // For service principal.
   // TokenCredential credential = new ClientSecretCredential(
   //     tenantId: Environment.GetEnvironmentVariable("AZURE_COSMOS_TENANTID")!,
   //     clientId: Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTID")!,
   //     clientSecret: Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTSECRET")!,
   //     options: new TokenCredentialOptions()
   // );
   
   // Create a new instance of CosmosClient using the credential above
   using CosmosClient client = new(
       accountEndpoint: Environment.GetEnvironmentVariable("AZURE_COSMOS_RESOURCEENDPOINT")!,
       tokenCredential: credential
   );
   

Java

1. 将以下依赖项添加到 pom.xml 文件：

   <dependency>
   	<groupId>com.azure</groupId>
   	<artifactId>azure-cosmos</artifactId>
   	<version>LATEST</version>
   </dependency>
   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-identity</artifactId>
       <version>1.1.5</version>
   </dependency>
   

2. 通过 azure-identity 进行身份验证，并从服务连接器添加的环境变量中获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   import com.azure.cosmos.CosmosClient;
   import com.azure.cosmos.CosmosClientBuilder;
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned identity
   // DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
   
   // for user-assigned managed identity
   // DefaultAzureCredential credential = new DefaultAzureCredentialBuilder()
   //     .managedIdentityClientId(System.getenv("AZURE_COSMOS_CLIENTID"))
   //     .build();
   
   // for service principal
   // ClientSecretCredential credential = new ClientSecretCredentialBuilder()
   //   .clientId(System.getenv("<AZURE_COSMOS_CLIENTID>"))
   //   .clientSecret(System.getenv("<AZURE_COSMOS_CLIENTSECRET>"))
   //   .tenantId(System.getenv("<AZURE_COSMOS_TENANTID>"))
   //   .build();
   
   String endpoint = System.getenv("AZURE_COSMOS_RESOURCEENDPOINT");
   
   CosmosClient cosmosClient = new CosmosClientBuilder()
       .endpoint(endpoint)
       .credential(credential)
       .buildClient();
   

SpringBoot

请参阅生成用于管理 Azure Cosmos DB for NoSQL 数据的 Spring Data Azure Cosmos DB v3 应用，以设置 Spring 应用程序。 配置属性通过服务连接器添加到 Spring Apps。 托管标识对 Cosmos DB 的支持仅适用于 Spring Cloud Azure 版本 4.0 及更高版本。 有关详细信息，请参阅 Spring Cloud Azure - 参考文档。

Python

1. 安装依赖项。

   pip install azure-identity
   pip install azure-cosmos
   

2. 通过 azure-identity 库进行身份验证，并从服务连接器添加的环境变量获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   import os
   from azure.cosmos import CosmosClient
   from azure.identity import ManagedIdentityCredential, ClientSecretCredential
   
   # Uncomment the following lines corresponding to the authentication type you want to use.
   # system-assigned managed identity
   # cred = ManagedIdentityCredential()
   
   # user-assigned managed identity
   # managed_identity_client_id = os.getenv('AZURE_COSMOS_CLIENTID')
   # cred = ManagedIdentityCredential(client_id=managed_identity_client_id)
   
   # service principal
   # tenant_id = os.getenv('AZURE_COSMOS_TENANTID')
   # client_id = os.getenv('AZURE_COSMOS_CLIENTID')
   # client_secret = os.getenv('AZURE_COSMOS_CLIENTSECRET')
   # cred = ClientSecretCredential(tenant_id=tenant_id, client_id=client_id, client_secret=client_secret)
   
   endpoint = os.environ["AZURE_COSMOS_RESOURCEENDPOINT"]
   client = CosmosClient(url=endpoint, credential=cred)
   
   

Go

1. 安装依赖项。

   go get t github.com/Azure/azure-sdk-for-go/sdk/azidentity
   go get github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos
   

2. 使用 azidentity npm 包进行身份验证，并从服务连接器添加的环境变量中获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   import (
       "os"
   
       "github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos"
       "github.com/Azure/azure-sdk-for-go/sdk/azidentity"
   )
   
   func main() {
       endpoint = os.Getenv("AZURE_COSMOS_RESOURCEENDPOINT")
   
       // Uncomment the following lines corresponding to the authentication type you want to use.
       // For system-assigned identity.
       // cred, err := azidentity.NewDefaultAzureCredential(nil)
   
       // For user-assigned identity.
       // clientid := os.Getenv("AZURE_COSMOS_CLIENTID")
       // azidentity.ManagedIdentityCredentialOptions.ID := clientid
       // options := &azidentity.ManagedIdentityCredentialOptions{ID: clientid}
       // cred, err := azidentity.NewManagedIdentityCredential(options)
   
       // For service principal.
       // clientid := os.Getenv("AZURE_COSMOS_CLIENTID")
       // tenantid := os.Getenv("AZURE_COSMOS_TENANTID")
       // clientsecret := os.Getenv("AZURE_COSMOS_CLIENTSECRET")
       // cred, err := azidentity.NewClientSecretCredential(tenantid, clientid, clientsecret, &azidentity.ClientSecretCredentialOptions{})
   
       client, err := azcosmos.NewClient(endpoint, cred, nil)
   }
   

NodeJS

1. 安装依赖项。

   npm install @azure/identity
   npm install @azure/cosmos
   

2. 使用 @azure/identity npm 包进行身份验证，并从服务连接器添加的环境变量中获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   import { CosmosClient } from "@azure/cosmos";
   const { DefaultAzureCredential } = require("@azure/identity");
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned managed identity.
   // const credential = new DefaultAzureCredential();
   
   // For user-assigned managed identity.
   // const credential = new DefaultAzureCredential({
   //     managedIdentityClientId: process.env.AZURE_COSMOS_CLIENTID
   // });
   
   // For service principal.
   // const credential = new ClientSecretCredential(
   //     tenantId: process.env.AZURE_COSMOS_TENANTID,
   //     clientId: process.env.AZURE_COSMOS_CLIENTID,
   //     clientSecret: process.env.AZURE_COSMOS_CLIENTSECRET
   // );
   
   // Create a new instance of CosmosClient using the credential above
   const cosmosClient = new CosmosClient({ 
       process.env.AZURE_COSMOS_RESOURCEENDPOINT, 
       aadCredentials: credential
   });
   

其他

对于其他语言，可以使用终结点 URL 和服务连接器设置为环境变量的其他属性来连接到 Azure Cosmos DB for NoSQL。 有关环境变量的详细信息，请参阅将 Azure Cosmos DB for NoSQL 与服务连接器集成。

连接字符串

警告

Microsoft 建议使用最安全的可用身份验证流。 本过程中介绍的身份验证流程需要非常高的信任度，并携带其他流中不存在的风险。 请仅在无法使用其他更安全的流（例如托管标识）时才使用此流。

SpringBoot 客户端类型

默认环境变量名称	说明	示例值
azure.cosmos.key	适用于版本 4.0 以下 Spring Cloud Azure 的数据库的访问密钥	<access-key>
azure.cosmos.database	你的适用于版本 4.0 以下 Spring Cloud Azure 的数据库	<database-name>
azure.cosmos.uri	你的版本低于 4.0 的 Spring Cloud Azure 的数据库 URI	https://<database-server>.documents.azure.com:443/
spring.cloud.azure.cosmos.key	适用于版本高于 4.0 的 Spring Cloud Azure 的数据库的访问密钥	<access-key>
spring.cloud.azure.cosmos.database	适用于版本高于 4.0 的 Spring Cloud Azure 的数据库	<database-name>
spring.cloud.azure.cosmos.endpoint	你的版本高于 4.0 的 Spring Cloud Azure 的数据库 URI	https://<database-server>.documents.azure.com:443/

其他客户端类型

默认环境变量名称	说明	示例值
AZURE_COSMOS_CONNECTIONSTRING	Azure Cosmos DB for NoSQL 连接字符串	AccountEndpoint=https://<database-server>.documents.azure.com:443/;AccountKey=<account-key>

代码示例

请参阅下面的步骤和代码，以使用连接字符串连接到 Azure Cosmos DB for NoSQL。

.NET

1. 安装依赖项。

   dotnet add package Microsoft.Azure.Cosmos
   

2. 从服务连接器添加的环境变量中获取连接字符串。

   using Microsoft.Azure.Cosmos;
   using System; 
   
   // Create a new instance of CosmosClient using a connection string
   using CosmosClient client = new(
       connectionString: Environment.GetEnvironmentVariable("AZURE_COSMOS_CONNECTIONSTRING")!
   );
   

Java

1. 将以下依赖项添加到 pom.xml 文件：

   <dependency>
   	<groupId>com.azure</groupId>
   	<artifactId>azure-cosmos</artifactId>
   	<version>LATEST</version>
   </dependency>
   

2. 从服务连接器添加的环境变量中获取连接字符串。

   import com.azure.cosmos.CosmosClient;
   import com.azure.cosmos.CosmosClientBuilder;
   
   String connectionStr = System.getenv("AZURE_COSMOS_CONNECTIONSTRING");
   String[] connInfo = connectionStr.split(";");
   String endpoint = connInfo[0].split("=")[1];
   String accountKey = connInfo[1].split("=")[1];
   
   CosmosClient cosmosClient = new CosmosClientBuilder()
       .endpoint(endpoint)
       .key(accountKey)
       .buildClient();
   

SpringBoot

请参阅 Spring Data Azure Cosmos DB v3 示例和生成用于管理 Azure Cosmos DB for NoSQL 数据的 Spring Data Azure Cosmos DB v3 应用，以设置 Spring 应用程序。 配置属性通过服务连接器添加到 Spring Apps。 根据 Spring Cloud Azure 的版本（4.0 以下和 4.0 以上）提供了两组配置属性。 有关 Spring Cloud Azure 库更改的详细信息，请参阅 Spring Cloud Azure 迁移指南。 建议使用 Spring Cloud Azure 版本 4.0 及更高版本。 2024 年 7 月 1 日之后，将不再支持 Spring Cloud Azure 3.x 中格式为“azure.cosmos.*”的配置。

Python

1. 安装依赖项。

   pip install azure-cosmos
   

2. 从服务连接器添加的环境变量中获取连接字符串。

   import os
   from azure.cosmos import CosmosClient
   
   # Create a new instance of CosmosClient using a connection string
   CONN_STR = os.environ["AZURE_COSMOS_CONNECTIONSTRING"]
   client = CosmosClient.from_connection_string(conn_str=CONN_STR) 
   

Go

1. 安装依赖项。

   go get github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos
   

2. 从服务连接器添加的环境变量中获取连接字符串。

   import {
       "github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos"
   }
   connectionString := os.Getenv("AZURE_COSMOS_CONNECTIONSTRING")
   client, err := azcosmos.NewClientFromConnectionString(connectionString, nil)
   

NodeJS

1. 安装依赖项。

   npm install @azure/cosmos
   

2. 从服务连接器添加的环境变量中获取连接字符串。

   import { CosmosClient } from "@azure/cosmos";
   
   // Create a new instance of CosmosClient using a connection string
   const cosmosClient = new CosmosClient(process.env.AZURE_COSMOS_CONNECTIONSTRING);
   

其他

对于其他语言，可以使用终结点 URL 和服务连接器设置为环境变量的其他属性来连接到 Azure Cosmos DB for NoSQL。 有关环境变量的详细信息，请参阅将 Azure Cosmos DB for NoSQL 与服务连接器集成。

服务主体

SpringBoot 客户端类型

默认环境变量名称	说明	示例值
spring.cloud.azure.cosmos.credential.client-id	客户端 ID	<client-ID>
spring.cloud.azure.cosmos.credential.client-secret	客户端密码	<client-secret>
spring.cloud.azure.cosmos.profile.tenant-id	租户 ID	<tenant-ID>
spring.cloud.azure.cosmos.database	你的数据库	<database-name>
spring.cloud.azure.cosmos.endpoint	资源终结点	https://<database-server>.documents.azure.com:443/

其他客户端类型

默认环境变量名称	说明	示例值
AZURE_COSMOS_LISTCONNECTIONSTRINGURL	用户获取连接字符串的 URL	https://management.azure.com/subscriptions/<subscription-ID>/resourceGroups/<resource-group-name>/providers/Microsoft.DocumentDB/databaseAccounts/<database-server>/listConnectionStrings?api-version=2021-04-15
AZURE_COSMOS_SCOPE	托管标识范围	https://management.azure.com/.default
AZURE_COSMOS_CLIENTID	客户端密码 ID	<client-ID>
AZURE_COSMOS_CLIENTSECRET	客户端密码	<client-secret>
AZURE_COSMOS_TENANTID	租户 ID	<tenant-ID>
AZURE_COSMOS_RESOURCEENDPOINT	资源终结点	https://<database-server>.documents.azure.com:443/

代码示例

请参阅下面的步骤和代码，以使用服务主体连接到 Azure Cosmos DB for NoSQL。

.NET

1. 安装依赖项。

   dotnet add package Microsoft.Azure.Cosmos
   dotnet add package Azure.Identity
   

2. 使用 Azure.Identity NuGet 包进行身份验证，并从服务连接器添加的环境变量中获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   using Microsoft.Azure.Cosmos;
   using Azure.Core;
   using Azure.Identity;
   using System; 
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned identity.
   // TokenCredential credential = new DefaultAzureCredential();
   
   // For user-assigned identity.
   // TokenCredential credential = new DefaultAzureCredential(
   //     new DefaultAzureCredentialOptions
   //     {
   //         ManagedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTID");
   //     }
   // );
   
   // For service principal.
   // TokenCredential credential = new ClientSecretCredential(
   //     tenantId: Environment.GetEnvironmentVariable("AZURE_COSMOS_TENANTID")!,
   //     clientId: Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTID")!,
   //     clientSecret: Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTSECRET")!,
   //     options: new TokenCredentialOptions()
   // );
   
   // Create a new instance of CosmosClient using the credential above
   using CosmosClient client = new(
       accountEndpoint: Environment.GetEnvironmentVariable("AZURE_COSMOS_RESOURCEENDPOINT")!,
       tokenCredential: credential
   );
   

Java

1. 将以下依赖项添加到 pom.xml 文件：

   <dependency>
   	<groupId>com.azure</groupId>
   	<artifactId>azure-cosmos</artifactId>
   	<version>LATEST</version>
   </dependency>
   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-identity</artifactId>
       <version>1.1.5</version>
   </dependency>
   

2. 通过 azure-identity 进行身份验证，并从服务连接器添加的环境变量中获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   import com.azure.cosmos.CosmosClient;
   import com.azure.cosmos.CosmosClientBuilder;
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned identity
   // DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
   
   // for user-assigned managed identity
   // DefaultAzureCredential credential = new DefaultAzureCredentialBuilder()
   //     .managedIdentityClientId(System.getenv("AZURE_COSMOS_CLIENTID"))
   //     .build();
   
   // for service principal
   // ClientSecretCredential credential = new ClientSecretCredentialBuilder()
   //   .clientId(System.getenv("<AZURE_COSMOS_CLIENTID>"))
   //   .clientSecret(System.getenv("<AZURE_COSMOS_CLIENTSECRET>"))
   //   .tenantId(System.getenv("<AZURE_COSMOS_TENANTID>"))
   //   .build();
   
   String endpoint = System.getenv("AZURE_COSMOS_RESOURCEENDPOINT");
   
   CosmosClient cosmosClient = new CosmosClientBuilder()
       .endpoint(endpoint)
       .credential(credential)
       .buildClient();
   

SpringBoot

请参阅生成用于管理 Azure Cosmos DB for NoSQL 数据的 Spring Data Azure Cosmos DB v3 应用，以设置 Spring 应用程序。 配置属性通过服务连接器添加到 Spring Apps。 托管标识对 Cosmos DB 的支持仅适用于 Spring Cloud Azure 版本 4.0 及更高版本。 有关详细信息，请参阅 Spring Cloud Azure - 参考文档。

Python

1. 安装依赖项。

   pip install azure-identity
   pip install azure-cosmos
   

2. 通过 azure-identity 库进行身份验证，并从服务连接器添加的环境变量获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   import os
   from azure.cosmos import CosmosClient
   from azure.identity import ManagedIdentityCredential, ClientSecretCredential
   
   # Uncomment the following lines corresponding to the authentication type you want to use.
   # system-assigned managed identity
   # cred = ManagedIdentityCredential()
   
   # user-assigned managed identity
   # managed_identity_client_id = os.getenv('AZURE_COSMOS_CLIENTID')
   # cred = ManagedIdentityCredential(client_id=managed_identity_client_id)
   
   # service principal
   # tenant_id = os.getenv('AZURE_COSMOS_TENANTID')
   # client_id = os.getenv('AZURE_COSMOS_CLIENTID')
   # client_secret = os.getenv('AZURE_COSMOS_CLIENTSECRET')
   # cred = ClientSecretCredential(tenant_id=tenant_id, client_id=client_id, client_secret=client_secret)
   
   endpoint = os.environ["AZURE_COSMOS_RESOURCEENDPOINT"]
   client = CosmosClient(url=endpoint, credential=cred)
   
   

Go

1. 安装依赖项。

   go get t github.com/Azure/azure-sdk-for-go/sdk/azidentity
   go get github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos
   

2. 使用 azidentity npm 包进行身份验证，并从服务连接器添加的环境变量中获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   import (
       "os"
   
       "github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos"
       "github.com/Azure/azure-sdk-for-go/sdk/azidentity"
   )
   
   func main() {
       endpoint = os.Getenv("AZURE_COSMOS_RESOURCEENDPOINT")
   
       // Uncomment the following lines corresponding to the authentication type you want to use.
       // For system-assigned identity.
       // cred, err := azidentity.NewDefaultAzureCredential(nil)
   
       // For user-assigned identity.
       // clientid := os.Getenv("AZURE_COSMOS_CLIENTID")
       // azidentity.ManagedIdentityCredentialOptions.ID := clientid
       // options := &azidentity.ManagedIdentityCredentialOptions{ID: clientid}
       // cred, err := azidentity.NewManagedIdentityCredential(options)
   
       // For service principal.
       // clientid := os.Getenv("AZURE_COSMOS_CLIENTID")
       // tenantid := os.Getenv("AZURE_COSMOS_TENANTID")
       // clientsecret := os.Getenv("AZURE_COSMOS_CLIENTSECRET")
       // cred, err := azidentity.NewClientSecretCredential(tenantid, clientid, clientsecret, &azidentity.ClientSecretCredentialOptions{})
   
       client, err := azcosmos.NewClient(endpoint, cred, nil)
   }
   

NodeJS

1. 安装依赖项。

   npm install @azure/identity
   npm install @azure/cosmos
   

2. 使用 @azure/identity npm 包进行身份验证，并从服务连接器添加的环境变量中获取终结点 URL。 使用下面的代码时，请对要使用的身份验证类型的代码片段的一部分取消评论。

   import { CosmosClient } from "@azure/cosmos";
   const { DefaultAzureCredential } = require("@azure/identity");
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned managed identity.
   // const credential = new DefaultAzureCredential();
   
   // For user-assigned managed identity.
   // const credential = new DefaultAzureCredential({
   //     managedIdentityClientId: process.env.AZURE_COSMOS_CLIENTID
   // });
   
   // For service principal.
   // const credential = new ClientSecretCredential(
   //     tenantId: process.env.AZURE_COSMOS_TENANTID,
   //     clientId: process.env.AZURE_COSMOS_CLIENTID,
   //     clientSecret: process.env.AZURE_COSMOS_CLIENTSECRET
   // );
   
   // Create a new instance of CosmosClient using the credential above
   const cosmosClient = new CosmosClient({ 
       process.env.AZURE_COSMOS_RESOURCEENDPOINT, 
       aadCredentials: credential
   });
   

其他

对于其他语言，可以使用终结点 URL 和服务连接器设置为环境变量的其他属性来连接到 Azure Cosmos DB for NoSQL。 有关环境变量的详细信息，请参阅将 Azure Cosmos DB for NoSQL 与服务连接器集成。

后续步骤

参考下面列出的教程来详细了解服务连接器。

了解服务连接器的概念