整合適用於 Gremlin 的 Azure Cosmos DB 與服務 連線 or

此頁面會顯示支持的驗證方法和用戶端,並顯示您可以使用Service 連線 or 將 Azure Cosmos DB for Apache Gremlin 連線到其他雲端服務的範例程序代碼。 您仍然可以使用其他程式設計語言連線到適用於 Gremlin 的 Azure Cosmos DB,而不需要使用 Service 連線 or。 此頁面也會顯示您在建立服務連線時取得的預設環境變數名稱和值。

支援的計算服務

服務 連線 or 可用來將下列計算服務連線至適用於 Apache Gremlin 的 Azure Cosmos DB:

  • Azure App Service
  • Azure Functions
  • Azure 容器應用程式
  • Azure Spring Apps

支援的驗證類型和客戶端類型

下表顯示使用 Service 連線 or 將計算服務連線至適用於 Apache Gremlin 的 Azure Cosmos DB 時,支援用戶端類型和驗證方法的組合。 「是」表示支持組合,而「否」則表示不支援。

用戶端類型 系統指派的受控識別 使用者指派的受控識別 秘密 / 連接字串 服務主體
.NET Yes .是 .是 Yes
Java Yes .是 .是 Yes
Node.js Yes .是 .是 Yes
PHP Yes .是 .是 Yes
Python Yes .是 .是 Yes
Go Yes .是 .是 Yes
Yes .是 .是 Yes

下表指出支持數據表中所有用戶端類型和驗證方法的組合。 所有客戶端類型都可以使用任何驗證方法,使用 Service 連線 or 連線到適用於 Apache Gremlin 的 Azure Cosmos DB。

默認環境變數名稱或應用程式屬性和範例程序代碼

使用下列連線詳細數據,將計算服務連線到適用於Apache Gremlin的 Azure Cosmos DB。 針對下列每個範例,請將佔位元文字 <Azure-Cosmos-DB-account><database><collection or graphs>、、、<resource-group-name><client-secret><client-ID><password><username><subscription-ID>、和 <tenant-id> 取代為您自己的資訊。 如需命名慣例的詳細資訊,請參閱 Service 連線 or internals 一文。

系統指派的受控識別

默認環境變數名稱 描述 範例值
AZURE_COSMOS_LISTKEYURL 要取得 連接字串的 URL https://management.azure.com/subscriptions/<subscription-ID>/resourceGroups/<resource-group-name>/providers/Microsoft.DocumentDB/databaseAccounts/<Azure-Cosmos-DB-account>/listKeys?api-version=2021-04-15
AZURE_COSMOS_SCOPE 您的受控識別範圍 https://management.azure.com/.default
AZURE_COSMOS_RESOURCEENDPOINT 您的資源端點 https://<Azure-Cosmos-DB-account>.documents.azure.com:443/
AZURE_COSMOS_HOSTNAME 您的 Gremlin 唯一資源識別符 (UFI) <Azure-Cosmos-DB-account>.gremlin.cosmos.azure.com
AZURE_COSMOS_PORT 連線 ion 埠 443
AZURE_COSMOS_USERNAME 您的用戶名稱 /dbs/<database>/colls/<collection or graphs>

範例指令碼

請參閱下列步驟和程序代碼,以使用系統指派的受控識別連線至適用於 Gremlin 的 Azure Cosmos DB。

  1. 安裝相依性。

    dotnet add package Gremlin.Net
    dotnet add package Azure.Identity
    
  2. 使用客戶端連結庫 Azure.Identity 取得受控識別或服務主體的存取令牌。 使用存取令牌並 AZURE_COSMOS_LISTKEYURL 取得密碼。 從 Service 連線 or 所新增的環境變數取得連線資訊,並連線到適用於 Apache Gremlin 的 Azure Cosmos DB。 使用下列程式代碼時,請取消批註您想要使用的驗證類型代碼段部分。

    using System;
    using System.Security.Authentication;
    using System.Net.Security;
    using System.Net.Http;
    using System.Security.Authentication;
    using System.Threading.Tasks;
    using System;
    using Gremlin.Net.Driver;
    using Azure.Identity;
    
    var gremlinEndpoint = Environment.GetEnvironmentVariable("AZURE_COSMOS_RESOURCEENDPOINT");
    var userName = Environment.GetEnvironmentVariable("AZURE_COSMOS_USERNAME");
    var gremlinPort = Int32.Parse(Environment.GetEnvironmentVariable("AZURE_COSMOS_PORT"));
    var listKeyUrl = Environment.GetEnvironmentVariable("AZURE_COSMOS_LISTKEYURL");
    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 password.
    var httpClient = new HttpClient();
    httpClient.DefaultRequestHeaders.Add("Authorization", $"Bearer {accessToken.Token}");
    var response = await httpClient.POSTAsync(listKeyUrl);
    var responseBody = await response.Content.ReadAsStringAsync();
    var keys = JsonConvert.DeserializeObject<Dictionary<string, string>>(responseBody);
    var password = keys["primaryMasterKey"];
    
    // Connect to Azure Cosmos DB for Apache Gremlin
    var server = new GremlinServer(
        hostname: gremlinEndpoint,
        port: gremlinPort,
        username: userName,
        password: password,
        enableSsl: true
    );
    
    using var client = new GremlinClient(
        gremlinServer: server,
        messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
    );        
    
    

使用者指派的受控識別

默認環境變數名稱 描述 範例值
AZURE_COSMOS_LISTKEYURL 要取得 連接字串的 URL https://management.azure.com/subscriptions/<subscription-ID>/resourceGroups/<resource-group-name>/providers/Microsoft.DocumentDB/databaseAccounts/<Azure-Cosmos-DB-account>/listKeys?api-version=2021-04-15
AZURE_COSMOS_SCOPE 您的受控識別範圍 https://management.azure.com/.default
AZURE_COSMOS_RESOURCEENDPOINT 您的資源端點 https://<Azure-Cosmos-DB-account>.documents.azure.com:443/
AZURE_COSMOS_HOSTNAME 您的 Gremlin 唯一資源識別符 (UFI) <Azure-Cosmos-DB-account>.gremlin.cosmos.azure.com
AZURE_COSMOS_PORT 連線 ion 埠 443
AZURE_COSMOS_USERNAME 您的用戶名稱 /dbs/<database>/colls/<collection or graphs>
AZURE_CLIENTID 您的用戶端識別碼 <client_ID>

範例指令碼

請參閱下列步驟和程序代碼,以使用使用者指派的受控識別連線到適用於 Gremlin 的 Azure Cosmos DB。

  1. 安裝相依性。

    dotnet add package Gremlin.Net
    dotnet add package Azure.Identity
    
  2. 使用客戶端連結庫 Azure.Identity 取得受控識別或服務主體的存取令牌。 使用存取令牌並 AZURE_COSMOS_LISTKEYURL 取得密碼。 從 Service 連線 or 所新增的環境變數取得連線資訊,並連線到適用於 Apache Gremlin 的 Azure Cosmos DB。 使用下列程式代碼時,請取消批註您想要使用的驗證類型代碼段部分。

    using System;
    using System.Security.Authentication;
    using System.Net.Security;
    using System.Net.Http;
    using System.Security.Authentication;
    using System.Threading.Tasks;
    using System;
    using Gremlin.Net.Driver;
    using Azure.Identity;
    
    var gremlinEndpoint = Environment.GetEnvironmentVariable("AZURE_COSMOS_RESOURCEENDPOINT");
    var userName = Environment.GetEnvironmentVariable("AZURE_COSMOS_USERNAME");
    var gremlinPort = Int32.Parse(Environment.GetEnvironmentVariable("AZURE_COSMOS_PORT"));
    var listKeyUrl = Environment.GetEnvironmentVariable("AZURE_COSMOS_LISTKEYURL");
    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 password.
    var httpClient = new HttpClient();
    httpClient.DefaultRequestHeaders.Add("Authorization", $"Bearer {accessToken.Token}");
    var response = await httpClient.POSTAsync(listKeyUrl);
    var responseBody = await response.Content.ReadAsStringAsync();
    var keys = JsonConvert.DeserializeObject<Dictionary<string, string>>(responseBody);
    var password = keys["primaryMasterKey"];
    
    // Connect to Azure Cosmos DB for Apache Gremlin
    var server = new GremlinServer(
        hostname: gremlinEndpoint,
        port: gremlinPort,
        username: userName,
        password: password,
        enableSsl: true
    );
    
    using var client = new GremlinClient(
        gremlinServer: server,
        messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
    );        
    
    

Connection string

默認環境變數名稱 描述 範例值
AZURE_COSMOS_HOSTNAME 您的 Gremlin 唯一資源識別符 (UFI) <Azure-Cosmos-DB-account>.gremlin.cosmos.azure.com
AZURE_COSMOS_PORT 連線 ion 埠 443
AZURE_COSMOS_USERNAME 您的用戶名稱 /dbs/<database>/colls/<collection or graphs>
AZURE_COSMOS_PASSWORD 您的密碼 <password>

範例指令碼

請參閱下列步驟和程序代碼,以使用 連接字串 連線到適用於 Gremlin 的 Azure Cosmos DB。

  1. 安裝相依性。

    dotnet add package Gremlin.Net
    
  2. 從 Service 連線 or 所新增的環境變數取得連線資訊,並連線到適用於 Apache Gremlin 的 Azure Cosmos DB。

    using System;
    using Gremlin.Net.Driver;
    
    var gremlinEndpoint = Environment.GetEnvironmentVariable("AZURE_COSMOS_RESOURCEENDPOINT");
    var userName = Environment.GetEnvironmentVariable("AZURE_COSMOS_USERNAME");
    var password = Environment.GetEnvironmentVariable("AZURE_COSMOS_PASSWORD");
    var gremlinPort = Int32.Parse(Environment.GetEnvironmentVariable("AZURE_COSMOS_PORT"));
    
    var server = new GremlinServer(
        hostname: gremlinEndpoint,
        port: gremlinPort,
        username: userName,
        password: password,
        enableSsl: true
    );
    
    using var client = new GremlinClient(
        gremlinServer: server,
        messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
    );
    

服務主體

默認環境變數名稱 描述 範例值
AZURE_COSMOS_LISTKEYURL 要取得 連接字串的 URL https://management.azure.com/subscriptions/<subscription-ID>/resourceGroups/<resource-group-name>/providers/Microsoft.DocumentDB/databaseAccounts/<Azure-Cosmos-DB-account>/listKeys?api-version=2021-04-15
AZURE_COSMOS_SCOPE 您的受控識別範圍 https://management.azure.com/.default
AZURE_COSMOS_RESOURCEENDPOINT 您的資源端點 https://<Azure-Cosmos-DB-account>.documents.azure.com:443/
AZURE_COSMOS_HOSTNAME 您的 Gremlin 唯一資源識別符 (UFI) <Azure-Cosmos-DB-account>.gremlin.cosmos.azure.com
AZURE_COSMOS_PORT Gremlin 連線埠 10350
AZURE_COSMOS_USERNAME 您的用戶名稱 </dbs/<database>/colls/<collection or graphs>
AZURE_COSMOS_CLIENTID 您的用戶端識別碼 <client-ID>
AZURE_COSMOS_CLIENTSECRET 您的客戶端密碼 <client-secret>
AZURE_COSMOS_TENANTID 您的租用戶識別碼 <tenant-ID>

範例指令碼

請參閱下面的步驟和程序代碼,以使用服務主體連線到適用於 Gremlin 的 Azure Cosmos DB。

  1. 安裝相依性。

    dotnet add package Gremlin.Net
    dotnet add package Azure.Identity
    
  2. 使用客戶端連結庫 Azure.Identity 取得受控識別或服務主體的存取令牌。 使用存取令牌並 AZURE_COSMOS_LISTKEYURL 取得密碼。 從 Service 連線 or 所新增的環境變數取得連線資訊,並連線到適用於 Apache Gremlin 的 Azure Cosmos DB。 使用下列程式代碼時,請取消批註您想要使用的驗證類型代碼段部分。

    using System;
    using System.Security.Authentication;
    using System.Net.Security;
    using System.Net.Http;
    using System.Security.Authentication;
    using System.Threading.Tasks;
    using System;
    using Gremlin.Net.Driver;
    using Azure.Identity;
    
    var gremlinEndpoint = Environment.GetEnvironmentVariable("AZURE_COSMOS_RESOURCEENDPOINT");
    var userName = Environment.GetEnvironmentVariable("AZURE_COSMOS_USERNAME");
    var gremlinPort = Int32.Parse(Environment.GetEnvironmentVariable("AZURE_COSMOS_PORT"));
    var listKeyUrl = Environment.GetEnvironmentVariable("AZURE_COSMOS_LISTKEYURL");
    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 password.
    var httpClient = new HttpClient();
    httpClient.DefaultRequestHeaders.Add("Authorization", $"Bearer {accessToken.Token}");
    var response = await httpClient.POSTAsync(listKeyUrl);
    var responseBody = await response.Content.ReadAsStringAsync();
    var keys = JsonConvert.DeserializeObject<Dictionary<string, string>>(responseBody);
    var password = keys["primaryMasterKey"];
    
    // Connect to Azure Cosmos DB for Apache Gremlin
    var server = new GremlinServer(
        hostname: gremlinEndpoint,
        port: gremlinPort,
        username: userName,
        password: password,
        enableSsl: true
    );
    
    using var client = new GremlinClient(
        gremlinServer: server,
        messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
    );        
    
    

下一步

請遵循下列教學課程,深入瞭解 Service 連線 or。