Azure Cosmos DB for NoSQL と Service Connector を統合する

[アーティクル]
02/06/2024

このページでは、サポートされている認証方法とクライアントを示し、Service Connector を使用して Azure Cosmos DB for NoSQL を他のクラウドサービスに接続するために使用できるサンプルコードを示します。 Service Connector を使用しなくても、他のプログラミング言語で Azure Cosmos DB for NoSQL に接続できる場合があります。このページには、サービス接続を作成するときに取得する既定の環境変数の名前と値 (つまり、Spring Boot 構成) も示されています。

サポートされているコンピューティングサービス

Service Connector を使用すると、次のコンピューティングサービスを Azure Cosmos DB for NoSQL に接続できます。

Azure App Service
Azure Container Apps
Azure Functions
Azure Kubernetes Service (AKS)
Azure Spring Apps

サポートされている認証の種類とクライアントの種類

次の表は、Service Connector を使った Azure Cosmos DB for NoSQL へのコンピューティングサービスの接続でサポートされているクライアントの種類と認証方法の組み合わせを示したものです。 "はい" はその組み合わせがサポートされていることを示し、"いいえ" はサポートされていないことを示します。

クライアントタイプ	システム割り当てマネージド ID	ユーザー割り当てマネージド ID	シークレット/接続文字列	サービスプリンシパル
.NET	はい	イエス	イエス	はい
Java	はい	イエス	イエス	はい
Java - Spring Boot	はい	イエス	イエス	はい
Node.js	はい	イエス	イエス	はい
Python	はい	イエス	イエス	はい
Go	はい	イエス	イエス	はい
なし	有効	イエス	イエス	はい

この表は、表内のクライアントの種類と認証方法のすべての組み合わせがサポートされていることを示しています。すべてのクライアントの種類では、Service Connector を使って Azure Cosmos DB for NoSQL に接続するために、任意の認証方法を使用できます。

デフォルトの環境変数名またはアプリケーションプロパティとサンプルコード

以下の接続の詳細を使用して、コンピューティングサービスを Azure Cosmos DB for NoSQL に接続します。以下の各例では、プレースホルダーのテキスト <database-server>、<database-name>、<account-key>、<resource-group-name>、<subscription-ID>、<client-ID>、<SQL-server>、<client-secret>、<tenant-id>、および<access-key> を実際の情報に置き換えます。名前付け規則の詳細については、Service Connector の内部の記事を参照してください。

システム割り当てマネージド ID

SpringBoot クライアントの種類

認証の種類としてシステム割り当てマネージド ID を使用することは、Spring Cloud Azure バージョン 4.0 以降でのみ使用できます。

既定の環境変数名	説明	例値
spring.cloud.azure.cosmos.credential.managed-identity-enabled	マネージド ID を有効にするかどうか	`true`
spring.cloud.azure.cosmos.database	データベース	`https://management.azure.com/.default`
spring.cloud.azure.cosmos.endpoint	リソースエンドポイント	`https://<database-server>.documents.azure.com:443/`

その他のクライアントの種類

既定の環境変数名	説明	例値
AZURE_COSMOS_LISTCONNECTIONSTRINGURL	接続文字列を取得するための URL	`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	マネージド ID の範囲	`https://management.azure.com/.default`
AZURE_COSMOS_RESOURCEENDPOINT	リソースエンドポイント	`https://<database-server>.documents.azure.com:443/`

サンプルコード

システム割り当て ID を使用して、Azure Cosmos DB for NoSQL に接続するには、次の手順とコードを参照してください。

依存関係をインストールします。

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

Azure.Identity NuGet パッケージを使用して認証し、Service Connector によって追加された環境変数からエンドポイント URL を取得します。次のコードを使用する場合は、使用する認証型のコードスニペットの一部をコメント解除します。

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

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>

azure-identity を使用して認証し、Service Connector によって追加された環境変数からエンドポイント URL を取得します。次のコードを使用する場合は、使用する認証型のコードスニペットの一部をコメント解除します。

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

依存関係をインストールします。

pip install azure-identity
pip install azure-cosmos

azure-identity ライブラリを使用して認証し、Service Connector によって追加された環境変数からエンドポイント URL を取得します。次のコードを使用する場合は、使用する認証型のコードスニペットの一部をコメント解除します。

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 get t github.com/Azure/azure-sdk-for-go/sdk/azidentity
go get github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos

azidentity npm パッケージを使用して認証し、Service Connector によって追加された環境変数からエンドポイント URL を取得します。次のコードを使用する場合は、使用する認証型のコードスニペットの一部をコメント解除します。

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

依存関係をインストールします。

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

@azure/identity npm パッケージを使用して認証し、Service Connector によって追加された環境変数からエンドポイント URL を取得します。次のコードを使用する場合は、使用する認証型のコードスニペットの一部をコメント解除します。

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

ユーザー割り当てマネージド ID

SpringBoot クライアントの種類

認証の種類としてユーザー割り当てマネージド ID を使用することは、Spring Cloud Azure バージョン 4.0 以降でのみ使用できます。

既定の環境変数名	説明	例値
spring.cloud.azure.cosmos.credential.managed-identity-enabled	マネージド ID を有効にするかどうか	`true`
spring.cloud.azure.cosmos.database	データベース	`https://management.azure.com/.default`
spring.cloud.azure.cosmos.endpoint	リソースエンドポイント	`https://<database-server>.documents.azure.com:443/`
spring.cloud.azure.cosmos.credential.client-id	クライアント ID	`<client-ID>`

その他のクライアントの種類

既定の環境変数名	説明	例値
AZURE_COSMOS_LISTCONNECTIONSTRINGURL	接続文字列を取得するための URL	`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	マネージド ID の範囲	`https://management.azure.com/.default`
AZURE_COSMOS_CLIENTID	クライアント ID	`<client-ID>`
AZURE_COSMOS_RESOURCEENDPOINT	リソースエンドポイント	`https://<database-server>.documents.azure.com:443/`

サンプルコード

ユーザー割り当て ID を使用して、Azure Cosmos DB for NoSQL に接続するには、次の手順とコードを参照してください。

依存関係をインストールします。

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

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

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>

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

依存関係をインストールします。

pip install azure-identity
pip install azure-cosmos

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 get t github.com/Azure/azure-sdk-for-go/sdk/azidentity
go get github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos

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

依存関係をインストールします。

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

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

接続文字列

警告

Microsoft では、使用可能な最も安全な認証フローを使用することをお勧めします。この手順で説明されている認証フローでは、アプリケーションで非常に高い信頼度が要求されるため、他のフローには存在しないリスクが伴います。このフローは、マネージド ID など、より安全なフローが実行可能ではない場合にのみ使用してください。

SpringBoot クライアントの種類

既定の環境変数名	説明	例値
azure.cosmos.key	Spring Cloud Azure バージョン 4.0 より前のデータベースのアクセスキー	`<access-key>`
azure.cosmos.database	4.0 より前の Spring Cloud Azure バージョンのデータベース	`<database-name>`
azure.cosmos.uri	4.0 より前の Spring Cloud Azure バージョンのデータベース URI	`https://<database-server>.documents.azure.com:443/`
spring.cloud.azure.cosmos.key	4.0 を超える Spring Cloud Azure バージョンのデータベースのアクセスキー	`<access-key>`
spring.cloud.azure.cosmos.database	4.0 を超える Spring Cloud Azure バージョンのデータベース	`<database-name>`
spring.cloud.azure.cosmos.endpoint	4.0 を超える Spring Cloud Azure バージョンのデータベース URI	`https://<database-server>.documents.azure.com:443/`

その他のクライアントの種類

既定の環境変数名	説明	例値
AZURE_COSMOS_CONNECTIONSTRING	Azure Cosmos DB for NoSQL の接続文字列	`AccountEndpoint=https://<database-server>.documents.azure.com:443/;AccountKey=<account-key>`