CosmosClient.CreateDatabaseIfNotExistsAsync メソッド

定義

オーバーロード

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 を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。

CreateDatabaseIfNotExistsAsync(String, Nullable<Int32>, RequestOptions, CancellationToken)

データベースが存在するかどうかを確認し、存在しない場合は作成します。 データベース ID のみが、既存のデータベースがあるかどうかを確認するために使用されます。 スループットなどの他のデータベース プロパティは検証されず、渡されたプロパティとは異なる場合があります。

データベースは、ユーザー、アクセス許可、およびコンテナーのセットを管理します。 各 Azure Cosmos DB データベース アカウントは、データの論理コンテナーである複数の独立した名前付きデータベースをサポートできます。

各データベースは 1 つ以上のコンテナーで構成され、各コンテナーには 1 つ以上のドキュメントが含まれます。 データベースは管理リソースであるため、ユーザー API を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.DatabaseResponse> CreateDatabaseIfNotExistsAsync (string id, int? throughput = default, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateDatabaseIfNotExistsAsync : string * Nullable<int> * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.DatabaseResponse>
override this.CreateDatabaseIfNotExistsAsync : string * Nullable<int> * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.DatabaseResponse>
Public Overridable Function CreateDatabaseIfNotExistsAsync (id As String, Optional throughput As Nullable(Of Integer) = Nothing, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DatabaseResponse)

パラメーター

id
String

データベース ID。

throughput
Nullable<Int32>

(省略可能)Azure Cosmos DB サービスの 1 秒あたりの要求ユニット数の測定でデータベースにプロビジョニングされるスループット。

requestOptions
RequestOptions

(省略可能)設定できる追加オプションのセット。

cancellationToken
CancellationToken

(省略可能) CancellationToken 要求の取り消しを表します。

戻り値

Taskリソース レコードをDatabaseResponse含む をDatabasePropertiesラップする を含む 。

StatusCodeCreateDatabaseIfNotExistsAsync 操作の一般的な成功の StatusCodes
201作成済み - 新しいデータベースが作成されます。
200[OK] - データベースが既に存在します。

注釈

https://docs.microsoft.com/azure/cosmos-db/request-units プロビジョニングスループットの詳細については、

適用対象

CreateDatabaseIfNotExistsAsync(String, ThroughputProperties, RequestOptions, CancellationToken)

データベースが存在するかどうかを確認し、存在しない場合は作成します。 データベース ID のみが、既存のデータベースがあるかどうかを確認するために使用されます。 スループットなどの他のデータベース プロパティは検証されず、渡されたプロパティとは異なる場合があります。

データベースは、ユーザー、アクセス許可、およびコンテナーのセットを管理します。 各 Azure Cosmos DB データベース アカウントは、データの論理コンテナーである複数の独立した名前付きデータベースをサポートできます。

各データベースは 1 つ以上のコンテナーで構成され、各コンテナーには 1 つ以上のドキュメントが含まれます。 データベースは管理リソースであるため、ユーザー API を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.DatabaseResponse> CreateDatabaseIfNotExistsAsync (string id, Microsoft.Azure.Cosmos.ThroughputProperties throughputProperties, Microsoft.Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateDatabaseIfNotExistsAsync : string * Microsoft.Azure.Cosmos.ThroughputProperties * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.DatabaseResponse>
override this.CreateDatabaseIfNotExistsAsync : string * Microsoft.Azure.Cosmos.ThroughputProperties * Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.DatabaseResponse>
Public Overridable Function CreateDatabaseIfNotExistsAsync (id As String, throughputProperties As ThroughputProperties, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DatabaseResponse)

パラメーター

id
String

データベース ID。

throughputProperties
ThroughputProperties

Azure Cosmos DB サービスの 1 秒あたりの要求ユニット数の測定でデータベースにプロビジョニングされるスループット。

requestOptions
RequestOptions

(省略可能)設定できる追加オプションのセット。

cancellationToken
CancellationToken

(省略可能) CancellationToken 要求の取り消しを表します。

戻り値

Taskリソース レコードをDatabaseResponse含む をDatabasePropertiesラップする を含む 。

StatusCodeCreateDatabaseIfNotExistsAsync 操作の一般的な成功の StatusCodes
201作成済み - 新しいデータベースが作成されます。
200OK - データベースが既に存在します。

適用対象