Container.ReadItemStreamAsync Methode

Definition

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paket:

Microsoft.Azure.Cosmos v3.39.0

Quelle:

Container.cs

Liest ein Element aus dem Azure Cosmos-Dienst als asynchronen Vorgang.

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

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

Public MustOverride Function ReadItemStreamAsync (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>

Eine Task , die ein ResponseMessage enthält, das einen Stream umschließt, der den gelesenen Ressourcendatensatz enthält.

Beispiele

Liest eine Antwort als Stream.

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

    //Read or do other operations with the stream
    using (StreamReader streamReader = new StreamReader(response.Content))
    {
        string content = await streamReader.ReadToEndAsync();
    }
}

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.