DocumentClient.DeleteDocumentAsync Método

Definición

Espacio de nombres:

Microsoft.Azure.Documents.Client

Ensamblados:

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

Paquetes:

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

Sobrecargas

DeleteDocumentAsync(String, RequestOptions, CancellationToken)	Elimine un Document elemento del servicio Azure Cosmos DB como una operación asincrónica.
DeleteDocumentAsync(Uri, RequestOptions, CancellationToken)	Elimine un documento como una operación asincrónica del servicio Azure Cosmos DB.

DeleteDocumentAsync(String, RequestOptions, CancellationToken)

Elimine un Document elemento del servicio Azure Cosmos DB como una operación asincrónica.

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

Parámetros

documentLink

String

Vínculo de que Document se va a eliminar. Por ejemplo, dbs/db_rid/colls/col_rid/docs/doc_rid/

options

RequestOptions

(Opcional) Opciones de solicitud para la solicitud.

cancellationToken

CancellationToken

(Opcional) que CancellationToken pueden ser utilizados por otros objetos o subprocesos para recibir aviso de cancelación.

Devoluciones

Task<ResourceResponse<Document>>

que System.Threading.Tasks contiene un ResourceResponse<TResource> objeto que contendrá información sobre la solicitud emitida.

Implementaciones

DeleteDocumentAsync(String, RequestOptions, CancellationToken)

Excepciones

ArgumentNullException

Si documentLink no se establece.

DocumentClientException

Esta excepción puede encapsular muchos tipos diferentes de errores. Para determinar el error específico, examine siempre la propiedad StatusCode. Algunos códigos comunes que puede obtener al crear un documento son:

StatusCode	Motivo de la excepción
404	NotFound: significa que el recurso que intentó eliminar no existía.

Ejemplos

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

Consulte también

• ResourceResponse<TResource>
• Task
• Database
• RequestOptions

DeleteDocumentAsync(Uri, RequestOptions, CancellationToken)

Elimine un documento como una operación asincrónica del servicio 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))

Parámetros

documentUri

Uri

el URI del documento que se va a eliminar.

options

RequestOptions

Opciones de solicitud para la solicitud.

cancellationToken

CancellationToken

(Opcional) CancellationToken que representa la cancelación de la solicitud.

Devoluciones

Task<ResourceResponse<Document>>

Objeto de tarea que representa la respuesta del servicio para la operación asincrónica.

Implementaciones

DeleteDocumentAsync(Uri, RequestOptions, CancellationToken)