Интеграция Azure Cosmos DB для Gremlin с соединителем службы

Статья
10/16/2024

На этой странице показаны поддерживаемые методы проверки подлинности и клиенты, а также показан пример кода, который можно использовать для подключения Azure Cosmos DB для Apache Gremlin к другим облачным службам с помощью соединителя служб. Вы по-прежнему можете подключиться к Azure Cosmos DB для Gremlin на других языках программирования без использования соединителя служб. На этой странице также отображаются имена и значения переменных среды по умолчанию, которые вы получаете при создании подключения к службе.

Поддерживаемые службы вычислений

Соединитель служб можно использовать для подключения следующих вычислительных служб к Azure Cosmos DB для Apache Gremlin:

Служба приложений Azure
Приложения-контейнеры Azure
Функции Azure
Служба Azure Kubernetes (AKS)
Azure Spring Apps

Поддерживаемые типы проверки подлинности и типы клиентов

В таблице ниже показано, какие сочетания типов клиентов и методов проверки подлинности поддерживаются для подключения вычислительной службы к Azure Cosmos DB для Apache Gremlin с помощью соединителя службы. Значение "Да" указывает, что сочетание поддерживается, а значение "Нет" указывает, что оно не поддерживается.

Тип клиента	Управляемое удостоверение, назначаемое системой	Управляемое удостоверение, назначаемое пользователем	Секрет / строка подключения	Субъект-служба
.NET	Да	Да	Да	Да
Java	Да	Да	Да	Да
Node.js	Да	Да	Да	Да
PHP	Да	Да	Да	Да
Python	Да	Да	Да	Да
Go	Да	Да	Да	Да
Не допускается	Да	Да	Да	Да

Эта таблица указывает, что поддерживаются все сочетания типов клиентов и методов проверки подлинности в таблице. Все типы клиентов могут использовать любой из методов проверки подлинности для подключения к Azure Cosmos DB для Apache Gremlin с помощью соединителя службы.

Имена переменных среды по умолчанию или свойства приложения и пример кода

Используйте приведенные ниже сведения о подключении для подключения вычислительных служб к Azure Cosmos DB для Apache Gremlin. В каждом примере ниже замените текст <Azure-Cosmos-DB-account>заполнителя , <collection or graphs><database>, <username><password><resource-group-name>, <client-ID><subscription-ID><client-secret>а также <tenant-id> собственные сведения. Дополнительные сведения о соглашениях об именовании см. во внутренней статье соединителя служб.

Управляемое удостоверение, назначаемое системой

Имя переменной среды по умолчанию	Description	Пример значения
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	Порт подключения	443
AZURE_COSMOS_USERNAME	Имя пользователя	`/dbs/<database>/colls/<collection or graphs>`

Пример кода

Ознакомьтесь с инструкциями и кодом ниже, чтобы подключиться к Azure Cosmos DB для Gremlin с помощью управляемого удостоверения, назначаемого системой.

Установите зависимости.

dotnet add package Gremlin.Net
dotnet add package Azure.Identity

Получите маркер доступа для управляемого удостоверения или субъекта-службы с помощью клиентской библиотеки Azure.Identity. Используйте маркер доступа и AZURE_COSMOS_LISTKEYURL получите пароль. Получите сведения о подключении из переменных среды, добавленных соединителем службы, и подключитесь к Azure Cosmos DB для Apache Gremlin. При использовании приведенного ниже кода раскомментируйте часть фрагмента кода для используемого типа проверки подлинности.

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 corresponding to the authentication type you want to use.
// 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()
);

Добавьте следующие зависимости в файл pom.xml :

<dependency>
  <groupId>org.apache.tinkerpop</groupId>
  <artifactId>gremlin-driver</artifactId>
  <version>3.4.13</version>
</dependency>
<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-identity</artifactId>
    <version>1.1.5</version>
</dependency>

Получение маркера доступа для управляемого удостоверения или субъекта-службы с помощью azure-identity. Используйте маркер доступа и AZURE_COSMOS_LISTKEYURL получите пароль. Получите сведения о подключении из переменных среды, добавленных соединителем службы, и подключитесь к Azure Cosmos DB для Apache Gremlin. При использовании приведенного ниже кода раскомментируйте часть фрагмента кода для используемого типа проверки подлинности.

import org.apache.tinkerpop.gremlin.driver.Client;
import org.apache.tinkerpop.gremlin.driver.Cluster;
import javax.net.ssl.*;
import java.net.InetSocketAddress;
import com.azure.identity.*;
import com.azure.core.credentital.*;
import java.net.http.*;
import java.net.URI;

int gremlinPort = Integer.parseInt(System.getenv("AZURE_COSMOS_PORT"));
String username = System.getenv("AZURE_COSMOS_USERNAME");
String gremlinEndpoint = System.getenv("AZURE_COSMOS_RESOURCEENDPOINT");
String listKeyUrl = System.getenv("AZURE_COSMOS_LISTKEYURL");
String scope = System.getenv("AZURE_COSMOS_SCOPE");

// Uncomment the following lines corresponding to the authentication type you want to use.
// For system managed identity.
// DefaultAzureCredential defaultCredential = new DefaultAzureCredentialBuilder().build();

// For user assigned managed identity.
// DefaultAzureCredential defaultCredential = new DefaultAzureCredentialBuilder()
//     .managedIdentityClientId(System.getenv("AZURE_COSMOS_CLIENTID"))
//     .build();

// For service principal.
// ClientSecretCredential defaultCredential = new ClientSecretCredentialBuilder()
//   .clientId(System.getenv("AZURE_COSMOS_CLIENTID"))
//   .clientSecret(System.getenv("AZURE_COSMOS_CLIENTSECRET"))
//   .tenantId(System.getenv("AZURE_COSMOS_TENANTID"))
//   .build();

// Get the access token.
AccessToken accessToken = defaultCredential.getToken(new TokenRequestContext().addScopes(new String[]{ scope })).block();
String token = accessToken.getToken();

// Get the password.
HttpClient client = HttpClient.newBuilder().build();
HttpRequest request = HttpRequest.newBuilder()
    .uri(new URI(listKeyUrl))
    .header("Authorization", "Bearer " + token)
    .POST()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
JSONParser parser = new JSONParser();
JSONObject responseBody = parser.parse(response.body());
String gremlinPassword = responseBody.get("primaryMasterKey");

// Connect to Azure Cosmos DB for Apache Gremlin
Cluster cluster;
Client client;

cluster = Cluster.addContactPoint(gremlinEndpoint).port(gremlinPort).credentials(username, password).create();

Установите зависимости.
```
pip install gremlinpython
```

Используется azure-identity для проверки подлинности с помощью управляемого удостоверения или субъекта-службы и отправки запроса на AZURE_COSMOS_LISTKEYURL получение пароля. Получите сведения о подключении из переменных среды, добавленных соединителем службы, и подключитесь к Azure Cosmos DB для Apache Gremlin. При использовании приведенного ниже кода раскомментируйте часть фрагмента кода для используемого типа проверки подлинности.

from gremlin_python.driver import client, serializer
import requests
from azure.identity import ManagedIdentityCredential, ClientSecretCredential

username = os.getenv('AZURE_COSMOS_USERNAME')
endpoint = os.getenv('AZURE_COSMOS_RESOURCEENDPOINT')
port = os.getenv('AZURE_COSMOS_PORT')
listKeyUrl = os.getenv('AZURE_COSMOS_LISTKEYURL')
scope = os.getenv('AZURE_COSMOS_SCOPE')

# Uncomment the following lines corresponding to the authentication type you want to use.
# For system-assigned managed identity
# cred = ManagedIdentityCredential()

# For user-assigned managed identity
# managed_identity_client_id = os.getenv('AZURE_COSMOS_CLIENTID')
# cred = ManagedIdentityCredential(client_id=managed_identity_client_id)

# For 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)

# Get the password 
session = requests.Session()
token = cred.get_token(scope)
response = session.post(listKeyUrl, headers={"Authorization": "Bearer {}".format(token.token)})
keys_dict = response.json()
password = keys_dict['primaryMasterKey']

# Connect to Azure Cosmos DB for Apache Gremlin.
client = client.Client(
    url=endpoint,
    traversal_source="g",
    username=username,
    password=password,
    message_serializer=serializer.GraphSONSerializersV2d0(),
)

Установите зависимости.

go get github.com/Azure/azure-sdk-for-go/sdk/azidentity
go get github.com/go-gremlin/gremlin

В коде получите маркер доступа с помощью azidentity, а затем используйте его для получения пароля. Получите сведения о подключении из переменной среды, добавленной соединителем службы, и подключитесь к Azure Cosmos DB для Apache Gremlin. При использовании приведенного ниже кода раскомментируйте часть фрагмента кода для используемого типа проверки подлинности.

import (
    "fmt"
    "os"
    "context"
    "log"
    "io/ioutil"
    "encoding/json"

    "github.com/go-gremlin/gremlin"
    "github.com/Azure/azure-sdk-for-go/sdk/azidentity"
)

func main() {
    username = os.Getenv("AZURE_COSMOS_USERNAME")
    endpoint = os.getenv("AZURE_COSMOS_RESOURCEENDPOINT")
    port = os.getenv("AZURE_COSMOS_PORT")
    listKeyUrl = os.Getenv("AZURE_COSMOS_LISTKEYURL")
    scope = os.Getenv("AZUE_COSMOS_SCOPE")

    // 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{})

    // Acquire the access token.
    ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
    token, err := cred.GetToken(ctx, policy.TokenRequestOptions{
        Scopes: []string{scope},
    })

    // Acquire the connection string.
    client := &http.Client{}
    req, err := http.NewRequest("POST", listKeyUrl, nil)
    req.Header.Add("Authorization", "Bearer " + token.Token)
    resp, err := client.Do(req)
    body, err := ioutil.ReadAll(resp.Body)
    var result map[string]interface{}
    json.Unmarshal(body, &result)
    password, err := result["primaryMasterKey"];

    auth := gremlin.OptAuthUserPass(username, password)
     client, err := gremlin.NewClient(endpoint, auth)
}

Установите зависимости.

npm install gremlin
npm install --save @azure/identity

В коде получите маркер доступа с помощью @azure/identity, а затем используйте его для получения пароля. Получите сведения о подключении из переменной среды, добавленной соединителем службы, и подключитесь к Azure Cosmos DB для Apache Gremlin. При использовании приведенного ниже кода раскомментируйте часть фрагмента кода для используемого типа проверки подлинности.

import { DefaultAzureCredential,ClientSecretCredential } from "@azure/identity";
import gremlin from 'gremlin'
const axios = require('axios');

let username = process.env.AZURE_COSMOS_USERNAME;
let endoint = process.env.AZURE_COSMOS_RESOURCEENDPOINT;
let port = process.env.AZURE_COSMOS_PORT;
let listKeyUrl = process.env.AZURE_COSMOS_LISTKEYURL;
let scope = process.env.AZURE_COSMOS_SCOPE;

// Uncomment the following lines corresponding to the authentication type you want to use.  
// For system-assigned identity.
// const credential = new DefaultAzureCredential();

// For user-assigned identity.
// const clientId = process.env.AZURE_COSMOS_CLIENTID;
// const credential = new DefaultAzureCredential({
//     managedIdentityClientId: clientId
// });

// For service principal.
// const tenantId = process.env.AZURE_COSMOS_TENANTID;
// const clientId = process.env.AZURE_COSMOS_CLIENTID;
// const clientSecret = process.env.AZURE_COSMOS_CLIENTSECRET;

// Acquire the access token.
var accessToken = await credential.getToken(scope);

// Get the password.
const config = {
    method: 'post',
    url: listKeyUrl,
    headers: { 
      'Authorization': `Bearer ${accessToken.token}`
    }
};
const response = await axios(config);
const keysDict = response.data;
const password = keysDict['primaryMasterKey'];

const credentials = new gremlin.driver.auth.PlainTextSaslAuthenticator(
  username,
  password
)

const client = new gremlin.driver.Client(
  endpoint,
  {
    credentials,
    traversalsource: 'g',
    rejectUnauthorized: true,
    mimeType: 'application/vnd.gremlin-v2.0+json'
  }
)

client.open()

Получите маркер доступа с управляемым удостоверением или субъектом-службой, чтобы получить первичный ключ Azure Cosmos DB для Gremlin путем вызова REST API по адресу AZURE_COSMOS_LISTKEYURL.

$endpoint = getenv('AZURE_COSMOS_RESOURCEENDPOINT');
$username = getenv('AZURE_COSMOS_USERNAME');
$port = getenv('AZURE_COSMOS_PORT');

$db = new Connection([
    'host' => $endpoint,
    'username' => $username,
    'password' => $password,
    'port' => $port,
    'ssl' => TRUE
]);

Управляемое удостоверение, назначаемое пользователем

Имя переменной среды по умолчанию	Description	Пример значения
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	Порт подключения	443
AZURE_COSMOS_USERNAME	Имя пользователя	`/dbs/<database>/colls/<collection or graphs>`
AZURE_CLIENTID	Идентификатор клиента	`<client_ID>`

Пример кода

Ознакомьтесь с инструкциями и кодом ниже, чтобы подключиться к Azure Cosmos DB для Gremlin с помощью управляемого удостоверения, назначаемого пользователем.

Установите зависимости.

dotnet add package Gremlin.Net
dotnet add package Azure.Identity

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 corresponding to the authentication type you want to use.
// 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()
);

Добавьте следующие зависимости в файл pom.xml :

<dependency>
  <groupId>org.apache.tinkerpop</groupId>
  <artifactId>gremlin-driver</artifactId>
  <version>3.4.13</version>
</dependency>
<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-identity</artifactId>
    <version>1.1.5</version>
</dependency>

import org.apache.tinkerpop.gremlin.driver.Client;
import org.apache.tinkerpop.gremlin.driver.Cluster;
import javax.net.ssl.*;
import java.net.InetSocketAddress;
import com.azure.identity.*;
import com.azure.core.credentital.*;
import java.net.http.*;
import java.net.URI;

int gremlinPort = Integer.parseInt(System.getenv("AZURE_COSMOS_PORT"));
String username = System.getenv("AZURE_COSMOS_USERNAME");
String gremlinEndpoint = System.getenv("AZURE_COSMOS_RESOURCEENDPOINT");
String listKeyUrl = System.getenv("AZURE_COSMOS_LISTKEYURL");
String scope = System.getenv("AZURE_COSMOS_SCOPE");

// Uncomment the following lines corresponding to the authentication type you want to use.
// For system managed identity.
// DefaultAzureCredential defaultCredential = new DefaultAzureCredentialBuilder().build();

// For user assigned managed identity.
// DefaultAzureCredential defaultCredential = new DefaultAzureCredentialBuilder()
//     .managedIdentityClientId(System.getenv("AZURE_COSMOS_CLIENTID"))
//     .build();

// For service principal.
// ClientSecretCredential defaultCredential = new ClientSecretCredentialBuilder()
//   .clientId(System.getenv("AZURE_COSMOS_CLIENTID"))
//   .clientSecret(System.getenv("AZURE_COSMOS_CLIENTSECRET"))
//   .tenantId(System.getenv("AZURE_COSMOS_TENANTID"))
//   .build();

// Get the access token.
AccessToken accessToken = defaultCredential.getToken(new TokenRequestContext().addScopes(new String[]{ scope })).block();
String token = accessToken.getToken();

// Get the password.
HttpClient client = HttpClient.newBuilder().build();
HttpRequest request = HttpRequest.newBuilder()
    .uri(new URI(listKeyUrl))
    .header("Authorization", "Bearer " + token)
    .POST()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
JSONParser parser = new JSONParser();
JSONObject responseBody = parser.parse(response.body());
String gremlinPassword = responseBody.get("primaryMasterKey");

// Connect to Azure Cosmos DB for Apache Gremlin
Cluster cluster;
Client client;

cluster = Cluster.addContactPoint(gremlinEndpoint).port(gremlinPort).credentials(username, password).create();

Установите зависимости.
```
pip install gremlinpython
```

from gremlin_python.driver import client, serializer
import requests
from azure.identity import ManagedIdentityCredential, ClientSecretCredential

username = os.getenv('AZURE_COSMOS_USERNAME')
endpoint = os.getenv('AZURE_COSMOS_RESOURCEENDPOINT')
port = os.getenv('AZURE_COSMOS_PORT')
listKeyUrl = os.getenv('AZURE_COSMOS_LISTKEYURL')
scope = os.getenv('AZURE_COSMOS_SCOPE')

# Uncomment the following lines corresponding to the authentication type you want to use.
# For system-assigned managed identity
# cred = ManagedIdentityCredential()

# For user-assigned managed identity
# managed_identity_client_id = os.getenv('AZURE_COSMOS_CLIENTID')
# cred = ManagedIdentityCredential(client_id=managed_identity_client_id)

# For 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)

# Get the password 
session = requests.Session()
token = cred.get_token(scope)
response = session.post(listKeyUrl, headers={"Authorization": "Bearer {}".format(token.token)})
keys_dict = response.json()
password = keys_dict['primaryMasterKey']

# Connect to Azure Cosmos DB for Apache Gremlin.
client = client.Client(
    url=endpoint,
    traversal_source="g",
    username=username,
    password=password,
    message_serializer=serializer.GraphSONSerializersV2d0(),
)

Установите зависимости.

go get github.com/Azure/azure-sdk-for-go/sdk/azidentity
go get github.com/go-gremlin/gremlin

import (
    "fmt"
    "os"
    "context"
    "log"
    "io/ioutil"
    "encoding/json"

    "github.com/go-gremlin/gremlin"
    "github.com/Azure/azure-sdk-for-go/sdk/azidentity"
)

func main() {
    username = os.Getenv("AZURE_COSMOS_USERNAME")
    endpoint = os.getenv("AZURE_COSMOS_RESOURCEENDPOINT")
    port = os.getenv("AZURE_COSMOS_PORT")
    listKeyUrl = os.Getenv("AZURE_COSMOS_LISTKEYURL")
    scope = os.Getenv("AZUE_COSMOS_SCOPE")

    // 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{})

    // Acquire the access token.
    ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
    token, err := cred.GetToken(ctx, policy.TokenRequestOptions{
        Scopes: []string{scope},
    })

    // Acquire the connection string.
    client := &http.Client{}
    req, err := http.NewRequest("POST", listKeyUrl, nil)
    req.Header.Add("Authorization", "Bearer " + token.Token)
    resp, err := client.Do(req)
    body, err := ioutil.ReadAll(resp.Body)
    var result map[string]interface{}
    json.Unmarshal(body, &result)
    password, err := result["primaryMasterKey"];

    auth := gremlin.OptAuthUserPass(username, password)
     client, err := gremlin.NewClient(endpoint, auth)
}

Установите зависимости.

npm install gremlin
npm install --save @azure/identity

import { DefaultAzureCredential,ClientSecretCredential } from "@azure/identity";
import gremlin from 'gremlin'
const axios = require('axios');

let username = process.env.AZURE_COSMOS_USERNAME;
let endoint = process.env.AZURE_COSMOS_RESOURCEENDPOINT;
let port = process.env.AZURE_COSMOS_PORT;
let listKeyUrl = process.env.AZURE_COSMOS_LISTKEYURL;
let scope = process.env.AZURE_COSMOS_SCOPE;

// Uncomment the following lines corresponding to the authentication type you want to use.  
// For system-assigned identity.
// const credential = new DefaultAzureCredential();

// For user-assigned identity.
// const clientId = process.env.AZURE_COSMOS_CLIENTID;
// const credential = new DefaultAzureCredential({
//     managedIdentityClientId: clientId
// });

// For service principal.
// const tenantId = process.env.AZURE_COSMOS_TENANTID;
// const clientId = process.env.AZURE_COSMOS_CLIENTID;
// const clientSecret = process.env.AZURE_COSMOS_CLIENTSECRET;

// Acquire the access token.
var accessToken = await credential.getToken(scope);

// Get the password.
const config = {
    method: 'post',
    url: listKeyUrl,
    headers: { 
      'Authorization': `Bearer ${accessToken.token}`
    }
};
const response = await axios(config);
const keysDict = response.data;
const password = keysDict['primaryMasterKey'];

const credentials = new gremlin.driver.auth.PlainTextSaslAuthenticator(
  username,
  password
)

const client = new gremlin.driver.Client(
  endpoint,
  {
    credentials,
    traversalsource: 'g',
    rejectUnauthorized: true,
    mimeType: 'application/vnd.gremlin-v2.0+json'
  }
)

client.open()

$endpoint = getenv('AZURE_COSMOS_RESOURCEENDPOINT');
$username = getenv('AZURE_COSMOS_USERNAME');
$port = getenv('AZURE_COSMOS_PORT');

$db = new Connection([
    'host' => $endpoint,
    'username' => $username,
    'password' => $password,
    'port' => $port,
    'ssl' => TRUE
]);

Connection string

Предупреждение

Корпорация Майкрософт рекомендует использовать самый безопасный поток проверки подлинности. Поток проверки подлинности, описанный в этой процедуре, требует очень высокого уровня доверия к приложению и несет риски, которые отсутствуют в других потоках. Этот поток следует использовать только в том случае, если другие более безопасные потоки, такие как управляемые удостоверения, не являются жизнеспособными.

Имя переменной среды по умолчанию	Description	Пример значения
AZURE_COSMOS_HOSTNAME	Уникальный идентификатор ресурса Gremlin (UFI)	`<Azure-Cosmos-DB-account>.gremlin.cosmos.azure.com`
AZURE_COSMOS_PORT	Порт подключения	443
AZURE_COSMOS_USERNAME	Имя пользователя	`/dbs/<database>/colls/<collection or graphs>`
AZURE_COSMOS_PASSWORD	Ваш пароль	`<password>`

Пример кода

Ознакомьтесь с инструкциями и кодом ниже, чтобы подключиться к Azure Cosmos DB для Gremlin с помощью строка подключения.

Установите зависимость.
```
dotnet add package Gremlin.Net
```

Получите сведения о подключении из переменных среды, добавленных соединителем службы, и подключитесь к Azure Cosmos DB для Apache Gremlin.

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

Добавьте в файл pom.xml следующую зависимость:

<dependency>
  <groupId>org.apache.tinkerpop</groupId>
  <artifactId>gremlin-driver</artifactId>
  <version>3.4.13</version>
</dependency>

import org.apache.tinkerpop.gremlin.driver.Client;
import org.apache.tinkerpop.gremlin.driver.Cluster;
import javax.net.ssl.*;
import java.net.InetSocketAddress;

int gremlinPort = Integer.parseInt(System.getenv("AZURE_COSMOS_PORT"));
String username = System.getenv("AZURE_COSMOS_USERNAME");
String gremlinEndpoint = System.getenv("AZURE_COSMOS_RESOURCEENDPOINT");
String password = System.getenv("AZURE_COSMOS_PASSWORD");

Cluster cluster;
Client client;

cluster = Cluster.addContactPoint(gremlinEndpoint).port(gremlinPort).credentials(username, password).create();

Установите зависимость.
```
pip install gremlinpython
```

import os
from gremlin_python.driver import client, serializer

username = os.getenv('AZURE_COSMOS_USERNAME')
password = os.getenv('AZURE_COSMOS_PASSWORD')
endpoint = os.getenv('AZURE_COSMOS_RESOURCEENDPOINT')
port = os.getenv('AZURE_COSMOS_PORT')

client = client.Client(
    url=endpoint,
    traversal_source="g",
    username=username,
    password=password,
    message_serializer=serializer.GraphSONSerializersV2d0(),
)

Установите зависимость.
```
go get github.com/go-gremlin/gremlin
```

username = os.Getenv("AZURE_COSMOS_USERNAME")
password = os.getenv("AZURE_COSMOS_PASSWORD")
endpoint = os.getenv("AZURE_COSMOS_RESOURCEENDPOINT")
port = os.getenv("AZURE_COSMOS_PORT")

auth := gremlin.OptAuthUserPass(username, password)
 client, err := gremlin.NewClient(endpoint, auth)

Установите зависимость.
```
npm install gremlin
```

import gremlin from 'gremlin'

const username = process.env.AZURE_COSMOS_USERNAME;
const password = process.env.AZURE_COSMOS_PASSWORD;
const endpoint = process.env.AZURE_COSMOS_RESOURCEENDPOINT;
const port = process.env.AZURE_COSMOS_PORT;

const credentials = new gremlin.driver.auth.PlainTextSaslAuthenticator(
   username,
   password
 )

const client = new gremlin.driver.Client(
   endpoint,
   {
     credentials,
     traversalsource: 'g',
     rejectUnauthorized: true,
     mimeType: 'application/vnd.gremlin-v2.0+json'
   }
 )

 client.open()

$endpoint = getenv('AZURE_COSMOS_RESOURCEENDPOINT');
$username = getenv('AZURE_COSMOS_USERNAME');
$password = getenv('AZURE_COSMOS_PASSWORD');
$port = getenv('AZURE_COSMOS_PORT');

$db = new Connection([
    'host' => $endpoint,
    'username' => $username,
    'password' => $password,
    'port' => $port,
    'ssl' => TRUE
]);

Субъект-служба

Имя переменной среды по умолчанию	Description	Пример значения
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>`

Пример кода

Ознакомьтесь с инструкциями и кодом ниже, чтобы подключиться к Azure Cosmos DB для Gremlin с помощью субъекта-службы.

Установите зависимости.

dotnet add package Gremlin.Net
dotnet add package Azure.Identity

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 corresponding to the authentication type you want to use.
// 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()
);

Добавьте следующие зависимости в файл pom.xml :

<dependency>
  <groupId>org.apache.tinkerpop</groupId>
  <artifactId>gremlin-driver</artifactId>
  <version>3.4.13</version>
</dependency>
<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-identity</artifactId>
    <version>1.1.5</version>
</dependency>

import org.apache.tinkerpop.gremlin.driver.Client;
import org.apache.tinkerpop.gremlin.driver.Cluster;
import javax.net.ssl.*;
import java.net.InetSocketAddress;
import com.azure.identity.*;
import com.azure.core.credentital.*;
import java.net.http.*;
import java.net.URI;

int gremlinPort = Integer.parseInt(System.getenv("AZURE_COSMOS_PORT"));
String username = System.getenv("AZURE_COSMOS_USERNAME");
String gremlinEndpoint = System.getenv("AZURE_COSMOS_RESOURCEENDPOINT");
String listKeyUrl = System.getenv("AZURE_COSMOS_LISTKEYURL");
String scope = System.getenv("AZURE_COSMOS_SCOPE");

// Uncomment the following lines corresponding to the authentication type you want to use.
// For system managed identity.
// DefaultAzureCredential defaultCredential = new DefaultAzureCredentialBuilder().build();

// For user assigned managed identity.
// DefaultAzureCredential defaultCredential = new DefaultAzureCredentialBuilder()
//     .managedIdentityClientId(System.getenv("AZURE_COSMOS_CLIENTID"))
//     .build();

// For service principal.
// ClientSecretCredential defaultCredential = new ClientSecretCredentialBuilder()
//   .clientId(System.getenv("AZURE_COSMOS_CLIENTID"))
//   .clientSecret(System.getenv("AZURE_COSMOS_CLIENTSECRET"))
//   .tenantId(System.getenv("AZURE_COSMOS_TENANTID"))
//   .build();

// Get the access token.
AccessToken accessToken = defaultCredential.getToken(new TokenRequestContext().addScopes(new String[]{ scope })).block();
String token = accessToken.getToken();

// Get the password.
HttpClient client = HttpClient.newBuilder().build();
HttpRequest request = HttpRequest.newBuilder()
    .uri(new URI(listKeyUrl))
    .header("Authorization", "Bearer " + token)
    .POST()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
JSONParser parser = new JSONParser();
JSONObject responseBody = parser.parse(response.body());
String gremlinPassword = responseBody.get("primaryMasterKey");

// Connect to Azure Cosmos DB for Apache Gremlin
Cluster cluster;
Client client;

cluster = Cluster.addContactPoint(gremlinEndpoint).port(gremlinPort).credentials(username, password).create();

Установите зависимости.
```
pip install gremlinpython
```

from gremlin_python.driver import client, serializer
import requests
from azure.identity import ManagedIdentityCredential, ClientSecretCredential

username = os.getenv('AZURE_COSMOS_USERNAME')
endpoint = os.getenv('AZURE_COSMOS_RESOURCEENDPOINT')
port = os.getenv('AZURE_COSMOS_PORT')
listKeyUrl = os.getenv('AZURE_COSMOS_LISTKEYURL')
scope = os.getenv('AZURE_COSMOS_SCOPE')

# Uncomment the following lines corresponding to the authentication type you want to use.
# For system-assigned managed identity
# cred = ManagedIdentityCredential()

# For user-assigned managed identity
# managed_identity_client_id = os.getenv('AZURE_COSMOS_CLIENTID')
# cred = ManagedIdentityCredential(client_id=managed_identity_client_id)

# For 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)

# Get the password 
session = requests.Session()
token = cred.get_token(scope)
response = session.post(listKeyUrl, headers={"Authorization": "Bearer {}".format(token.token)})
keys_dict = response.json()
password = keys_dict['primaryMasterKey']

# Connect to Azure Cosmos DB for Apache Gremlin.
client = client.Client(
    url=endpoint,
    traversal_source="g",
    username=username,
    password=password,
    message_serializer=serializer.GraphSONSerializersV2d0(),
)

Установите зависимости.

go get github.com/Azure/azure-sdk-for-go/sdk/azidentity
go get github.com/go-gremlin/gremlin

import (
    "fmt"
    "os"
    "context"
    "log"
    "io/ioutil"
    "encoding/json"

    "github.com/go-gremlin/gremlin"
    "github.com/Azure/azure-sdk-for-go/sdk/azidentity"
)

func main() {
    username = os.Getenv("AZURE_COSMOS_USERNAME")
    endpoint = os.getenv("AZURE_COSMOS_RESOURCEENDPOINT")
    port = os.getenv("AZURE_COSMOS_PORT")
    listKeyUrl = os.Getenv("AZURE_COSMOS_LISTKEYURL")
    scope = os.Getenv("AZUE_COSMOS_SCOPE")

    // 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{})

    // Acquire the access token.
    ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
    token, err := cred.GetToken(ctx, policy.TokenRequestOptions{
        Scopes: []string{scope},
    })

    // Acquire the connection string.
    client := &http.Client{}
    req, err := http.NewRequest("POST", listKeyUrl, nil)
    req.Header.Add("Authorization", "Bearer " + token.Token)
    resp, err := client.Do(req)
    body, err := ioutil.ReadAll(resp.Body)
    var result map[string]interface{}
    json.Unmarshal(body, &result)
    password, err := result["primaryMasterKey"];

    auth := gremlin.OptAuthUserPass(username, password)
     client, err := gremlin.NewClient(endpoint, auth)
}

Установите зависимости.

npm install gremlin
npm install --save @azure/identity

import { DefaultAzureCredential,ClientSecretCredential } from "@azure/identity";
import gremlin from 'gremlin'
const axios = require('axios');

let username = process.env.AZURE_COSMOS_USERNAME;
let endoint = process.env.AZURE_COSMOS_RESOURCEENDPOINT;
let port = process.env.AZURE_COSMOS_PORT;
let listKeyUrl = process.env.AZURE_COSMOS_LISTKEYURL;
let scope = process.env.AZURE_COSMOS_SCOPE;

// Uncomment the following lines corresponding to the authentication type you want to use.  
// For system-assigned identity.
// const credential = new DefaultAzureCredential();

// For user-assigned identity.
// const clientId = process.env.AZURE_COSMOS_CLIENTID;
// const credential = new DefaultAzureCredential({
//     managedIdentityClientId: clientId
// });

// For service principal.
// const tenantId = process.env.AZURE_COSMOS_TENANTID;
// const clientId = process.env.AZURE_COSMOS_CLIENTID;
// const clientSecret = process.env.AZURE_COSMOS_CLIENTSECRET;

// Acquire the access token.
var accessToken = await credential.getToken(scope);

// Get the password.
const config = {
    method: 'post',
    url: listKeyUrl,
    headers: { 
      'Authorization': `Bearer ${accessToken.token}`
    }
};
const response = await axios(config);
const keysDict = response.data;
const password = keysDict['primaryMasterKey'];

const credentials = new gremlin.driver.auth.PlainTextSaslAuthenticator(
  username,
  password
)

const client = new gremlin.driver.Client(
  endpoint,
  {
    credentials,
    traversalsource: 'g',
    rejectUnauthorized: true,
    mimeType: 'application/vnd.gremlin-v2.0+json'
  }
)

client.open()

$endpoint = getenv('AZURE_COSMOS_RESOURCEENDPOINT');
$username = getenv('AZURE_COSMOS_USERNAME');
$port = getenv('AZURE_COSMOS_PORT');

$db = new Connection([
    'host' => $endpoint,
    'username' => $username,
    'password' => $password,
    'port' => $port,
    'ssl' => TRUE
]);

Следующие шаги

Дополнительные сведения о соединителе служб см. в приведенных ниже учебниках.

относительно соединителя служб

Поделиться через

Интеграция Azure Cosmos DB для Gremlin с соединителем службы

Поддерживаемые службы вычислений

Поддерживаемые типы проверки подлинности и типы клиентов

Имена переменных среды по умолчанию или свойства приложения и пример кода

Управляемое удостоверение, назначаемое системой

Пример кода

Управляемое удостоверение, назначаемое пользователем

Пример кода

Connection string

Пример кода

Субъект-служба

Пример кода

Следующие шаги

Обратная связь

Дополнительные ресурсы