DocumentClient.DeleteDocumentCollectionAsync Método

Definição

Namespace:

Microsoft.Azure.Documents.Client

Assemblies:

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

Pacotes:

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

Sobrecargas

DeleteDocumentCollectionAsync(String, RequestOptions)	Exclua um DocumentCollection do serviço do Azure Cosmos DB como uma operação assíncrona.
DeleteDocumentCollectionAsync(Uri, RequestOptions)	Exclua uma coleção como uma operação assíncrona do serviço do Azure Cosmos DB.

DeleteDocumentCollectionAsync(String, RequestOptions)

Exclua um DocumentCollection do serviço do Azure Cosmos DB como uma operação assíncrona.

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>>
override this.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))

Parâmetros

documentCollectionLink

String

O link do Document a ser excluído. Por exemplo, dbs/db_rid/colls/col_rid/

options

RequestOptions

(Opcional) As opções de solicitação para a solicitação.

Retornos

Task<ResourceResponse<DocumentCollection>>

Um System.Threading.Tasks que contém um ResourceResponse<TResource> que conterá informações sobre a solicitação emitida.

Implementações

DeleteDocumentCollectionAsync(String, RequestOptions)

Exceções

ArgumentNullException

Se documentCollectionLink não estiver definido.

DocumentClientException

Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar um Documento são:

StatusCode	Motivo da exceção
404	NotFound - Isso significa que o recurso que você tentou excluir não existia.

Exemplos

//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);

Confira também

• ResourceResponse<TResource>
• Task
• DocumentCollection
• RequestOptions

DeleteDocumentCollectionAsync(Uri, RequestOptions)

Exclua uma coleção como uma operação assíncrona do serviço do 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>>
override this.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))

Parâmetros

documentCollectionUri

Uri

o URI da coleção de documentos a ser excluída.

options

RequestOptions

As opções de solicitação para a solicitação.

Retornos

Task<ResourceResponse<DocumentCollection>>

O objeto de tarefa que representa a resposta de serviço para a operação assíncrona.

Implementações

DeleteDocumentCollectionAsync(Uri, RequestOptions)