CosmosContainer.DeleteItemAsync<T> Método

Definição

Namespace:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Pacote:

Azure.Cosmos v4.0.0-preview3

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

public abstract System.Threading.Tasks.Task<Azure.Cosmos.ItemResponse<T>> DeleteItemAsync<T> (string id, Azure.Cosmos.PartitionKey partitionKey, Azure.Cosmos.ItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteItemAsync : string * Azure.Cosmos.PartitionKey * Azure.Cosmos.ItemRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Cosmos.ItemResponse<'T>>

Public MustOverride Function DeleteItemAsync(Of T) (id As String, partitionKey As PartitionKey, Optional requestOptions As ItemRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ItemResponse(Of T))

Parâmetros de tipo

T

Parâmetros

id

String

A ID do item cosmos

partitionKey

PartitionKey

A chave de partição do item. PartitionKey

requestOptions

ItemRequestOptions

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

cancellationToken

CancellationToken

(Opcional) CancellationToken que representa o cancelamento da solicitação.

Retornos

Task<ItemResponse<T>>

Um Task que contém um Response<T> que conterá informações sobre a solicitação emitida.

Exceções

CosmosException

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
429	TooManyRequests - Isso significa que você excedeu o número de unidades de solicitação por segundo.

Exemplos

public class ToDoActivity{
    public string id {get; set;}
    public string status {get; set;}
}

ItemResponse item = await this.container.DeleteItemAsync<ToDoActivity>("partitionKey", "id");