IDocumentClient.DeleteDocumentAsync Método

Definição

Namespace:

Microsoft.Azure.Documents

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

DeleteDocumentAsync(Uri, RequestOptions, CancellationToken)	Exclua um documento como uma operação assíncrona no serviço do Azure Cosmos DB.
DeleteDocumentAsync(String, RequestOptions, CancellationToken)	Exclua um Document do serviço do Azure Cosmos DB como uma operação assíncrona.

DeleteDocumentAsync(Uri, RequestOptions, CancellationToken)

Exclua um documento como uma operação assíncrona no serviço do 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))

Parâmetros

documentUri

Uri

O URI do documento a ser excluído.

options

RequestOptions

(Opcional) O RequestOptions para a solicitação.

cancellationToken

CancellationToken

(Opcional) Um CancellationToken que pode ser usado por outros objetos ou threads para receber notificação de cancelamento.

Retornos

Task<ResourceResponse<Document>>

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

DeleteDocumentAsync(String, RequestOptions, CancellationToken)

Exclua um Document 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.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))

Parâmetros

documentLink

String

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

options

RequestOptions

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

cancellationToken

CancellationToken

(Opcional) Um CancellationToken que pode ser usado por outros objetos ou threads para receber notificação de cancelamento.

Retornos

Task<ResourceResponse<Document>>

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

Exceções

ArgumentNullException

Se documentLink 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 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);

Confira também

• ResourceResponse<TResource>
• Task
• Database
• RequestOptions