CosmosClient.CreateAndInitializeAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| CreateAndInitializeAsync(String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken) |
アカウント エンドポイント URI 文字列と TokenCredential を使用して、新しい CosmosClient を作成します。 さらに、提供されたコンテナーを使用してクライアントを初期化します。つまり、SDK は、サービスの最初の呼び出しが行われる前にキャッシュと接続をウォームアップします。 これを使用して、アプリケーションの起動時の待機時間を短くします。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
| CreateAndInitializeAsync(String, AzureKeyCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken) |
アカウント エンドポイント URI 文字列と AzureKeyCredential を使用して、新しい CosmosClient を作成します。 AzureKeyCredential を使用すると、CosmosClient がまだ使用されている間に master-key/ResourceToken を変更/更新できます。 さらに、提供されたコンテナーを使用してクライアントを初期化します。つまり、SDK は、サービスの最初の呼び出しが行われる前にキャッシュと接続をウォームアップします。 これを使用して、アプリケーションの起動時の待機時間を短くします。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
| CreateAndInitializeAsync(String, TokenCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken) |
アカウント エンドポイント URI 文字列と TokenCredential を使用して、新しい CosmosClient を作成します。 さらに、提供されたコンテナーを使用してクライアントを初期化します。つまり、SDK は、サービスの最初の呼び出しが行われる前にキャッシュと接続をウォームアップします。 これを使用して、アプリケーションの起動時の待機時間を短くします。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
| CreateAndInitializeAsync(String, String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken) |
アカウント エンドポイント URI 文字列と TokenCredential を使用して、新しい CosmosClient を作成します。 さらに、提供されたコンテナーを使用してクライアントを初期化します。つまり、SDK は、サービスの最初の呼び出しが行われる前にキャッシュと接続をウォームアップします。 これを使用して、アプリケーションの起動時の待機時間を短くします。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
CreateAndInitializeAsync(String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)
アカウント エンドポイント URI 文字列と TokenCredential を使用して、新しい CosmosClient を作成します。 さらに、提供されたコンテナーを使用してクライアントを初期化します。つまり、SDK は、サービスの最初の呼び出しが行われる前にキャッシュと接続をウォームアップします。 これを使用して、アプリケーションの起動時の待機時間を短くします。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。
public static System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient> CreateAndInitializeAsync (string connectionString, System.Collections.Generic.IReadOnlyList<(string databaseId, string containerId)> containers, Microsoft.Azure.Cosmos.CosmosClientOptions cosmosClientOptions = default, System.Threading.CancellationToken cancellationToken = default);static member CreateAndInitializeAsync : string * System.Collections.Generic.IReadOnlyList<ValueTuple<string, string>> * Microsoft.Azure.Cosmos.CosmosClientOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient>Public Shared Function CreateAndInitializeAsync (connectionString As String, containers As IReadOnlyList(Of ValueTuple(Of String, String)), Optional cosmosClientOptions As CosmosClientOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CosmosClient)パラメーター
- connectionString
- String
cosmos アカウントへの接続文字列。 例: AccountEndpoint=https://XXXXX.documents.azure.com:443/;AccountKey=SuperSecretKey;
- containers
- IReadOnlyList<ValueTuple<String,String>>
初期化されるコンテナーは、データベース名とコンテナー名によって識別されます。
- cosmosClientOptions
- CosmosClientOptions
(省略可能) クライアント オプション
- cancellationToken
- CancellationToken
(省略可能)キャンセル トークン
戻り値
CosmosClient オブジェクト。
例
CosmosClient は ConnectionString で作成され、アカウント内の 2 つのコンテナーが初期化されます
using Microsoft.Azure.Cosmos;
List<(string, string)> containersToInitialize = new List<(string, string)>
{ ("DatabaseName1", "ContainerName1"), ("DatabaseName2", "ContainerName2") };
CosmosClient cosmosClient = await CosmosClient.CreateAndInitializeAsync("connection-string-from-portal",
containersToInitialize)
// Dispose cosmosClient at application exit
適用対象
CreateAndInitializeAsync(String, AzureKeyCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)
アカウント エンドポイント URI 文字列と AzureKeyCredential を使用して、新しい CosmosClient を作成します。 AzureKeyCredential を使用すると、CosmosClient がまだ使用されている間に master-key/ResourceToken を変更/更新できます。
さらに、提供されたコンテナーを使用してクライアントを初期化します。つまり、SDK は、サービスの最初の呼び出しが行われる前にキャッシュと接続をウォームアップします。 これを使用して、アプリケーションの起動時の待機時間を短くします。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。
public static System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient> CreateAndInitializeAsync (string accountEndpoint, Azure.AzureKeyCredential authKeyOrResourceTokenCredential, System.Collections.Generic.IReadOnlyList<(string databaseId, string containerId)> containers, Microsoft.Azure.Cosmos.CosmosClientOptions cosmosClientOptions = default, System.Threading.CancellationToken cancellationToken = default);static member CreateAndInitializeAsync : string * Azure.AzureKeyCredential * System.Collections.Generic.IReadOnlyList<ValueTuple<string, string>> * Microsoft.Azure.Cosmos.CosmosClientOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient>Public Shared Function CreateAndInitializeAsync (accountEndpoint As String, authKeyOrResourceTokenCredential As AzureKeyCredential, containers As IReadOnlyList(Of ValueTuple(Of String, String)), Optional cosmosClientOptions As CosmosClientOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CosmosClient)パラメーター
- accountEndpoint
- String
使用する Cosmos サービス エンドポイント
- authKeyOrResourceTokenCredential
- AzureKeyCredential
マスター キーまたはリソース トークンを使用した AzureKeyCredential。
- containers
- IReadOnlyList<ValueTuple<String,String>>
初期化されるコンテナーは、データベース名とコンテナー名によって識別されます。
- cosmosClientOptions
- CosmosClientOptions
(省略可能) クライアント オプション
- cancellationToken
- CancellationToken
(省略可能)キャンセル トークン
戻り値
CosmosClient オブジェクト。
例
CosmosClient は AccountEndpoint、AccountKey、または ResourceToken を使用して作成され、アカウント内の 2 つのコンテナーが初期化されます
using Microsoft.Azure.Cosmos;
List<(string, string)> containersToInitialize = new List<(string, string)>
{ ("DatabaseName1", "ContainerName1"), ("DatabaseName2", "ContainerName2") };
AzureKeyCredential keyCredential = new AzureKeyCredential("account-master-key/ResourceToken");
CosmosClient cosmosClient = await CosmosClient.CreateAndInitializeAsync("account-endpoint-from-portal",
keyCredential,
containersToInitialize)
....
// To udpate key/credentials
keyCredential.Update("updated master-key/ResourceToken");
// Dispose cosmosClient at application exit
注釈
AzureKeyCredential を使用すると、master-key/ResourceToken whle CosmosClient がまだ使用されている変更/更新が可能になります。
適用対象
CreateAndInitializeAsync(String, TokenCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)
アカウント エンドポイント URI 文字列と TokenCredential を使用して、新しい CosmosClient を作成します。 さらに、提供されたコンテナーを使用してクライアントを初期化します。つまり、SDK は、サービスの最初の呼び出しが行われる前にキャッシュと接続をウォームアップします。 これを使用して、アプリケーションの起動時の待機時間を短くします。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。
public static System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient> CreateAndInitializeAsync (string accountEndpoint, Azure.Core.TokenCredential tokenCredential, System.Collections.Generic.IReadOnlyList<(string databaseId, string containerId)> containers, Microsoft.Azure.Cosmos.CosmosClientOptions cosmosClientOptions = default, System.Threading.CancellationToken cancellationToken = default);static member CreateAndInitializeAsync : string * Azure.Core.TokenCredential * System.Collections.Generic.IReadOnlyList<ValueTuple<string, string>> * Microsoft.Azure.Cosmos.CosmosClientOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient>Public Shared Function CreateAndInitializeAsync (accountEndpoint As String, tokenCredential As TokenCredential, containers As IReadOnlyList(Of ValueTuple(Of String, String)), Optional cosmosClientOptions As CosmosClientOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CosmosClient)パラメーター
- accountEndpoint
- String
使用する Cosmos サービス エンドポイント。
- tokenCredential
- TokenCredential
TokenCredential承認用の AAD トークンを提供するトークン。
- containers
- IReadOnlyList<ValueTuple<String,String>>
初期化されるコンテナーは、データベース名とコンテナー名によって識別されます。
- cosmosClientOptions
- CosmosClientOptions
(省略可能) クライアント オプション
- cancellationToken
- CancellationToken
(省略可能)キャンセル トークン
戻り値
CosmosClient オブジェクト。
適用対象
CreateAndInitializeAsync(String, String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)
アカウント エンドポイント URI 文字列と TokenCredential を使用して、新しい CosmosClient を作成します。 さらに、提供されたコンテナーを使用してクライアントを初期化します。つまり、SDK は、サービスの最初の呼び出しが行われる前にキャッシュと接続をウォームアップします。 これを使用して、アプリケーションの起動時の待機時間を短くします。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。
public static System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient> CreateAndInitializeAsync (string accountEndpoint, string authKeyOrResourceToken, System.Collections.Generic.IReadOnlyList<(string databaseId, string containerId)> containers, Microsoft.Azure.Cosmos.CosmosClientOptions cosmosClientOptions = default, System.Threading.CancellationToken cancellationToken = default);static member CreateAndInitializeAsync : string * string * System.Collections.Generic.IReadOnlyList<ValueTuple<string, string>> * Microsoft.Azure.Cosmos.CosmosClientOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient>Public Shared Function CreateAndInitializeAsync (accountEndpoint As String, authKeyOrResourceToken As String, containers As IReadOnlyList(Of ValueTuple(Of String, String)), Optional cosmosClientOptions As CosmosClientOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CosmosClient)パラメーター
- accountEndpoint
- String
使用する Cosmos サービス エンドポイント
- authKeyOrResourceToken
- String
クライアントの作成に使用する Cosmos アカウント キーまたはリソース トークン。
- containers
- IReadOnlyList<ValueTuple<String,String>>
初期化されるコンテナーは、データベース名とコンテナー名によって識別されます。
- cosmosClientOptions
- CosmosClientOptions
(省略可能) クライアント オプション
- cancellationToken
- CancellationToken
(省略可能)キャンセル トークン
戻り値
CosmosClient オブジェクト。
例
CosmosClient は AccountEndpoint、AccountKey、または ResourceToken を使用して作成され、アカウント内の 2 つのコンテナーが初期化されます
using Microsoft.Azure.Cosmos;
List<(string, string)> containersToInitialize = new List<(string, string)>
{ ("DatabaseName1", "ContainerName1"), ("DatabaseName2", "ContainerName2") };
CosmosClient cosmosClient = await CosmosClient.CreateAndInitializeAsync("account-endpoint-from-portal",
"account-key-from-portal",
containersToInitialize)
// Dispose cosmosClient at application exit
注釈
初期化ではネットワーク呼び出しが行われないため、返される参照では資格情報や接続の検証は保証されません。
適用対象
Azure SDK for .NET