DocumentClient.CreateDocumentCollectionIfNotExistsAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| CreateDocumentCollectionIfNotExistsAsync(Uri, DocumentCollection, RequestOptions) |
Azure Cosmos DB サービスの非同期操作として、コレクションを作成 (存在しない場合) または取得 (既に存在する場合) します。 |
| CreateDocumentCollectionIfNotExistsAsync(String, DocumentCollection, RequestOptions) |
(存在しない場合) またはコレクションを Azure Cosmos DB サービスの非同期操作として取得 (既に存在する場合) を作成します。 応答から状態コードをチェックして、コレクションが新しく作成された (201) か、既存のコレクションが返されたか (200) かを判断できます。 |
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>>
override this.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。
戻り値
非同期操作の DocumentCollection サービス応答を Task 表す オブジェクト内に含まれる 作成された 。
実装
適用対象
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>>
override this.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。
戻り値
非同期操作の DocumentCollection サービス応答を Task 表す オブジェクト内に含まれる 作成された 。
実装
例外
または documentCollection がdatabaseLink設定されていない場合。
非同期処理中に発生したエラーの統合を表します。 InnerExceptions 内を見て、実際の例外を見つけます。
この例外により、さまざまな種類のエラーがカプセル化される可能性があります。 特定のエラーを特定するには、常に 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} );
}
こちらもご覧ください
適用対象
Azure SDK for .NET