IDocumentClient.DeleteDocumentAsync メソッド

  • リファレンス

定義

名前空間:
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

オーバーロード

DeleteDocumentAsync(Uri, RequestOptions, CancellationToken)

Azure Cosmos DB サービスで非同期操作としてドキュメントを削除します。
DeleteDocumentAsync(String, RequestOptions, CancellationToken)

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

DeleteDocumentAsync(Uri, RequestOptions, CancellationToken)

Azure Cosmos DB サービスで非同期操作としてドキュメントを削除します。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>> DeleteDocumentAsync (Uri documentUri, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
Public Function DeleteDocumentAsync (documentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))

パラメーター

documentUri
Uri

削除するドキュメントの URI。

options
RequestOptions

(省略可能) RequestOptions 要求の 。

cancellationToken
CancellationToken

(省略可能) CancellationToken 取り消しの通知を受け取るために他のオブジェクトまたはスレッドが使用できる 。

戻り値

Task<ResourceResponse<Document>>

非同期操作のサービス応答を表すタスク オブジェクト。

適用対象

DeleteDocumentAsync(String, RequestOptions, CancellationToken)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>> DeleteDocumentAsync (string documentLink, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
Public Function DeleteDocumentAsync (documentLink As String, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))

パラメーター

documentLink
String

削除する の Document リンク。 例: dbs/db_rid/colls/col_rid/docs/doc_rid/

options
RequestOptions

(省略可能)要求の要求オプション。

cancellationToken
CancellationToken

(省略可能) CancellationToken 取り消しの通知を受け取るために他のオブジェクトまたはスレッドが使用できる 。

戻り値

Task<ResourceResponse<Document>>

発行 System.Threading.Tasks された要求に ResourceResponse<TResource> 関する情報を格納する を含む 。

例外

ArgumentNullException

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

DocumentClientException

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

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

例

//Delete a document using its selfLink property
//To get the documentLink you would have to query for the Document, using CreateDocumentQuery(),  and then refer to its .SelfLink property
await client.DeleteDocumentAsync(documentLink);

こちらもご覧ください

適用対象