Integrace služby Azure Cosmos DB for NoSQL s konektorem služby

Tato stránka ukazuje podporované metody ověřování a klienty a ukazuje ukázkový kód, který můžete použít k připojení služby Azure Cosmos DB for NoSQL k jiným cloudovým službám pomocí konektoru služby. Stále se můžete připojit ke službě Azure Cosmos DB for NoSQL v jiných programovacích jazycích bez použití konektoru služby. Tato stránka také zobrazuje výchozí názvy proměnných prostředí a hodnoty (nebo konfiguraci Spring Boot), které získáte při vytváření připojení služby.

Podporované výpočetní služby

Konektor služby se dá použít k připojení následujících výpočetních služeb ke službě Azure Cosmos DB for NoSQL:

• Azure App Service
• Azure Functions
• Azure Container Apps
• Azure Spring Apps

Podporované typy ověřování a typy klientů

Následující tabulka ukazuje, které kombinace typů klientů a metod ověřování se podporují pro připojení výpočetní služby ke službě Azure Cosmos DB for NoSQL pomocí konektoru služby. "Ano" označuje, že kombinace je podporována, zatímco "Ne" označuje, že není podporována.

Typ klienta	Spravovaná identita přiřazená systémem	Spravovaná identita přiřazená uživatelem	Tajný kód / připojovací řetězec	Instanční objekt
.NET	Ano	Ano	Ano	Yes
Java	Ano	Ano	Ano	Yes
Java – Spring Boot	Ano	Ano	Ano	Yes
Node.js	Ano	Ano	Ano	Yes
Python	Ano	Ano	Ano	Yes
Go	Ano	Ano	Ano	Yes
Nic	Ano	Ano	Ano	Yes

Tato tabulka označuje, že jsou podporovány všechny kombinace typů klientů a metod ověřování v tabulce. Všechny typy klientů můžou pro připojení ke službě Azure Cosmos DB for NoSQL pomocí konektoru služby použít některou z metod ověřování.

Výchozí názvy proměnných prostředí nebo vlastnosti aplikace a ukázkový kód

Pomocí níže uvedených podrobností o připojení připojte výpočetní služby ke službě Azure Cosmos DB for NoSQL. V každém příkladu níže nahraďte zástupné texty <database-server>, ,<database-name><account-key>, <resource-group-name>, <subscription-ID>, <client-ID>, <SQL-server>, <client-secret>, <tenant-id>a <access-key> vlastními informacemi. Další informace o konvencích vytváření názvů najdete v interním článku o konektoru služby.

Spravovaná identita přiřazená systémem

Typ klienta SpringBoot

Použití spravované identity přiřazené systémem jako typ ověřování je k dispozici pouze pro Spring Cloud Azure verze 4.0 nebo vyšší.

Výchozí název proměnné prostředí	Popis	Příklad hodnoty
spring.cloud.azure.cosmos.credential.managed-identity-enabled	Jestli se má povolit spravovaná identita	true
spring.cloud.azure.cosmos.database	Vaše databáze	https://management.azure.com/.default
spring.cloud.azure.cosmos.endpoint	Váš koncový bod prostředku	https://<database-server>.documents.azure.com:443/

Další typy klientů

Výchozí název proměnné prostředí	Popis	Příklad hodnoty
AZURE_COSMOS_LISTCONNECTIONSTRINGURL	Adresa URL pro získání připojovací řetězec	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	Rozsah spravované identity	https://management.azure.com/.default
AZURE_COSMOS_RESOURCEENDPOINT	Váš koncový bod prostředku	https://<database-server>.documents.azure.com:443/

Ukázkový kód

Projděte si následující kroky a kód a připojte se ke službě Azure Cosmos DB for NoSQL pomocí identity přiřazené systémem.

.NET

1. Nainstalujte závislosti.

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

2. Ověřte se pomocí Azure.Identity balíčku NuGet a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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. Do souboru pom.xml přidejte následující závislosti:

   <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. Ověřte se prostřednictvím azure-identity a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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

Informace o vytvoření aplikace Spring Data Azure Cosmos DB v3 pro správu dat Azure Cosmos DB for NoSQL najdete v tématu Vytvoření aplikace Spring. Vlastnosti konfigurace se přidají do Spring Apps podle konektoru služby. Podpora spravovaných identit pro Cosmos DB je dostupná jenom pro Spring Cloud Azure verze 4.0 a vyšší. Další informace najdete v referenční dokumentaci k Spring Cloud Azure.

Python

1. Nainstalujte závislosti.

   pip install azure-identity
   pip install azure-cosmos
   

2. Ověřte se prostřednictvím azure-identity knihovny a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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)
   
   

Přejít

1. Nainstalujte závislosti.

   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. Ověřte se pomocí azidentity balíčku npm a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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. Nainstalujte závislosti.

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

2. Ověřte se pomocí @azure/identity balíčku npm a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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
   });
   

Další

V jiných jazycích můžete použít adresu URL koncového bodu a další vlastnosti, které Konektor služby nastaví na proměnné prostředí pro připojení ke službě Azure Cosmos DB for NoSQL. Podrobnosti o proměnné prostředí najdete v tématu Integrace služby Azure Cosmos DB for NoSQL s konektorem služby.

Spravovaná identita přiřazená uživatelem

Typ klienta SpringBoot

Použití spravované identity přiřazené uživatelem jako typ ověřování je k dispozici pouze pro Spring Cloud Azure verze 4.0 nebo vyšší.

Výchozí název proměnné prostředí	Popis	Příklad hodnoty
spring.cloud.azure.cosmos.credential.managed-identity-enabled	Jestli se má povolit spravovaná identita	true
spring.cloud.azure.cosmos.database	Vaše databáze	https://management.azure.com/.default
spring.cloud.azure.cosmos.endpoint	Váš koncový bod prostředku	https://<database-server>.documents.azure.com:443/
spring.cloud.azure.cosmos.credential.client-id	ID klienta	<client-ID>

Další typy klientů

Výchozí název proměnné prostředí	Popis	Příklad hodnoty
AZURE_COSMOS_LISTCONNECTIONSTRINGURL	Adresa URL pro získání připojovací řetězec	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	Rozsah spravované identity	https://management.azure.com/.default
AZURE_COSMOS_CLIENTID	ID klienta	<client-ID>
AZURE_COSMOS_RESOURCEENDPOINT	Váš koncový bod prostředku	https://<database-server>.documents.azure.com:443/

Ukázkový kód

Pokud se chcete připojit ke službě Azure Cosmos DB for NoSQL pomocí identity přiřazené uživatelem, projděte si následující postup a kód.

.NET

1. Nainstalujte závislosti.

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

2. Ověřte se pomocí Azure.Identity balíčku NuGet a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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. Do souboru pom.xml přidejte následující závislosti:

   <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. Ověřte se prostřednictvím azure-identity a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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

Informace o vytvoření aplikace Spring Data Azure Cosmos DB v3 pro správu dat Azure Cosmos DB for NoSQL najdete v tématu Vytvoření aplikace Spring. Vlastnosti konfigurace se přidají do Spring Apps podle konektoru služby. Podpora spravovaných identit pro Cosmos DB je dostupná jenom pro Spring Cloud Azure verze 4.0 a vyšší. Další informace najdete v referenční dokumentaci k Spring Cloud Azure.

Python

1. Nainstalujte závislosti.

   pip install azure-identity
   pip install azure-cosmos
   

2. Ověřte se prostřednictvím azure-identity knihovny a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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)
   
   

Přejít

1. Nainstalujte závislosti.

   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. Ověřte se pomocí azidentity balíčku npm a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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. Nainstalujte závislosti.

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

2. Ověřte se pomocí @azure/identity balíčku npm a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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
   });
   

Další

V jiných jazycích můžete použít adresu URL koncového bodu a další vlastnosti, které Konektor služby nastaví na proměnné prostředí pro připojení ke službě Azure Cosmos DB for NoSQL. Podrobnosti o proměnné prostředí najdete v tématu Integrace služby Azure Cosmos DB for NoSQL s konektorem služby.

Connection string

Upozorňující

Microsoft doporučuje používat nejbezpečnější dostupný tok ověřování. Ověřovací tok popsaný v tomto postupu vyžaduje velmi vysoký stupeň důvěryhodnosti v aplikaci a nese rizika, která nejsou přítomna v jiných tocích. Tento tok byste měli použít jenom v případě, že jiné bezpečnější toky, jako jsou spravované identity, nejsou přijatelné.

Typ klienta SpringBoot

Výchozí název proměnné prostředí	Popis	Příklad hodnoty
azure.cosmos.key	Přístupový klíč pro vaši databázi pro Spring Cloud verze Azure nižší než 4.0	<access-key>
azure.cosmos.database	Vaše databáze pro Spring Cloud Azure verze nižší než 4.0	<database-name>
azure.cosmos.uri	Identifikátor URI databáze pro Spring Cloud verze Azure nižší než 4.0	https://<database-server>.documents.azure.com:443/
spring.cloud.azure.cosmos.key	Přístupový klíč pro vaši databázi pro Spring Cloud ve verzi Azure starší než 4.0	<access-key>
spring.cloud.azure.cosmos.database	Vaše databáze pro Spring Cloud Azure verze více než 4.0	<database-name>
spring.cloud.azure.cosmos.endpoint	Identifikátor URI databáze pro Spring Cloud ve verzi Azure s více než 4.0	https://<database-server>.documents.azure.com:443/

Další typy klientů

Výchozí název proměnné prostředí	Popis	Příklad hodnoty
AZURE_COSMOS_CONNECTIONSTRING	Připojovací řetězec azure Cosmos DB for NoSQL	AccountEndpoint=https://<database-server>.documents.azure.com:443/;AccountKey=<account-key>

Ukázkový kód

Pokud se chcete připojit ke službě Azure Cosmos DB for NoSQL pomocí připojovací řetězec, projděte si následující postup a kód.

.NET

1. Nainstalujte závislost.

   dotnet add package Microsoft.Azure.Cosmos
   

2. Získejte připojovací řetězec z proměnné prostředí přidané konektorem služby.

   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. Do souboru pom.xml přidejte následující závislost:

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

2. Získejte připojovací řetězec z proměnné prostředí přidané konektorem služby.

   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

Projděte si příklady služby Spring Data Azure Cosmos DB v3 a vytvoření aplikace Spring Data Azure Cosmos DB v3 pro správu dat Azure Cosmos DB for NoSQL pro nastavení aplikace Spring. Vlastnosti konfigurace se přidají do Spring Apps podle konektoru služby. Dvě sady vlastností konfigurace jsou poskytovány podle verze Spring Cloud Azure (nižší než 4.0 a vyšší než 4.0). Další informace o změnách knihoven v Azure Spring Cloud najdete v průvodci migrací do Spring Cloudu v Azure. Doporučujeme používat Spring Cloud Azure verze 4.0 a vyšší. Konfigurace ve formátu azure.cosmos.*z Spring Cloudu Azure 3.x už nebudou podporovány po 1. červenci 2024.

Python

1. Nainstalujte závislost.

   pip install azure-cosmos
   

2. Získejte připojovací řetězec z proměnné prostředí přidané konektorem služby.

   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) 
   

Přejít

1. Nainstalujte závislost.

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

2. Získejte připojovací řetězec z proměnné prostředí přidané konektorem služby.

   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. Nainstalujte závislost.

   npm install @azure/cosmos
   

2. Získejte připojovací řetězec z proměnné prostředí přidané konektorem služby.

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

Další

V jiných jazycích můžete použít adresu URL koncového bodu a další vlastnosti, které Konektor služby nastaví na proměnné prostředí pro připojení ke službě Azure Cosmos DB for NoSQL. Podrobnosti o proměnné prostředí najdete v tématu Integrace služby Azure Cosmos DB for NoSQL s konektorem služby.

Instanční objekt

Typ klienta SpringBoot

Výchozí název proměnné prostředí	Popis	Příklad hodnoty
spring.cloud.azure.cosmos.credential.client-id	ID klienta	<client-ID>
spring.cloud.azure.cosmos.credential.client-secret	Tajný klíč klienta	<client-secret>
spring.cloud.azure.cosmos.profile.tenant-id	ID vašeho tenanta	<tenant-ID>
spring.cloud.azure.cosmos.database	Vaše databáze	<database-name>
spring.cloud.azure.cosmos.endpoint	Váš koncový bod prostředku	https://<database-server>.documents.azure.com:443/

Další typy klientů

Výchozí název proměnné prostředí	Popis	Příklad hodnoty
AZURE_COSMOS_LISTCONNECTIONSTRINGURL	Adresa URL pro získání připojovací řetězec	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	Rozsah spravované identity	https://management.azure.com/.default
AZURE_COSMOS_CLIENTID	ID tajného klíče klienta	<client-ID>
AZURE_COSMOS_CLIENTSECRET	Tajný klíč klienta	<client-secret>
AZURE_COSMOS_TENANTID	ID vašeho tenanta	<tenant-ID>
AZURE_COSMOS_RESOURCEENDPOINT	Váš koncový bod prostředku	https://<database-server>.documents.azure.com:443/

Ukázkový kód

Informace o připojení ke službě Azure Cosmos DB for NoSQL pomocí instančního objektu najdete v následujících krocích a kódu.

.NET

1. Nainstalujte závislosti.

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

2. Ověřte se pomocí Azure.Identity balíčku NuGet a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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. Do souboru pom.xml přidejte následující závislosti:

   <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. Ověřte se prostřednictvím azure-identity a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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

Informace o vytvoření aplikace Spring Data Azure Cosmos DB v3 pro správu dat Azure Cosmos DB for NoSQL najdete v tématu Vytvoření aplikace Spring. Vlastnosti konfigurace se přidají do Spring Apps podle konektoru služby. Podpora spravovaných identit pro Cosmos DB je dostupná jenom pro Spring Cloud Azure verze 4.0 a vyšší. Další informace najdete v referenční dokumentaci k Spring Cloud Azure.

Python

1. Nainstalujte závislosti.

   pip install azure-identity
   pip install azure-cosmos
   

2. Ověřte se prostřednictvím azure-identity knihovny a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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)
   
   

Přejít

1. Nainstalujte závislosti.

   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. Ověřte se pomocí azidentity balíčku npm a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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. Nainstalujte závislosti.

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

2. Ověřte se pomocí @azure/identity balíčku npm a získejte adresu URL koncového bodu z proměnné prostředí přidané konektorem služby. Při použití následujícího kódu odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.

   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
   });
   

Další

V jiných jazycích můžete použít adresu URL koncového bodu a další vlastnosti, které Konektor služby nastaví na proměnné prostředí pro připojení ke službě Azure Cosmos DB for NoSQL. Podrobnosti o proměnné prostředí najdete v tématu Integrace služby Azure Cosmos DB for NoSQL s konektorem služby.

Další kroky

Další informace o konektoru Service Connector najdete v následujících kurzech.

Další informace o konceptech konektoru Service Connector