DocumentClient.DeleteDocumentAsync Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Surcharges
| DeleteDocumentAsync(String, RequestOptions, CancellationToken) |
Supprimez un Document du service Azure Cosmos DB en tant qu’opération asynchrone. |
| DeleteDocumentAsync(Uri, RequestOptions, CancellationToken) |
Supprimer un document en tant qu’opération asynchrone du service Azure Cosmos DB. |
DeleteDocumentAsync(String, RequestOptions, CancellationToken)
Supprimez un Document du service Azure Cosmos DB en tant qu’opération asynchrone.
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>>
override this.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))Paramètres
- documentLink
- String
Lien du Document à supprimer. Par exemple, dbs/db_rid/colls/col_rid/docs/doc_rid/
- options
- RequestOptions
(Facultatif) Options de demande pour la demande.
- cancellationToken
- CancellationToken
(Facultatif) CancellationToken qui peut être utilisé par d’autres objets ou threads pour recevoir un avis d’annulation.
Retours
System.Threading.Tasks contenant un qui contiendra des ResourceResponse<TResource> informations sur la demande émise.
Implémente
Exceptions
Si documentLink n’est pas défini.
Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un document :
| StatusCode | Raison de l’exception |
|---|---|
| 404 | NotFound : cela signifie que la ressource que vous avez tenté de supprimer n’existait pas. |
Exemples
//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);
Voir aussi
S’applique à
DeleteDocumentAsync(Uri, RequestOptions, CancellationToken)
Supprimer un document en tant qu’opération asynchrone du service 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>>
override this.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))Paramètres
- documentUri
- Uri
URI du document à supprimer.
- options
- RequestOptions
Options de demande pour la demande.
- cancellationToken
- CancellationToken
(Facultatif) CancellationToken représentant l’annulation de la demande.
Retours
Objet de tâche représentant la réponse du service pour l’opération asynchrone.
Implémente
S’applique à
Azure SDK for .NET