IDocumentClient.DeleteDocumentAsync Méthode

Définition

Espace de noms:

Microsoft.Azure.Documents

Assemblys:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Paquets:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Surcharges

DeleteDocumentAsync(Uri, RequestOptions, CancellationToken)	Supprimez un document en tant qu’opération asynchrone dans le service Azure Cosmos DB.
DeleteDocumentAsync(String, RequestOptions, CancellationToken)	Supprimez un Document du service Azure Cosmos DB en tant qu’opération asynchrone.

DeleteDocumentAsync(Uri, RequestOptions, CancellationToken)

Supprimez un document en tant qu’opération asynchrone dans le 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>>

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

(Facultatif) pour RequestOptions la demande.

cancellationToken

CancellationToken

(Facultatif) CancellationToken qui peut être utilisé par d’autres objets ou threads pour recevoir un avis d’annulation.

Retours

Task<ResourceResponse<Document>>

Objet de tâche représentant la réponse du service pour l’opération asynchrone.

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>>

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 de à 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

Task<ResourceResponse<Document>>

System.Threading.Tasks contenant un qui contiendra des ResourceResponse<TResource> informations sur la demande émise.

Exceptions

ArgumentNullException

Si documentLink n’est pas défini.

DocumentClientException

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

• Database
• RequestOptions
• ResourceResponse<TResource>
• Task