Container.DeleteItemStreamAsync Méthode

Référence

Définition

Espace de noms:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Paquet:: Microsoft.Azure.Cosmos v3.36.0

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Supprimez un élément du service Azure Cosmos en tant qu’opération asynchrone.

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

abstract member DeleteItemStreamAsync : string * Microsoft.Azure.Cosmos.PartitionKey * Microsoft.Azure.Cosmos.ItemRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ResponseMessage>

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

Paramètres

id: String

ID d’élément Cosmos

partitionKey: PartitionKey

Clé de partition de l’élément.

requestOptions: ItemRequestOptions

(Facultatif) Options de la demande d’élément.

cancellationToken: CancellationToken

(Facultatif) CancellationToken représentant l’annulation de la demande.

Retours

Task<ResponseMessage>

Task contenant un ResponseMessage qui encapsule un Stream contenant l’enregistrement de ressource de suppression.

Exemples

Supprimer un élément de Cosmos

using(ResponseMessage response = await this.container.DeleteItemStreamAsync("itemId", new PartitionKey("itemPartitionKey")))
{
    if (!response.IsSuccessStatusCode)
    {
        //Handle and log exception
        return;
    }
}

Remarques

L’opération Stream lève uniquement les exceptions côté client. Il s’agit d’augmenter les performances et d’éviter la surcharge liée à la levée d’exceptions. Vérifiez le code de status HTTP sur la réponse à case activée si l’opération a échoué.

S’applique à

Partager via