CosmosClient クラス

定義

名前空間:

Azure.Cosmos

アセンブリ:

Azure.Cosmos.dll

パッケージ:

Azure.Cosmos v4.0.0-preview3

Azure Cosmos DB アカウントのクライアント側の論理表現を提供します。 このクライアントを使用して、Azure Cosmos DB データベース サービスで要求を構成および実行できます。

CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 のパフォーマンス ガイド https://docs.microsoft.com/azure/cosmos-db/performance-tipsを参照してください。

public class CosmosClient : IDisposable

type CosmosClient = class
    interface IDisposable

Public Class CosmosClient
Implements IDisposable

継承

Object

CosmosClient

実装

IDisposable

例

この例では、CosmosClientCosmosDatabaseおよび を作成しますCosmosContainer。 CosmosClient は接続文字列で作成され、"米国東部 2" リージョンを使用するように構成されます。

using Azure.Cosmos;

CosmosClient cosmosClient = new CosmosClient(
            "connection-string-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

Database db = await client.CreateDatabaseAsync("database-id");
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

この例では、CosmosClientCosmosDatabaseおよび を作成しますCosmosContainer。 CosmosClient は AccountEndpoint、AccountKey、または ResourceToken を使用して作成され、"米国東部 2" リージョンを使用するように構成されます。

using Azure.Cosmos;

CosmosClient cosmosClient = new CosmosClient(
            "account-endpoint-from-portal", 
            "account-key-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

Database db = await client.CreateDatabaseAsync("database-id");
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

この例では、CosmosClientCosmosDatabaseおよび を作成しますCosmosContainer。 CosmosClient は、ビルダー パターン CosmosClientBuilderを使用して作成されます。

using Azure.Cosmos;
using Azure.Cosmos.Fluent;

CosmosClient cosmosClient = new CosmosClientBuilder("connection-string-from-portal")
    .WithApplicationRegion("East US 2")
    .Build();

Database db = await client.CreateDatabaseAsync("database-id")
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

注釈

https://docs.microsoft.com/azure/cosmos-db/performance-tips https://docs.microsoft.com/azure/cosmos-db/troubleshoot-dot-net-sdk https://docs.microsoft.com/azure/cosmos-db/distribute-data-globally https://docs.microsoft.com/azure/cosmos-db/partitioning-overview https://docs.microsoft.com/azure/cosmos-db/request-units

コンストラクター

CosmosClient()	モック テストに使用する新しい CosmosClient を作成する
CosmosClient(String, CosmosClientOptions)	接続文字列を使用して新しい CosmosClient を作成する CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 のパフォーマンス ガイド https://docs.microsoft.com/azure/cosmos-db/performance-tipsを参照してください。
CosmosClient(String, String, CosmosClientOptions)	アカウント エンドポイント URI 文字列とアカウント キーを使用して新しい CosmosClient を作成する CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 のパフォーマンス ガイド https://docs.microsoft.com/azure/cosmos-db/performance-tipsを参照してください。

プロパティ

ClientOptions	CosmosClientOptions使用される初期化 CosmosClient
Endpoint	Azure Cosmos DB サービスのエンドポイント URI を取得します。

メソッド

CreateDatabaseAsync(String, Nullable<Int32>, RequestOptions, CancellationToken)	データベースを作成するための要求を送信します。 データベースは、ユーザー、アクセス許可、およびコンテナーのセットを管理します。 各 Azure Cosmos DB データベース アカウントは、データの論理コンテナーである複数の独立した名前付きデータベースをサポートできます。 各データベースは 1 つ以上のコンテナーで構成され、各コンテナーには 1 つ以上のドキュメントが含まれます。 データベースは管理リソースであるため、ユーザー API を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。
CreateDatabaseIfNotExistsAsync(String, Nullable<Int32>, 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, CancellationToken)	このメソッドは、パラメーター化された値を持つ SQL ステートメントを使用して、Cosmos DB アカウントの下にデータベースのクエリを作成します。 FeedIterator を返します。 パラメーター化された値を使用した SQL ステートメントの準備の詳細については、 を参照してください QueryDefinition。
GetDatabaseQueryIterator<T>(String, String, QueryRequestOptions, CancellationToken)	このメソッドは、SQL ステートメントを使用して、Cosmos DB アカウントの下にデータベースのクエリを作成します。 FeedIterator を返します。 パラメーター化された値を使用した SQL ステートメントの準備の詳細については、「オーバーロード」を参照してください QueryDefinition 。
GetDatabaseQueryStreamIterator(QueryDefinition, String, QueryRequestOptions, CancellationToken)	このメソッドは、パラメーター化された値を持つ SQL ステートメントを使用して、Cosmos DB アカウントの下にデータベースのクエリを作成します。 FeedIterator を返します。 パラメーター化された値を使用した SQL ステートメントの準備の詳細については、 を参照してください QueryDefinition。
GetDatabaseQueryStreamIterator(String, String, QueryRequestOptions, CancellationToken)	このメソッドは、SQL ステートメントを使用して、Cosmos DB アカウントの下にデータベースのクエリを作成します。 FeedIterator を返します。 パラメーター化された値を使用した SQL ステートメントの準備の詳細については、「オーバーロード」を参照してください QueryDefinition 。
ReadAccountAsync()	Azure Cosmos DB アカウントのプロパティを読み取る AccountProperties