Container.DeleteItemStreamAsync Methode

Referenz

Definition

Namespace:: Microsoft.Azure.Cosmos

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

Paket:: Microsoft.Azure.Cosmos v3.36.0

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Löschen Sie ein Element aus dem Azure Cosmos-Dienst als asynchronen Vorgang.

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)

Parameter

id: String

Die Cosmos-Element-ID

partitionKey: PartitionKey

Der Partitionsschlüssel für das Element.

requestOptions: ItemRequestOptions

(Optional) Die Optionen für die Elementanforderung.

cancellationToken: CancellationToken

(Optional) CancellationToken stellt den Anforderungsabbruch dar.

Gibt zurück

Task<ResponseMessage>

Ein Task mit einem ResponseMessage , das ein umschließt, Stream das den lösch-Ressourcendatensatz enthält.

Beispiele

Löschen eines Elements aus Cosmos

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

Hinweise

Der Stream-Vorgang löst nur clientseitige Ausnahmen aus. Dadurch soll die Leistung gesteigert und der Mehraufwand beim Auslösen von Ausnahmen vermieden werden. Überprüfen Sie den HTTP-status Code in der Antwort, um zu überprüfen, ob der Vorgang fehlgeschlagen ist.

Gilt für:

Freigeben über