CosmosClient クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
Azure Cosmos DB アカウントのクライアント側の論理表現を提供します。 このクライアントを使用して、Azure Cosmos DB データベース サービスで要求を構成および実行できます。
CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。
public class CosmosClient : IDisposabletype CosmosClient = class
interface IDisposablePublic Class CosmosClient
Implements IDisposable- 継承
-
CosmosClient
- 実装
例
この例では、CosmosClientDatabaseおよび を作成しますContainer。 CosmosClient は、接続文字列で作成され、"米国東部 2" リージョンを使用するように構成されます。
using Microsoft.Azure.Cosmos;
CosmosClient cosmosClient = new CosmosClient(
"connection-string-from-portal",
new CosmosClientOptions()
{
ApplicationRegion = Regions.EastUS2,
});
Database db = await cosmosClient.CreateDatabaseAsync("database-id");
Container container = await db.CreateContainerAsync("container-id");
// Dispose cosmosClient at application exit
この例では、CosmosClientDatabaseおよび を作成しますContainer。 CosmosClient は AccountEndpoint、AccountKey、または ResourceToken を使用して作成され、"米国東部 2" リージョンを使用するように構成されます。
using Microsoft.Azure.Cosmos;
CosmosClient cosmosClient = new CosmosClient(
"account-endpoint-from-portal",
"account-key-from-portal",
new CosmosClientOptions()
{
ApplicationRegion = Regions.EastUS2,
});
Database db = await cosmosClient.CreateDatabaseAsync("database-id");
Container container = await db.CreateContainerAsync("container-id");
// Dispose cosmosClient at application exit
この例では、CosmosClientDatabaseおよび を作成しますContainer。 CosmosClient は、 を使用してビルダー パターンを使用して CosmosClientBuilder作成されます。
using Microsoft.Azure.Cosmos;
using Microsoft.Azure.Cosmos.Fluent;
CosmosClient cosmosClient = new CosmosClientBuilder("connection-string-from-portal")
.WithApplicationRegion("East US 2")
.Build();
Database db = await cosmosClient.CreateDatabaseAsync("database-id")
Container container = await db.CreateContainerAsync("container-id");
// Dispose cosmosClient at application exit
注釈
返された初期化されていない参照では、作成ではネットワーク呼び出しが行われないため、資格情報や接続の検証は保証されません
コンストラクター
| CosmosClient() |
モック テストに使用する新しい CosmosClient を作成する |
| CosmosClient(String, AzureKeyCredential, CosmosClientOptions) |
アカウント エンドポイント URI 文字列と AzureKeyCredential を使用して、新しい CosmosClient を作成します。 AzureKeyCredential を使用すると、CosmosClient がまだ使用されている間に master-key/ResourceToken を変更/更新できます。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
| CosmosClient(String, CosmosClientOptions) |
接続文字列を使用して新しい CosmosClient を作成します。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
| CosmosClient(String, String, CosmosClientOptions) |
アカウント エンドポイント URI 文字列とアカウント キーを使用して、新しい CosmosClient を作成します。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
| CosmosClient(String, TokenCredential, CosmosClientOptions) |
アカウント エンドポイント URI 文字列と TokenCredential を使用して、新しい CosmosClient を作成します。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
プロパティ
| ClientOptions |
CosmosClientOptions使用される cosmosClient を初期化します。 |
| Endpoint |
Azure Cosmos DB サービスのエンドポイント URI を取得します。 |
| ResponseFactory |
CosmosClient 応答型の作成に使用される応答ファクトリ。 |
メソッド
| CreateAndInitializeAsync(String, AzureKeyCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken) |
アカウント エンドポイント URI 文字列と AzureKeyCredential を使用して、新しい CosmosClient を作成します。 AzureKeyCredential を使用すると、CosmosClient がまだ使用されている間に master-key/ResourceToken を変更/更新できます。 また、提供されたコンテナーを使用してクライアントを初期化します。つまり、SDK は、サービスの最初の呼び出しが行われる前にキャッシュと接続をウォームアップします。 これを使用して、アプリケーションの起動中の待機時間を短縮します。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
| CreateAndInitializeAsync(String, 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, TokenCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken) |
アカウント エンドポイント URI 文字列と TokenCredential を使用して、新しい CosmosClient を作成します。 また、提供されたコンテナーを使用してクライアントを初期化します。つまり、SDK は、サービスの最初の呼び出しが行われる前にキャッシュと接続をウォームアップします。 これを使用して、アプリケーションの起動中の待機時間を短縮します。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
| CreateDatabaseAsync(String, Nullable<Int32>, RequestOptions, CancellationToken) |
データベースを作成するための要求を送信します。 データベースは、ユーザー、アクセス許可、およびコンテナーのセットを管理します。 各 Azure Cosmos DB データベース アカウントは、データの論理コンテナーである複数の独立した名前付きデータベースをサポートできます。 各データベースは 1 つ以上のコンテナーで構成され、各コンテナーには 1 つ以上のドキュメントが含まれます。 データベースは管理リソースであるため、ユーザー API を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。 |
| CreateDatabaseAsync(String, ThroughputProperties, RequestOptions, CancellationToken) |
データベースを作成するための要求を送信します。 データベースは、ユーザー、アクセス許可、およびコンテナーのセットを管理します。 各 Azure Cosmos DB データベース アカウントは、データの論理コンテナーである複数の独立した名前付きデータベースをサポートできます。 各データベースは 1 つ以上のコンテナーで構成され、各コンテナーには 1 つ以上のドキュメントが含まれます。 データベースは管理リソースであるため、ユーザー API を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。 |
| CreateDatabaseIfNotExistsAsync(String, Nullable<Int32>, RequestOptions, CancellationToken) |
データベースが存在するかどうかを確認し、存在しない場合は作成します。 データベース ID のみが、既存のデータベースがあるかどうかを確認するために使用されます。 スループットなどの他のデータベース プロパティは検証されず、渡されたプロパティとは異なる場合があります。 データベースは、ユーザー、アクセス許可、およびコンテナーのセットを管理します。 各 Azure Cosmos DB データベース アカウントは、データの論理コンテナーである複数の独立した名前付きデータベースをサポートできます。 各データベースは 1 つ以上のコンテナーで構成され、各コンテナーには 1 つ以上のドキュメントが含まれます。 データベースは管理リソースであるため、ユーザー API を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。 |
| CreateDatabaseIfNotExistsAsync(String, ThroughputProperties, RequestOptions, CancellationToken) |
データベースが存在するかどうかを確認し、存在しない場合は作成します。 データベース ID のみが、既存のデータベースがあるかどうかを確認するために使用されます。 スループットなどの他のデータベース プロパティは検証されず、渡されたプロパティとは異なる場合があります。 データベースは、ユーザー、アクセス許可、およびコンテナーのセットを管理します。 各 Azure Cosmos DB データベース アカウントは、データの論理コンテナーである複数の独立した名前付きデータベースをサポートできます。 各データベースは 1 つ以上のコンテナーで構成され、各コンテナーには 1 つ以上のドキュメントが含まれます。 データベースは管理リソースであるため、ユーザー API を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。 |
| CreateDatabaseStreamAsync(DatabaseProperties, Nullable<Int32>, RequestOptions, CancellationToken) |
データベースを作成するための要求を送信します。 データベースは、ユーザー、アクセス許可、およびコンテナーのセットを管理します。 各 Azure Cosmos DB データベース アカウントは、データの論理コンテナーである複数の独立した名前付きデータベースをサポートできます。 各データベースは 1 つ以上のコンテナーで構成され、各コンテナーには 1 つ以上のドキュメントが含まれます。 データベースは管理リソースであるため、ユーザー API を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。 |
| Dispose() |
Cosmos クライアントを破棄する |
| Dispose(Boolean) |
Cosmos クライアントを破棄する |
| GetContainer(String, String) |
コンテナーへのプロキシ参照を返します。 |
| GetDatabase(String) |
データベースへのプロキシ参照を返します。 |
| GetDatabaseQueryIterator<T>(QueryDefinition, String, QueryRequestOptions) |
このメソッドは、パラメーター化された値を持つ SQL ステートメントを使用して、Cosmos DB アカウントの下にデータベースのクエリを作成します。 FeedIterator を返します。 パラメーター化された値を使用した SQL ステートメントの準備の詳細については、 を参照してください QueryDefinition。 |
| GetDatabaseQueryIterator<T>(String, String, QueryRequestOptions) |
このメソッドは、SQL ステートメントを使用して、Cosmos DB アカウントの下にデータベースのクエリを作成します。 FeedIterator を返します。 |
| GetDatabaseQueryStreamIterator(QueryDefinition, String, QueryRequestOptions) |
このメソッドは、パラメーター化された値を持つ SQL ステートメントを使用して、Cosmos DB アカウントの下にデータベースのクエリを作成します。 FeedIterator を返します。 パラメーター化された値を使用した SQL ステートメントの準備の詳細については、 を参照してください QueryDefinition。 |
| GetDatabaseQueryStreamIterator(String, String, QueryRequestOptions) |
このメソッドは、SQL ステートメントを使用して、Cosmos DB アカウントの下にデータベースのクエリを作成します。 FeedIterator を返します。 |
| ReadAccountAsync() |
AccountProperties Azure Cosmos DB アカウントの を読み取ります。 |
適用対象
こちらもご覧ください
Azure SDK for .NET