Freigeben über


Integrieren von Azure Cosmos DB for MongoDB mit Service Connector

Diese Seite zeigt unterstützte Authentifizierungsmethoden und Clients und zeigt Beispielcode, den Sie verwenden können, um die Azure Cosmos DB für MongoDB mit anderen Clouddiensten mithilfe von Service Verbinden or zu verbinden. Möglicherweise können Sie weiterhin eine Verbindung mit Azure Cosmos DB für MongoDB in anderen Programmiersprachen herstellen, ohne Service Verbinden or zu verwenden. Auf dieser Seite werden auch die Namen und Werte der Standardumgebungsvariablen (oder die Spring Boot-Konfiguration) angezeigt, die Sie erhalten, wenn Sie die Dienstverbindung erstellen.

Unterstützte Computedienste

Der Dienst Verbinden or kann verwendet werden, um die folgenden Computedienste mit Azure Cosmos DB für MongoDB zu verbinden:

  • Azure App Service
  • Azure-Funktionen
  • Azure Container Apps
  • Azure Spring Apps

Unterstützte Authentifizierungstypen und Clienttypen

Die folgende Tabelle zeigt, welche Kombinationen von Clienttypen und Authentifizierungsmethoden für die Verbindung Ihres Computediensts mit Azure Cosmos DB für MongoDB mithilfe von Service Verbinden or unterstützt werden. Ein "Ja" gibt an, dass die Kombination unterstützt wird, während ein "Nein" angibt, dass sie nicht unterstützt wird.

Clienttyp Systemseitig zugewiesene verwaltete Identität Benutzerseitig zugewiesene verwaltete Identität Geheimnis/Verbindungszeichenfolge Dienstprinzipal
.NET Ja Ja Ja Ja
Java Ja Ja Ja Ja
Java - Spring Boot Nein Nein Ja Nein
Node.js Ja Ja Ja Ja
Python Ja Ja Ja Ja
Go Ja Ja Ja Ja
Keine Ja Ja Ja Ja

Diese Tabelle gibt an, dass alle Kombinationen von Clienttypen und Authentifizierungsmethoden in der Tabelle unterstützt werden, mit Ausnahme des Clienttyps "Java - Spring Boot", der nur die Methode "Secret/Verbindungszeichenfolge" unterstützt. Alle anderen Clienttypen können jede der Authentifizierungsmethoden verwenden, um mithilfe von Service Verbinden or eine Verbindung mit Azure Cosmos DB für MongoDB herzustellen.

Standardumgebungsvariablennamen oder Anwendungseigenschaften und Beispielcode

Verwenden Sie die nachstehenden Verbindungsdetails, um Computedienste mit Azure Cosmos DB zu verbinden. Auf dieser Seite werden auch Die Namen und Werte der Standardumgebungsvariablen (oder spring Boot-Konfiguration) angezeigt, die Sie beim Erstellen der Dienstverbindung erhalten, sowie Beispielcode. Ersetzen Sie den Platzhaltertext <mongo-db-admin-user>, <password>, <Azure-Cosmos-DB-API-for-MongoDB-account>, <subscription-ID>, <resource-group-name>, <client-secret> und <tenant-id> in allen Beispielen unten durch Ihre eigenen Informationen. Weitere Informationen zu Benennungskonventionen finden Sie im Artikel "Service Verbinden or internals".

Systemseitig zugewiesene verwaltete Identität

Standardname der Umgebungsvariablen Beschreibung Beispielswert
AZURE_COSMOS_LISTCONNECTIONSTRINGURL Die URL zum Abrufen der Verbindungszeichenfolge https://management.azure.com/subscriptions/<subscription-ID>/resourceGroups/<resource-group-name>/providers/Microsoft.DocumentDB/databaseAccounts/<Azure-Cosmos-DB-API-for-MongoDB-account>/listConnectionStrings?api-version=2021-04-15
AZURE_COSMOS_SCOPE Ihr verwalteter Identitätsumfang https://management.azure.com/.default
AZURE_COSMOS_RESOURCEENDPOINT Ihr Ressourcenendpunkt https://<Azure-Cosmos-DB-API-for-MongoDB-account>.documents.azure.com:443/

Beispielcode

Lesen Sie die schritte und den folgenden Code, um mithilfe einer vom System zugewiesenen verwalteten Identität eine Verbindung mit Azure Cosmos DB für MongoDB herzustellen.

  1. Installieren von Abhängigkeiten

    dotnet add package MongoDb.Driver
    dotnet add package Azure.Identity
    
  2. Rufen Sie ein Zugriffstoken für die verwaltete Identität oder den Dienstprinzipal mithilfe der Clientbibliothek Azure.Identity ab. Verwenden Sie das Zugriffstoken, und AZURE_COSMOS_LISTCONNECTIONSTRINGURL rufen Sie die Verbindungszeichenfolge ab. Rufen Sie die Verbindungsinformationen aus den von Service Verbinden or hinzugefügten Umgebungsvariablen ab, und stellen Sie eine Verbindung mit Azure Cosmos DB für MongoDB her. Wenn Sie den folgenden Code verwenden, heben Sie die Auskommentierung des Teils des Codeschnipsels für den Authentifizierungstyp auf, den Sie verwenden möchten.

    using System;
    using System.Security.Authentication;
    using System.Net.Security;
    using System.Net.Http;
    using System.Security.Authentication;
    using System.Security.Cryptography.X509Certificates;
    using System.Threading.Tasks;
    using MongoDB.Driver;
    using Azure.Identity;
    using System.Text.Json;
    
    var endpoint = Environment.GetEnvironmentVariable("AZURE_COSMOS_RESOURCEENDPOINT");
    var listConnectionStringUrl = Environment.GetEnvironmentVariable("AZURE_COSMOS_LISTCONNECTIONSTRINGURL");
    var scope = Environment.GetEnvironmentVariable("AZURE_COSMOS_SCOPE");
    
    // Uncomment the following lines according to the authentication type.
    // For system-assigned identity.
    // var tokenProvider = new DefaultAzureCredential();
    
    // For user-assigned identity.
    // var tokenProvider = new DefaultAzureCredential(
    //     new DefaultAzureCredentialOptions
    //     {
    //         ManagedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTID");
    //     }
    // );
    
    // For service principal.
    // var tenantId = Environment.GetEnvironmentVariable("AZURE_COSMOS_TENANTID");
    // var clientId = Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTID");
    // var clientSecret = Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTSECRET");
    // var tokenProvider = new ClientSecretCredential(tenantId, clientId, clientSecret);
    
    // Acquire the access token. 
    AccessToken accessToken = await tokenProvider.GetTokenAsync(
        new TokenRequestContext(scopes: new string[]{ scope }));
    
    // Get the connection string.
    var httpClient = new HttpClient();
    httpClient.DefaultRequestHeaders.Add("Authorization", $"Bearer {accessToken.Token}");
    var response = await httpClient.POSTAsync(listConnectionStringUrl);
    var responseBody = await response.Content.ReadAsStringAsync();
    var connectionStrings = JsonSerializer.Deserialize<Dictionary<string, List<Dictionary<string, string>>>>(responseBody);
    string connectionString = connectionStrings["connectionStrings"][0]["connectionString"];
    
    // Connect to Azure Cosmos DB for MongoDB
    var client = new MongoClient(connectionString);
    

Benutzerseitig zugewiesene verwaltete Identität

Standardname der Umgebungsvariablen Beschreibung Beispielswert
AZURE_COSMOS_LISTCONNECTIONSTRINGURL Die URL zum Abrufen der Verbindungszeichenfolge https://management.azure.com/subscriptions/<subscription-ID>/resourceGroups/<resource-group-name>/providers/Microsoft.DocumentDB/databaseAccounts/<Azure-Cosmos-DB-API-for-MongoDB-account>/listConnectionStrings?api-version=2021-04-15
AZURE_COSMOS_SCOPE Ihr verwalteter Identitätsumfang https://management.azure.com/.default
AZURE_COSMOS_CLIENTID Ihre Client-ID <client-ID>
AZURE_COSMOS_RESOURCEENDPOINT Ihr Ressourcenendpunkt https://<Azure-Cosmos-DB-API-for-MongoDB-account>.documents.azure.com:443/

Beispielcode

In den schritten und code below to connect to Azure Cosmos DB for MongoDB using a user-assigned managed identity.

  1. Installieren von Abhängigkeiten

    dotnet add package MongoDb.Driver
    dotnet add package Azure.Identity
    
  2. Rufen Sie ein Zugriffstoken für die verwaltete Identität oder den Dienstprinzipal mithilfe der Clientbibliothek Azure.Identity ab. Verwenden Sie das Zugriffstoken, und AZURE_COSMOS_LISTCONNECTIONSTRINGURL rufen Sie die Verbindungszeichenfolge ab. Rufen Sie die Verbindungsinformationen aus den von Service Verbinden or hinzugefügten Umgebungsvariablen ab, und stellen Sie eine Verbindung mit Azure Cosmos DB für MongoDB her. Wenn Sie den folgenden Code verwenden, heben Sie die Auskommentierung des Teils des Codeschnipsels für den Authentifizierungstyp auf, den Sie verwenden möchten.

    using System;
    using System.Security.Authentication;
    using System.Net.Security;
    using System.Net.Http;
    using System.Security.Authentication;
    using System.Security.Cryptography.X509Certificates;
    using System.Threading.Tasks;
    using MongoDB.Driver;
    using Azure.Identity;
    using System.Text.Json;
    
    var endpoint = Environment.GetEnvironmentVariable("AZURE_COSMOS_RESOURCEENDPOINT");
    var listConnectionStringUrl = Environment.GetEnvironmentVariable("AZURE_COSMOS_LISTCONNECTIONSTRINGURL");
    var scope = Environment.GetEnvironmentVariable("AZURE_COSMOS_SCOPE");
    
    // Uncomment the following lines according to the authentication type.
    // For system-assigned identity.
    // var tokenProvider = new DefaultAzureCredential();
    
    // For user-assigned identity.
    // var tokenProvider = new DefaultAzureCredential(
    //     new DefaultAzureCredentialOptions
    //     {
    //         ManagedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTID");
    //     }
    // );
    
    // For service principal.
    // var tenantId = Environment.GetEnvironmentVariable("AZURE_COSMOS_TENANTID");
    // var clientId = Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTID");
    // var clientSecret = Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTSECRET");
    // var tokenProvider = new ClientSecretCredential(tenantId, clientId, clientSecret);
    
    // Acquire the access token. 
    AccessToken accessToken = await tokenProvider.GetTokenAsync(
        new TokenRequestContext(scopes: new string[]{ scope }));
    
    // Get the connection string.
    var httpClient = new HttpClient();
    httpClient.DefaultRequestHeaders.Add("Authorization", $"Bearer {accessToken.Token}");
    var response = await httpClient.POSTAsync(listConnectionStringUrl);
    var responseBody = await response.Content.ReadAsStringAsync();
    var connectionStrings = JsonSerializer.Deserialize<Dictionary<string, List<Dictionary<string, string>>>>(responseBody);
    string connectionString = connectionStrings["connectionStrings"][0]["connectionString"];
    
    // Connect to Azure Cosmos DB for MongoDB
    var client = new MongoClient(connectionString);
    

Verbindungszeichenfolge

SpringBoot-Clienttyp

Standardname der Umgebungsvariablen Beschreibung Beispielswert
spring.data.mongodb.database Ihre Datenbank <database-name>
spring.data.mongodb.uri Der URI Ihrer Datenbank. mongodb://<mongo-db-admin-user>:<password>@<mongo-db-server>.mongo.cosmos.azure.com:10255/?ssl=true&replicaSet=globaldb&retrywrites=false&maxIdleTimeMS=120000&appName=@<mongo-db-server>@

Andere Clienttypen

Standardname der Umgebungsvariablen Beschreibung Beispielswert
AZURE_COSMOS_CONNECTIONSTRING MongoDB-API-Verbindungszeichenfolge mongodb://<mongo-db-admin-user>:<password>@<mongo-db-server>.mongo.cosmos.azure.com:10255/?ssl=true&replicaSet=globaldb&retrywrites=false&maxIdleTimeMS=120000&appName=@<mongo-db-server>@

Beispielcode

Lesen Sie die schritte und den folgenden Code, um mithilfe eines Verbindungszeichenfolge eine Verbindung mit Azure Cosmos DB für MongoDB herzustellen.

  1. Installieren Sie Abhängigkeiten.

    dotnet add package MongoDb.Driver
    
  2. Rufen Sie die Verbindungszeichenfolge von Service Verbinden or hinzugefügte Umgebungsvariable ab, und stellen Sie eine Verbindung mit Azure Cosmos DB für MongoDB her.

    using MongoDB.Driver;
    
    var connectionString = Environment.GetEnvironmentVariable("AZURE_COSMOS_CONNECTIONSTRING");
    var client = new MongoClient(connectionString);
    

Dienstprinzipal

Standardname der Umgebungsvariablen Beschreibung Beispielswert
AZURE_COSMOS_LISTCONNECTIONSTRINGURL Die URL zum Abrufen der Verbindungszeichenfolge https://management.azure.com/subscriptions/<subscription-ID>/resourceGroups/<resource-group-name>/providers/Microsoft.DocumentDB/databaseAccounts/<Azure-Cosmos-DB-API-for-MongoDB-account>/listConnectionStrings?api-version=2021-04-15
AZURE_COSMOS_SCOPE Ihr verwalteter Identitätsumfang https://management.azure.com/.default
AZURE_COSMOS_CLIENTID Ihre Client-ID <client-ID>
AZURE_COSMOS_CLIENTSECRET Ihr geheimer Clientschlüssel <client-secret>
AZURE_COSMOS_TENANTID Ihre Mandanten-ID <tenant-ID>
AZURE_COSMOS_RESOURCEENDPOINT Ihr Ressourcenendpunkt https://<Azure-Cosmos-DB-API-for-MongoDB-account>.documents.azure.com:443/

Beispielcode

Lesen Sie die schritte und den folgenden Code, um mithilfe eines Dienstprinzipals eine Verbindung mit Azure Cosmos DB für MongoDB herzustellen.

  1. Installieren von Abhängigkeiten

    dotnet add package MongoDb.Driver
    dotnet add package Azure.Identity
    
  2. Rufen Sie ein Zugriffstoken für die verwaltete Identität oder den Dienstprinzipal mithilfe der Clientbibliothek Azure.Identity ab. Verwenden Sie das Zugriffstoken, und AZURE_COSMOS_LISTCONNECTIONSTRINGURL rufen Sie die Verbindungszeichenfolge ab. Rufen Sie die Verbindungsinformationen aus den von Service Verbinden or hinzugefügten Umgebungsvariablen ab, und stellen Sie eine Verbindung mit Azure Cosmos DB für MongoDB her. Wenn Sie den folgenden Code verwenden, heben Sie die Auskommentierung des Teils des Codeschnipsels für den Authentifizierungstyp auf, den Sie verwenden möchten.

    using System;
    using System.Security.Authentication;
    using System.Net.Security;
    using System.Net.Http;
    using System.Security.Authentication;
    using System.Security.Cryptography.X509Certificates;
    using System.Threading.Tasks;
    using MongoDB.Driver;
    using Azure.Identity;
    using System.Text.Json;
    
    var endpoint = Environment.GetEnvironmentVariable("AZURE_COSMOS_RESOURCEENDPOINT");
    var listConnectionStringUrl = Environment.GetEnvironmentVariable("AZURE_COSMOS_LISTCONNECTIONSTRINGURL");
    var scope = Environment.GetEnvironmentVariable("AZURE_COSMOS_SCOPE");
    
    // Uncomment the following lines according to the authentication type.
    // For system-assigned identity.
    // var tokenProvider = new DefaultAzureCredential();
    
    // For user-assigned identity.
    // var tokenProvider = new DefaultAzureCredential(
    //     new DefaultAzureCredentialOptions
    //     {
    //         ManagedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTID");
    //     }
    // );
    
    // For service principal.
    // var tenantId = Environment.GetEnvironmentVariable("AZURE_COSMOS_TENANTID");
    // var clientId = Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTID");
    // var clientSecret = Environment.GetEnvironmentVariable("AZURE_COSMOS_CLIENTSECRET");
    // var tokenProvider = new ClientSecretCredential(tenantId, clientId, clientSecret);
    
    // Acquire the access token. 
    AccessToken accessToken = await tokenProvider.GetTokenAsync(
        new TokenRequestContext(scopes: new string[]{ scope }));
    
    // Get the connection string.
    var httpClient = new HttpClient();
    httpClient.DefaultRequestHeaders.Add("Authorization", $"Bearer {accessToken.Token}");
    var response = await httpClient.POSTAsync(listConnectionStringUrl);
    var responseBody = await response.Content.ReadAsStringAsync();
    var connectionStrings = JsonSerializer.Deserialize<Dictionary<string, List<Dictionary<string, string>>>>(responseBody);
    string connectionString = connectionStrings["connectionStrings"][0]["connectionString"];
    
    // Connect to Azure Cosmos DB for MongoDB
    var client = new MongoClient(connectionString);
    

Nächste Schritte

Befolgen Sie die unten aufgeführten Tutorials, um mehr über Service Connector zu erfahren.