Intégrer Azure Cosmos DB for NoSQL à l’aide de Service Connector

Cette page présente les méthodes d’authentification et les clients pris en charge, et présente des exemples de code que vous pouvez utiliser pour connecter Azure Cosmos DB pour NoSQL à d’autres services cloud à l’aide de Service Connecter or. Vous pouvez toujours vous connecter à Azure Cosmos DB pour NoSQL dans d’autres langages de programmation sans utiliser service Connecter or. Cette page présente également les noms et les valeurs des variables d’environnement par défaut (ou configuration Spring Boot) que vous obtenez lorsque vous créez des connexions de service.

Service de calcul pris en charge

Le Connecter or de service peut être utilisé pour connecter les services de calcul suivants à Azure Cosmos DB pour NoSQL :

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

Types d’authentification et de clients pris en charge

Le tableau ci-dessous montre quelles combinaisons de types de clients et de méthodes d’authentification sont prises en charge pour connecter votre service de calcul à Azure Cosmos DB pour NoSQL à l’aide du service Connecter or. Un « Oui » indique que la combinaison est prise en charge, tandis qu’une valeur « Non » indique qu’elle n’est pas prise en charge.

Type de client	Identité managée affectée par le système	Identité managée affectée par l’utilisateur	Secret / chaîne de connexion	Principal du service
.NET	Oui	Oui	Oui	Oui
Java	Oui	Oui	Oui	Oui
Java - Spring Boot	Oui	Oui	Oui	Oui
Node.js	Oui	Oui	Oui	Oui
Python	Oui	Oui	Oui	Oui
Go	Oui	Oui	Oui	Oui
Aucun	Oui	Oui	Oui	Oui

Ce tableau indique que toutes les combinaisons de types clients et de méthodes d’authentification dans la table sont prises en charge. Tous les types de clients peuvent utiliser l’une des méthodes d’authentification pour se connecter à Azure Cosmos DB pour NoSQL à l’aide de Service Connecter or.

Noms de variables d’environnement par défaut ou propriétés d’application et exemple de code

Utilisez les détails de connexion ci-dessous pour connecter vos services de calcul à Azure Cosmos DB for NoSQL. Pour chaque exemple ci-dessous, remplacez le texte d’espace réservé <database-server>, <database-name>, <account-key>, <resource-group-name>, <subscription-ID>, <client-ID>, <SQL-server>, <client-secret>,<tenant-id> et <access-key> par vos propres informations. Pour plus d’informations sur les conventions d’affectation de noms, case activée l’article interne du service Connecter or.

Identité managée affectée par le système

Type de client SpringBoot

L’utilisation d’une identité managée affectée par le système comme type d’authentification est disponible uniquement pour Spring Cloud Azure version 4.0 ou ultérieure.

Nom de variable d’environnement par défaut	Description	Exemple de valeur
spring.cloud.azure.cosmos.credential.managed-identity-enabled	Indique s’il faut activer l’identité managée	true
spring.cloud.azure.cosmos.database	Votre base de données	https://management.azure.com/.default
spring.cloud.azure.cosmos.endpoint	Votre point de terminaison de ressource	https://<database-server>.documents.azure.com:443/

Autres types de clients

Nom de variable d’environnement par défaut	Description	Exemple de valeur
AZURE_COSMOS_LISTCONNECTIONSTRINGURL	URL permettant d’accéder à la chaîne de connexion	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	Étendue de votre identité managée	https://management.azure.com/.default
AZURE_COSMOS_RESOURCEENDPOINT	Votre point de terminaison de ressource	https://<database-server>.documents.azure.com:443/

Exemple de code

Reportez-vous aux étapes et au code ci-dessous pour vous connecter à Azure Cosmos DB pour NoSQL à l’aide d’une identité affectée par le système.

.NET

1. Installez des dépendances.

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

2. Authentifiez-vous à l’aide Azure.Identity du package NuGet et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   using Microsoft.Azure.Cosmos;
   using Azure.Core;
   using Azure.Identity;
   using System; 
   
   // Uncomment the following lines according to the authentication type.
   // 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. Ajoutez les dépendances suivantes dans votre fichier 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. Authentifiez-vous via azure-identity et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   import com.azure.cosmos.CosmosClient;
   import com.azure.cosmos.CosmosClientBuilder;
   
   // Uncomment the following lines according to the authentication type.
   // 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

Reportez-vous à la création d’une application Spring Data Azure Cosmos DB v3 pour gérer les données Azure Cosmos DB pour NoSQL pour configurer votre application Spring. Les propriétés de configuration sont ajoutées à Spring Apps by Service Connecter or. La prise en charge des identités managées pour Cosmos DB est disponible uniquement pour Spring Cloud Azure version 4.0 et ultérieure. Pour plus d’informations, reportez-vous à Spring Cloud Azure - Documentation de référence.

Python

1. Installez des dépendances.

   pip install azure-identity
   pip install azure-cosmos
   

2. Authentifiez-vous via azure-identity la bibliothèque et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   import os
   from azure.cosmos import CosmosClient
   from azure.identity import ManagedIdentityCredential, ClientSecretCredential
   
   # Uncomment the following lines according to the authentication type.
   # 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. Installez des dépendances.

   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. Authentifiez-vous à l’aide azidentity du package npm et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   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 according to the authentication type.
       // 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. Installez des dépendances.

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

2. Authentifiez-vous à l’aide @azure/identity du package npm et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   import { CosmosClient } from "@azure/cosmos";
   const { DefaultAzureCredential } = require("@azure/identity");
   
   // Uncomment the following lines according to the authentication type.
   // 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
   });
   

Autres

Pour d’autres langages, vous pouvez utiliser l’URL du point de terminaison et d’autres propriétés que Service Connecter or définit sur les variables d’environnement pour vous connecter à Azure Cosmos DB pour NoSQL. Pour plus d’informations sur la variable d’environnement, consultez Intégrer Azure Cosmos DB pour NoSQL à Service Connecter or.

Identité managée affectée par l’utilisateur

Type de client SpringBoot

L’utilisation d’une identité managée affectée par l’utilisateur comme type d’authentification est disponible uniquement pour Spring Cloud Azure version 4.0 ou ultérieure.

Nom de variable d’environnement par défaut	Description	Exemple de valeur
spring.cloud.azure.cosmos.credential.managed-identity-enabled	Indique s’il faut activer l’identité managée	true
spring.cloud.azure.cosmos.database	Votre base de données	https://management.azure.com/.default
spring.cloud.azure.cosmos.endpoint	Votre point de terminaison de ressource	https://<database-server>.documents.azure.com:443/
spring.cloud.azure.cosmos.credential.client-id	Votre ID client	<client-ID>

Autres types de clients

Nom de variable d’environnement par défaut	Description	Exemple de valeur
AZURE_COSMOS_LISTCONNECTIONSTRINGURL	URL permettant d’accéder à la chaîne de connexion	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	Étendue de votre identité managée	https://management.azure.com/.default
AZURE_COSMOS_CLIENTID	Votre ID client	<client-ID>
AZURE_COSMOS_RESOURCEENDPOINT	Votre point de terminaison de ressource	https://<database-server>.documents.azure.com:443/

Exemple de code

Reportez-vous aux étapes et au code ci-dessous pour vous connecter à Azure Cosmos DB pour NoSQL à l’aide d’une identité affectée par l’utilisateur.

.NET

1. Installez des dépendances.

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

2. Authentifiez-vous à l’aide Azure.Identity du package NuGet et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   using Microsoft.Azure.Cosmos;
   using Azure.Core;
   using Azure.Identity;
   using System; 
   
   // Uncomment the following lines according to the authentication type.
   // 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. Ajoutez les dépendances suivantes dans votre fichier 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. Authentifiez-vous via azure-identity et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   import com.azure.cosmos.CosmosClient;
   import com.azure.cosmos.CosmosClientBuilder;
   
   // Uncomment the following lines according to the authentication type.
   // 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

Reportez-vous à la création d’une application Spring Data Azure Cosmos DB v3 pour gérer les données Azure Cosmos DB pour NoSQL pour configurer votre application Spring. Les propriétés de configuration sont ajoutées à Spring Apps by Service Connecter or. La prise en charge des identités managées pour Cosmos DB est disponible uniquement pour Spring Cloud Azure version 4.0 et ultérieure. Pour plus d’informations, reportez-vous à Spring Cloud Azure - Documentation de référence.

Python

1. Installez des dépendances.

   pip install azure-identity
   pip install azure-cosmos
   

2. Authentifiez-vous via azure-identity la bibliothèque et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   import os
   from azure.cosmos import CosmosClient
   from azure.identity import ManagedIdentityCredential, ClientSecretCredential
   
   # Uncomment the following lines according to the authentication type.
   # 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. Installez des dépendances.

   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. Authentifiez-vous à l’aide azidentity du package npm et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   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 according to the authentication type.
       // 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. Installez des dépendances.

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

2. Authentifiez-vous à l’aide @azure/identity du package npm et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   import { CosmosClient } from "@azure/cosmos";
   const { DefaultAzureCredential } = require("@azure/identity");
   
   // Uncomment the following lines according to the authentication type.
   // 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
   });
   

Autres

Pour d’autres langages, vous pouvez utiliser l’URL du point de terminaison et d’autres propriétés que Service Connecter or définit sur les variables d’environnement pour vous connecter à Azure Cosmos DB pour NoSQL. Pour plus d’informations sur la variable d’environnement, consultez Intégrer Azure Cosmos DB pour NoSQL à Service Connecter or.

Chaîne de connexion

Type de client SpringBoot

Nom de variable d’environnement par défaut	Description	Exemple de valeur
azure.cosmos.key	Clé d’accès pour votre base de données pour Spring Cloud Azure version inférieure à 4.0	<access-key>
azure.cosmos.database	Votre base de données pour Spring Cloud Azure version inférieure à 4.0	<database-name>
azure.cosmos.uri	URI de votre base de données pour Spring Cloud Azure version inférieure à 4.0	https://<database-server>.documents.azure.com:443/
spring.cloud.azure.cosmos.key	Clé d’accès pour votre base de données pour Spring Cloud Azure version supérieure à 4.0	<access-key>
spring.cloud.azure.cosmos.database	Votre base de données pour Spring Cloud Azure version supérieure à 4.0	<database-name>
spring.cloud.azure.cosmos.endpoint	URI de votre base de données pour Spring Cloud Azure version supérieure à 4.0	https://<database-server>.documents.azure.com:443/

Autres types de clients

Nom de variable d’environnement par défaut	Description	Exemple de valeur
AZURE_COSMOS_CONNECTIONSTRING	Chaîne de connexion d’Azure Cosmos DB for NoSQL	AccountEndpoint=https://<database-server>.documents.azure.com:443/;AccountKey=<account-key>

Exemple de code

Reportez-vous aux étapes et au code ci-dessous pour vous connecter à Azure Cosmos DB pour NoSQL à l’aide d’un chaîne de connexion.

.NET

1. Installez la dépendance.

   dotnet add package Microsoft.Azure.Cosmos
   

2. Obtenez le chaîne de connexion à partir de la variable d’environnement ajoutée par service Connecter or.

   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. Ajoutez la dépendance suivante dans votre fichier pom.xml :

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

2. Obtenez le chaîne de connexion à partir de la variable d’environnement ajoutée par service Connecter or.

   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

Reportez-vous aux exemples Spring Data Azure Cosmos DB v3 et créez une application Spring Data Azure Cosmos DB v3 pour gérer les données Azure Cosmos DB pour NoSQL afin de configurer votre application Spring. Les propriétés de configuration sont ajoutées à Spring Apps by Service Connecter or. Deux ensembles de propriétés de configuration sont fournis en fonction de la version de Spring Cloud Azure (inférieure à 4.0 et supérieure à 4.0). Pour plus d’informations sur les modifications apportées à la bibliothèque de Spring Cloud Azure, reportez-vous au Guide de migration d’Azure Spring Cloud. Il est recommandé d’utiliser Spring Cloud Azure version 4.0 et ultérieure. Les configurations au format « azure.cosmos.* » de Spring Cloud Azure 3.x ne seront plus prises en charge après le 1er juillet 2024.

Python

1. Installez la dépendance.

   pip install azure-cosmos
   

2. Obtenez le chaîne de connexion à partir de la variable d’environnement ajoutée par service Connecter or.

   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. Installez la dépendance.

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

2. Obtenez le chaîne de connexion à partir de la variable d’environnement ajoutée par service Connecter or.

   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. Installez la dépendance.

   npm install @azure/cosmos
   

2. Obtenez le chaîne de connexion à partir de la variable d’environnement ajoutée par service Connecter or.

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

Autres

Pour d’autres langages, vous pouvez utiliser l’URL du point de terminaison et d’autres propriétés que Service Connecter or définit sur les variables d’environnement pour vous connecter à Azure Cosmos DB pour NoSQL. Pour plus d’informations sur la variable d’environnement, consultez Intégrer Azure Cosmos DB pour NoSQL à Service Connecter or.

Principal du service

Type de client SpringBoot

Nom de variable d’environnement par défaut	Description	Exemple de valeur
spring.cloud.azure.cosmos.credential.client-id	Votre ID client	<client-ID>
spring.cloud.azure.cosmos.credential.client-secret	Votre clé secrète client	<client-secret>
spring.cloud.azure.cosmos.profile.tenant-id	Votre ID d’abonné	<tenant-ID>
spring.cloud.azure.cosmos.database	Votre base de données	<database-name>
spring.cloud.azure.cosmos.endpoint	Votre point de terminaison de ressource	https://<database-server>.documents.azure.com:443/

Autres types de clients

Nom de variable d’environnement par défaut	Description	Exemple de valeur
AZURE_COSMOS_LISTCONNECTIONSTRINGURL	URL permettant d’accéder à la chaîne de connexion	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	Étendue de votre identité managée	https://management.azure.com/.default
AZURE_COSMOS_CLIENTID	ID de votre clé secrète client	<client-ID>
AZURE_COSMOS_CLIENTSECRET	Votre clé secrète client	<client-secret>
AZURE_COSMOS_TENANTID	Votre ID d’abonné	<tenant-ID>
AZURE_COSMOS_RESOURCEENDPOINT	Votre point de terminaison de ressource	https://<database-server>.documents.azure.com:443/

Exemple de code

Reportez-vous aux étapes et au code ci-dessous pour vous connecter à Azure Cosmos DB pour NoSQL à l’aide d’un principal de service.

.NET

1. Installez des dépendances.

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

2. Authentifiez-vous à l’aide Azure.Identity du package NuGet et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   using Microsoft.Azure.Cosmos;
   using Azure.Core;
   using Azure.Identity;
   using System; 
   
   // Uncomment the following lines according to the authentication type.
   // 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. Ajoutez les dépendances suivantes dans votre fichier 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. Authentifiez-vous via azure-identity et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   import com.azure.cosmos.CosmosClient;
   import com.azure.cosmos.CosmosClientBuilder;
   
   // Uncomment the following lines according to the authentication type.
   // 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

Reportez-vous à la création d’une application Spring Data Azure Cosmos DB v3 pour gérer les données Azure Cosmos DB pour NoSQL pour configurer votre application Spring. Les propriétés de configuration sont ajoutées à Spring Apps by Service Connecter or. La prise en charge des identités managées pour Cosmos DB est disponible uniquement pour Spring Cloud Azure version 4.0 et ultérieure. Pour plus d’informations, reportez-vous à Spring Cloud Azure - Documentation de référence.

Python

1. Installez des dépendances.

   pip install azure-identity
   pip install azure-cosmos
   

2. Authentifiez-vous via azure-identity la bibliothèque et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   import os
   from azure.cosmos import CosmosClient
   from azure.identity import ManagedIdentityCredential, ClientSecretCredential
   
   # Uncomment the following lines according to the authentication type.
   # 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. Installez des dépendances.

   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. Authentifiez-vous à l’aide azidentity du package npm et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   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 according to the authentication type.
       // 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. Installez des dépendances.

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

2. Authentifiez-vous à l’aide @azure/identity du package npm et obtenez l’URL du point de terminaison à partir de la variable d’environnement ajoutée par service Connecter or. Lorsque vous utilisez le code ci-dessous, supprimez les marques de commentaire de la partie de l’extrait de code pour le type d’authentification que vous souhaitez utiliser.

   import { CosmosClient } from "@azure/cosmos";
   const { DefaultAzureCredential } = require("@azure/identity");
   
   // Uncomment the following lines according to the authentication type.
   // 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
   });
   

Autres

Pour d’autres langages, vous pouvez utiliser l’URL du point de terminaison et d’autres propriétés que Service Connecter or définit sur les variables d’environnement pour vous connecter à Azure Cosmos DB pour NoSQL. Pour plus d’informations sur la variable d’environnement, consultez Intégrer Azure Cosmos DB pour NoSQL à Service Connecter or.

Étapes suivantes

Suivez les tutoriels ci-dessous pour en savoir plus sur Service Connector.

En savoir plus sur les concepts Service Connector