CosmosContainer.DeleteContainerAsync メソッド

定義

名前空間:

Azure.Cosmos

アセンブリ:

Azure.Cosmos.dll

パッケージ:

Azure.Cosmos v4.0.0-preview3

ContainerProperties非同期操作として Azure Cosmos DB サービスから を削除します。

public abstract System.Threading.Tasks.Task<Azure.Cosmos.ContainerResponse> DeleteContainerAsync (Azure.Cosmos.ContainerRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteContainerAsync : Azure.Cosmos.ContainerRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Cosmos.ContainerResponse>

Public MustOverride Function DeleteContainerAsync (Optional requestOptions As ContainerRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)

パラメーター

requestOptions

ContainerRequestOptions

(省略可能)コンテナー要求のオプション RequestOptions

cancellationToken

CancellationToken

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

戻り値

Task<ContainerResponse>

Task発行された要求にResponse関する情報を格納する を含む 。

例外

CosmosException

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

StatusCode	例外の理由
404	NotFound - 削除しようとしたリソースが存在しなかったことを意味します。

例

Container container = this.database.GetContainer("containerId");
ContainerResponse response = await container.DeleteContainerAsync();