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

DeleteDocumentCollectionAsync(String, RequestOptions)	Elimine un elemento DocumentCollection del servicio Azure Cosmos DB como una operación asincrónica.
DeleteDocumentCollectionAsync(Uri, RequestOptions)	Elimine una colección como una operación asincrónica del servicio Azure Cosmos DB.

DeleteDocumentCollectionAsync(String, RequestOptions)

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

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

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

options

RequestOptions

(Opcional) Las opciones de solicitud de la solicitud.

Devoluciones

Task<ResourceResponse<DocumentCollection>>

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

Implementaciones

DeleteDocumentCollectionAsync(String, RequestOptions)

Excepciones

ArgumentNullException

Si documentCollectionLink 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 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);

Consulte también

• ResourceResponse<TResource>
• Task
• DocumentCollection
• RequestOptions

DeleteDocumentCollectionAsync(Uri, RequestOptions)

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

el URI de la colección de documentos que se va a eliminar.

options

RequestOptions

Las opciones de solicitud de la solicitud.

Devoluciones

Task<ResourceResponse<DocumentCollection>>

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

Implementaciones

DeleteDocumentCollectionAsync(Uri, RequestOptions)