DocumentClient.DeleteDocumentAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
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
que System.Threading.Tasks contiene un ResourceResponse<TResource> objeto que contendrá información sobre la solicitud emitida.
Implementaciones
Excepciones
Si documentLink
no se establece.
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
Se aplica a
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
Objeto de tarea que representa la respuesta del servicio para la operación asincrónica.
Implementaciones
Se aplica a
Azure SDK for .NET