DocumentClient.CreateDatabaseAsync(Database, RequestOptions) メソッド

  • リファレンス

定義

名前空間:
Microsoft.Azure.Documents.Client
アセンブリ:
Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll
パッケージ:
Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Azure Cosmos DB サービスで非同期操作としてデータベース リソースを作成します。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>> CreateDatabaseAsync (Microsoft.Azure.Documents.Database database, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member CreateDatabaseAsync : Microsoft.Azure.Documents.Database * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>>
override this.CreateDatabaseAsync : Microsoft.Azure.Documents.Database * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>>
Public Function CreateDatabaseAsync (database As Database, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Database))

パラメーター

database
Database

作成する の Database 仕様。

options
RequestOptions

(省略可能) RequestOptions 要求の 。

戻り値

Task<ResourceResponse<Database>>

非同期操作の Database サービス応答を表すタスク オブジェクト内に作成された 。

実装

CreateDatabaseAsync(Database, RequestOptions)

例外

ArgumentNullException

が設定されていない場合 database 。

AggregateException

非同期処理中に発生したエラーの統合を表します。 InnerExceptions 内を見て、実際の例外を見つけます。

DocumentClientException

この例外は、さまざまな種類のエラーをカプセル化できます。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 データベースの作成時に取得できる一般的なコードは次のとおりです。

StatusCode例外の理由
400BadRequest - 指定されたデータベース オブジェクトに問題が発生したことを意味します。 新しいデータベースに ID が指定されていない可能性があります。
409競合 - これは、 の id フィールドdatabaseに一致する ID が既に存在する を意味Databaseします。

例

次の例では、Id プロパティが 'MyDatabase' の新しい Database を作成します。このコード スニペットは、await キーワード (keyword)を使用するため、非同期メソッド内から使用することを目的としています。

using (IDocumentClient client = new DocumentClient(new Uri("service endpoint"), "auth key"))
{
    Database db = await client.CreateDatabaseAsync(new Database { Id = "MyDatabase" });
}

同期メソッド内から を Database 構築する場合は、次のコードを使用する必要があります。

using (IDocumentClient client = new DocumentClient(new Uri("service endpoint"), "auth key"))
{
    Database db = client.CreateDatabaseAsync(new Database { Id = "MyDatabase" }).Result;
}

適用対象

こちらもご覧ください