IDocumentClient.CreateDocumentCollectionIfNotExistsAsync メソッド

定義

名前空間:

Microsoft.Azure.Documents

アセンブリ:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

パッケージ:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

オーバーロード

CreateDocumentCollectionIfNotExistsAsync(String, DocumentCollection, RequestOptions)	Azure Cosmos DB サービスで非同期操作としてコレクションを作成 (存在しない場合) またはコレクションを取得 (既に存在する場合) します。 応答から状態コードをチェックして、コレクションが新しく作成された (201) か、既存のコレクションが返されたか (200) かを判断できます。
CreateDocumentCollectionIfNotExistsAsync(Uri, DocumentCollection, RequestOptions)	Azure Cosmos DB サービスで非同期操作としてコレクションを作成 (存在しない場合) またはコレクションを取得 (既に存在する場合) します。

CreateDocumentCollectionIfNotExistsAsync(String, DocumentCollection, RequestOptions)

Azure Cosmos DB サービスで非同期操作としてコレクションを作成 (存在しない場合) またはコレクションを取得 (既に存在する場合) します。 応答から状態コードをチェックして、コレクションが新しく作成された (201) か、既存のコレクションが返されたか (200) かを判断できます。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> CreateDocumentCollectionIfNotExistsAsync (string databaseLink, Microsoft.Azure.Documents.DocumentCollection documentCollection, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member CreateDocumentCollectionIfNotExistsAsync : string * Microsoft.Azure.Documents.DocumentCollection * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>

Public Function CreateDocumentCollectionIfNotExistsAsync (databaseLink As String, documentCollection As DocumentCollection, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))

パラメーター

databaseLink

String

コレクションを作成するデータベースのリンク。 例: dbs/db_rid/。

documentCollection

DocumentCollection

DocumentCollection オブジェクト。

options

RequestOptions

(省略可能) RequestOptions コレクションの作成時に指定する任意のユーザー。 例: RequestOptions.OfferThroughput = 400。

戻り値

Task<ResourceResponse<DocumentCollection>>

非同期操作の DocumentCollection サービス応答を Task 表す オブジェクト内に格納されている 作成された 。

例外

ArgumentNullException

または documentCollection がdatabaseLink設定されていない場合。

AggregateException

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

DocumentClientException

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

StatusCode	例外の理由
400	BadRequest - これは、指定された要求に何らかの問題が発生したことを意味します。 新しいコレクションに ID が指定されていない可能性があります。
403	禁止 - これは、コレクションのクォータを超えようとしたことを意味します。 このクォータを増やすには、サポートにお問い合わせください。

例

using (IDocumentClient client = new DocumentClient(new Uri("service endpoint"), "auth key"))
{
    //Create a new collection with an OfferThroughput set to 10000
    //Not passing in RequestOptions.OfferThroughput will result in a collection with the default OfferThroughput set.
    DocumentCollection coll = await client.CreateDocumentCollectionIfNotExistsAsync(databaseLink,
        new DocumentCollection { Id = "My Collection" },
        new RequestOptions { OfferThroughput = 10000} );
}

こちらもご覧ください

• RequestOptions
• ResourceResponse<TResource>
• Task
• DocumentCollection
• OfferV2

CreateDocumentCollectionIfNotExistsAsync(Uri, DocumentCollection, RequestOptions)

Azure Cosmos DB サービスで非同期操作としてコレクションを作成 (存在しない場合) またはコレクションを取得 (既に存在する場合) します。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> CreateDocumentCollectionIfNotExistsAsync (Uri databaseUri, Microsoft.Azure.Documents.DocumentCollection documentCollection, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member CreateDocumentCollectionIfNotExistsAsync : Uri * Microsoft.Azure.Documents.DocumentCollection * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>

Public Function CreateDocumentCollectionIfNotExistsAsync (databaseUri As Uri, documentCollection As DocumentCollection, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))

パラメーター

databaseUri

Uri

コレクションを作成するデータベースの URI。

documentCollection

DocumentCollection

DocumentCollection オブジェクト。

options

RequestOptions

(省略可能) RequestOptions コレクションの作成時に指定する任意のユーザー。 例: RequestOptions.OfferThroughput = 400。

戻り値

Task<ResourceResponse<DocumentCollection>>

非同期操作の DocumentCollection サービス応答を Task 表す オブジェクト内に格納されている 作成された 。