Integrare Azure Cosmos DB for NoSQL con Connettore di servizi

Questa pagina mostra i client e i metodi di autenticazione supportati, e mostra un codice di esempio che è possibile usare per connettere Azure Cosmos DB for NoSQL ad altri servizi cloud tramite Connettore di servizi. È comunque possibile connettersi ad Azure Cosmos DB for NoSQL con altri linguaggi di programmazione senza usare Connettore di servizi. Questa pagina mostra anche i nomi e i valori predefiniti delle variabili di ambiente (o configurazione spring boot) che si ottengono quando si crea la connessione al servizio.

Servizi di calcolo supportati

Connettore di servizi può essere usato per connettere i servizi di calcolo seguenti ad Azure Cosmos DB for NoSQL:

• Servizio app di Azure
• App contenitore di Azure
• Funzioni di Azure
• Servizio Azure Kubernetes (AKS)
• Azure Spring Apps

Tipi di autenticazione e di client supportati

La tabella seguente illustra le combinazioni di tipi client e metodi di autenticazione supportati per la connessione del servizio di calcolo a Azure Cosmos DB for NoSQL tramite Connettore di servizi. Un valore "Sì" indica che la combinazione è supportata, mentre "No" indica che non è supportata.

Tipo client	Identità gestita assegnata dal sistema	Identità gestita assegnata dall'utente	Stringa di segreto/connessione	Entità servizio
.NET	Sì	Sì	Sì	Sì
Java	Sì	Sì	Sì	Sì
Java - Spring Boot	Sì	Sì	Sì	Sì
Node.js	Sì	Sì	Sì	Sì
Python	Sì	Sì	Sì	Sì
Go	Sì	Sì	Sì	Sì
Nessuno	Sì	Sì	Sì	Sì

Questa tabella indica che tutte le combinazioni di tipi client e metodi di autenticazione nella tabella sono supportate. Tutti i tipi di client possono usare uno dei metodi di autenticazione per connettersi ad Azure Cosmos DB for NoSQL tramite Connettore di servizi.

Nomi di variabili di ambiente predefiniti o proprietà dell'applicazione e codice di esempio

Usare i dettagli di connessione seguenti per connettere i servizi di calcolo ad Azure Cosmos DB for NoSQL. Per ogni esempio seguente, sostituire i testi segnaposto <database-server>, <database-name>, <account-key>, <resource-group-name>, <subscription-ID>, <client-ID>, <SQL-server>, <client-secret>, <tenant-id> e <access-key> con le proprie informazioni. Per altre informazioni sulle convenzioni di denominazione, vedere l'articolo Elementi interni di Service Connector.

Identità gestita assegnata dal sistema

Tipo di client SpringBoot

L'uso di un'identità gestita assegnata dal sistema come tipo di autenticazione è disponibile solo per Spring Cloud Azure versione 4.0 o successive.

Nome variabile di ambiente predefinito	Descrizione	Valore di esempio
spring.cloud.azure.cosmos.credential.managed-identity-enabled	Se abilitare l'identità gestita	true
spring.cloud.azure.cosmos.database	Database	https://management.azure.com/.default
spring.cloud.azure.cosmos.endpoint	Endpoint risorsa	https://<database-server>.documents.azure.com:443/

Altri tipi di client

Nome variabile di ambiente predefinito	Descrizione	Valore di esempio
AZURE_COSMOS_LISTCONNECTIONSTRINGURL	L'URL per ottenere la stringa di connessione	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	L'ambito dell'identità gestita	https://management.azure.com/.default
AZURE_COSMOS_RESOURCEENDPOINT	L'endpoint della risorsa	https://<database-server>.documents.azure.com:443/

Codice di esempio

Vedere i passaggi e il codice seguenti per connettersi ad Azure Cosmos DB for NoSQL usando un'identità assegnata dal sistema.

.NET

1. Installare le dipendenze.

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

2. Eseguire l'autenticazione usando il pacchetto NuGet Azure.Identity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

   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. Aggiungere le dipendenze seguenti nel file 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. Eseguire l'autenticazione tramite azure-identity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

   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

Vedere Creare un'app Spring Data Azure Cosmos DB v3 per gestire i dati di Azure Cosmos DB for NoSQL per configurare l'applicazione Spring. Le proprietà di configurazione sono aggiunte a Spring App da Service Connector. Il supporto delle identità gestite per Cosmos DB è disponibile solo per Spring Cloud Azure versione 4.0 e successive. Per altre informazioni, vedere Spring Cloud Azure - Documentazione di riferimento.

Python

1. Installare le dipendenze.

   pip install azure-identity
   pip install azure-cosmos
   

2. Eseguire l'autenticazione usando la libreria azure-identity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

   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. Installare le dipendenze.

   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. Eseguire l'autenticazione usando il pacchetto npm azidentity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

   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. Installare le dipendenze.

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

2. Eseguire l'autenticazione usando il pacchetto npm @azure/identity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

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

Altro

Per altri linguaggi, è possibile usare l'URL dell'endpoint e altre proprietà impostate dal Connettore di servizi sulle variabili di ambiente per connettersi ad Azure Cosmos DB for NoSQL. Per dettagli sulle variabili di ambiente, vedere Integrare Azure Cosmos DB for NoSQL con Connettore di servizi.

Identità gestita assegnata dall'utente

Tipo di client SpringBoot

L'uso di un'identità gestita assegnata dall'utente come tipo di autenticazione è disponibile solo per Spring Cloud Azure versione 4.0 o successive.

Nome variabile di ambiente predefinito	Descrizione	Valore di esempio
spring.cloud.azure.cosmos.credential.managed-identity-enabled	Se abilitare l'identità gestita	true
spring.cloud.azure.cosmos.database	Database	https://management.azure.com/.default
spring.cloud.azure.cosmos.endpoint	Endpoint risorsa	https://<database-server>.documents.azure.com:443/
spring.cloud.azure.cosmos.credential.client-id	L’ID client	<client-ID>

Altri tipi di client

Nome variabile di ambiente predefinito	Descrizione	Valore di esempio
AZURE_COSMOS_LISTCONNECTIONSTRINGURL	L'URL per ottenere la stringa di connessione	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	L'ambito dell'identità gestita	https://management.azure.com/.default
AZURE_COSMOS_CLIENTID	L’ID client	<client-ID>
AZURE_COSMOS_RESOURCEENDPOINT	L'endpoint della risorsa	https://<database-server>.documents.azure.com:443/

Codice di esempio

Vedere i passaggi e il codice seguenti per connettersi ad Azure Cosmos DB for NoSQL usando un'identità assegnata dall'utente.

.NET

1. Installare le dipendenze.

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

2. Eseguire l'autenticazione usando il pacchetto NuGet Azure.Identity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

   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. Aggiungere le dipendenze seguenti nel file 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. Eseguire l'autenticazione tramite azure-identity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

   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

Vedere Creare un'app Spring Data Azure Cosmos DB v3 per gestire i dati di Azure Cosmos DB for NoSQL per configurare l'applicazione Spring. Le proprietà di configurazione sono aggiunte a Spring App da Service Connector. Il supporto delle identità gestite per Cosmos DB è disponibile solo per Spring Cloud Azure versione 4.0 e successive. Per altre informazioni, vedere Spring Cloud Azure - Documentazione di riferimento.

Python

1. Installare le dipendenze.

   pip install azure-identity
   pip install azure-cosmos
   

2. Eseguire l'autenticazione usando la libreria azure-identity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

   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. Installare le dipendenze.

   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. Eseguire l'autenticazione usando il pacchetto npm azidentity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

   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. Installare le dipendenze.

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

2. Eseguire l'autenticazione usando il pacchetto npm @azure/identity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

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

Altro

Per altri linguaggi, è possibile usare l'URL dell'endpoint e altre proprietà impostate dal Connettore di servizi sulle variabili di ambiente per connettersi ad Azure Cosmos DB for NoSQL. Per dettagli sulle variabili di ambiente, vedere Integrare Azure Cosmos DB for NoSQL con Connettore di servizi.

Stringa di connessione

Avviso

Microsoft consiglia di usare il flusso di autenticazione più sicuro disponibile. Il flusso di autenticazione descritto in questa procedura richiede un livello di attendibilità molto elevato nell'applicazione e comporta rischi che non sono presenti in altri flussi. Si consiglia di usare questo flusso solo quando altri flussi più sicuri, come le identità gestite, non sono validi.

Tipo di client SpringBoot

Nome variabile di ambiente predefinito	Descrizione	Valore di esempio
azure.cosmos.key	Chiave di accesso del database per le versioni di Spring Cloud Azure precedenti alla 4.0	<access-key>
azure.cosmos.database	Database per le versioni di Spring Cloud Azure precedenti alla 4.0	<database-name>
azure.cosmos.uri	URI del database per le versioni di Spring Cloud Azure precedenti alla 4.0	https://<database-server>.documents.azure.com:443/
spring.cloud.azure.cosmos.key	Chiave di accesso del database per le versioni di Spring Cloud Azure successive alla 4.0	<access-key>
spring.cloud.azure.cosmos.database	Database per le versioni di Spring Cloud Azure successive alla 4.0	<database-name>
spring.cloud.azure.cosmos.endpoint	URI del database per le versioni di Spring Cloud Azure successive alla 4.0	https://<database-server>.documents.azure.com:443/

Altri tipi di client

Nome variabile di ambiente predefinito	Descrizione	Valore di esempio
AZURE_COSMOS_CONNECTIONSTRING	Stringa di connessione di Azure Cosmos DB for NoSQL	AccountEndpoint=https://<database-server>.documents.azure.com:443/;AccountKey=<account-key>

Codice di esempio

Vedere i passaggi e il codice seguenti per connettersi ad Azure Cosmos DB for NoSQL usando una stringa di connessione.

.NET

1. Installare la dipendenza.

   dotnet add package Microsoft.Azure.Cosmos
   

2. Ottenere la stringa di connessione dalla variabile di ambiente aggiunta da Service Connector.

   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. Aggiungere la dipendenza seguente nel file pom.xml:

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

2. Ottenere la stringa di connessione dalla variabile di ambiente aggiunta da Service Connector.

   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

Vedere esempi di Spring Data Azure Cosmos DB v3 e Creare un'app Spring Data Azure Cosmos DB v3 per gestire i dati di Azure Cosmos DB for NoSQL per configurare l'applicazione Spring. Le proprietà di configurazione sono aggiunte a Spring App da Service Connector. Vengono forniti due set di proprietà di configurazione a seconda della versione di Spring Cloud Azure (precedente alla 4.0 e successiva alla 4.0). Per altre informazioni sulle modifiche apportate alla libreria Spring Cloud di Azure, vedere Guida alla migrazione di Spring Cloud Azure. È consigliabile usare Spring Cloud Azure versione 4.0 e successive. Le configurazioni nel formato "azure.cosmos.*" di Spring Cloud Azure 3.x non saranno più supportate dopo il 1° luglio 2024.

Python

1. Installare la dipendenza.

   pip install azure-cosmos
   

2. Ottenere la stringa di connessione dalla variabile di ambiente aggiunta da Service Connector.

   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. Installare la dipendenza.

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

2. Ottenere la stringa di connessione dalla variabile di ambiente aggiunta da Service Connector.

   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. Installare la dipendenza.

   npm install @azure/cosmos
   

2. Ottenere la stringa di connessione dalla variabile di ambiente aggiunta da Service Connector.

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

Altro

Per altri linguaggi, è possibile usare l'URL dell'endpoint e altre proprietà impostate dal Connettore di servizi sulle variabili di ambiente per connettersi ad Azure Cosmos DB for NoSQL. Per dettagli sulle variabili di ambiente, vedere Integrare Azure Cosmos DB for NoSQL con Connettore di servizi.

Entità servizio

Tipo di client SpringBoot

Nome variabile di ambiente predefinito	Descrizione	Valore di esempio
spring.cloud.azure.cosmos.credential.client-id	L’ID client	<client-ID>
spring.cloud.azure.cosmos.credential.client-secret	Segreto client	<client-secret>
spring.cloud.azure.cosmos.profile.tenant-id	ID del tenant.	<tenant-ID>
spring.cloud.azure.cosmos.database	Database	<database-name>
spring.cloud.azure.cosmos.endpoint	Endpoint risorsa	https://<database-server>.documents.azure.com:443/

Altri tipi di client

Nome variabile di ambiente predefinito	Descrizione	Valore di esempio
AZURE_COSMOS_LISTCONNECTIONSTRINGURL	L'URL per ottenere la stringa di connessione	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	L'ambito dell'identità gestita	https://management.azure.com/.default
AZURE_COSMOS_CLIENTID	ID segreto client	<client-ID>
AZURE_COSMOS_CLIENTSECRET	Segreto client	<client-secret>
AZURE_COSMOS_TENANTID	ID del tenant.	<tenant-ID>
AZURE_COSMOS_RESOURCEENDPOINT	L'endpoint della risorsa	https://<database-server>.documents.azure.com:443/

Codice di esempio

Vedere i passaggi e il codice seguenti per connettersi ad Azure Cosmos DB for NoSQL usando un'entità servizio.

.NET

1. Installare le dipendenze.

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

2. Eseguire l'autenticazione usando il pacchetto NuGet Azure.Identity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

   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. Aggiungere le dipendenze seguenti nel file 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. Eseguire l'autenticazione tramite azure-identity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

   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

Vedere Creare un'app Spring Data Azure Cosmos DB v3 per gestire i dati di Azure Cosmos DB for NoSQL per configurare l'applicazione Spring. Le proprietà di configurazione sono aggiunte a Spring App da Service Connector. Il supporto delle identità gestite per Cosmos DB è disponibile solo per Spring Cloud Azure versione 4.0 e successive. Per altre informazioni, vedere Spring Cloud Azure - Documentazione di riferimento.

Python

1. Installare le dipendenze.

   pip install azure-identity
   pip install azure-cosmos
   

2. Eseguire l'autenticazione usando la libreria azure-identity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

   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. Installare le dipendenze.

   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. Eseguire l'autenticazione usando il pacchetto npm azidentity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

   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. Installare le dipendenze.

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

2. Eseguire l'autenticazione usando il pacchetto npm @azure/identity e ottenere l'URL dell'endpoint dalla variabile di ambiente aggiunta da Connettore di servizi. Quando si usa il codice seguente, rimuovere il commento dalla parte del frammento di codice per il tipo di autenticazione che si vuole usare.

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

Altro

Per altri linguaggi, è possibile usare l'URL dell'endpoint e altre proprietà impostate dal Connettore di servizi sulle variabili di ambiente per connettersi ad Azure Cosmos DB for NoSQL. Per dettagli sulle variabili di ambiente, vedere Integrare Azure Cosmos DB for NoSQL con Connettore di servizi.

Passaggi successivi

Per altre informazioni sul connettore di servizi seguire le esercitazioni riportate di seguito.

Informazioni sui concetti del connettore di servizi