IDocumentClient.DeleteDocumentCollectionAsync 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

DeleteDocumentCollectionAsync(String, RequestOptions)	Supprimez un DocumentCollection du service Azure Cosmos DB en tant qu’opération asynchrone.
DeleteDocumentCollectionAsync(Uri, RequestOptions)	Supprimer une collection en tant qu’opération asynchrone dans le service Azure Cosmos DB.

DeleteDocumentCollectionAsync(String, RequestOptions)

Supprimez un DocumentCollection du service Azure Cosmos DB en tant qu’opération asynchrone.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> DeleteDocumentCollectionAsync (string documentCollectionLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member DeleteDocumentCollectionAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>

Public Function DeleteDocumentCollectionAsync (documentCollectionLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))

Paramètres

documentCollectionLink

String

Lien du Document à supprimer. Par exemple, dbs/db_rid/colls/col_rid/

options

RequestOptions

(Facultatif) Options de demande pour la demande.

Retours

Task<ResourceResponse<DocumentCollection>>

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

Exceptions

ArgumentNullException

Si documentCollectionLink 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 collection using its selfLink property
//To get the collectionLink you would have to query for the Collection, using CreateDocumentCollectionQuery(),  and then refer to its .SelfLink property
await client.DeleteDocumentCollectionAsync(collectionLink);

Voir aussi

• DocumentCollection
• RequestOptions
• ResourceResponse<TResource>
• Task

DeleteDocumentCollectionAsync(Uri, RequestOptions)

Supprimer une collection 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.DocumentCollection>> DeleteDocumentCollectionAsync (Uri documentCollectionUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member DeleteDocumentCollectionAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>

Public Function DeleteDocumentCollectionAsync (documentCollectionUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))

Paramètres

documentCollectionUri

Uri

URI de la collection de documents à supprimer.

options

RequestOptions

(Facultatif) RequestOptions pour la demande.

Retours

Task<ResourceResponse<DocumentCollection>>

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