IDocumentClient.DeleteDocumentAsync Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Überlädt
| DeleteDocumentAsync(Uri, RequestOptions, CancellationToken) |
Löschen Sie ein Dokument als asynchronen Vorgang im Azure Cosmos DB-Dienst. |
| DeleteDocumentAsync(String, RequestOptions, CancellationToken) |
Löschen Sie einen Document aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang. |
DeleteDocumentAsync(Uri, RequestOptions, CancellationToken)
Löschen Sie ein Dokument als asynchronen Vorgang im Azure Cosmos DB-Dienst.
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))Parameter
- documentUri
- Uri
Der URI des zu löschenden Dokuments.
- options
- RequestOptions
(Optional) Der RequestOptions für die Anforderung.
- cancellationToken
- CancellationToken
(Optional) Eine CancellationToken , die von anderen Objekten oder Threads verwendet werden kann, um eine Kündigungsbenachrichtigung zu erhalten.
Gibt zurück
Das Taskobjekt, das die Dienstantwort für den asynchronen Vorgang darstellt.
Gilt für:
DeleteDocumentAsync(String, RequestOptions, CancellationToken)
Löschen Sie einen Document aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang.
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))Parameter
- documentLink
- String
Der Link des Document zu löschenden. Beispiel: dbs/db_rid/colls/col_rid/docs/doc_rid/
- options
- RequestOptions
(Optional) Die Anforderungsoptionen für die Anforderung.
- cancellationToken
- CancellationToken
(Optional) Eine CancellationToken , die von anderen Objekten oder Threads verwendet werden kann, um eine Kündigungsbenachrichtigung zu erhalten.
Gibt zurück
Eine System.Threading.Tasks , die eine ResourceResponse<TResource> enthält, die Informationen über die ausgestellte Anforderung enthält.
Ausnahmen
Wenn documentLink nicht festgelegt ist.
Diese Ausnahme kann viele verschiedene Fehlertypen kapseln. Um den spezifischen Fehler zu ermitteln, sehen Sie sich immer die StatusCode-Eigenschaft an. Einige häufige Codes, die Sie beim Erstellen eines Dokuments erhalten, sind:
| StatusCode | Ausnahmegrund |
|---|---|
| 404 | NotFound– Dies bedeutet, dass die Ressource, die Sie löschen möchten, nicht vorhanden war. |
Beispiele
//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);
Weitere Informationen
Gilt für:
Azure SDK for .NET