CosmosContainer.UpsertItemStreamAsync(Stream, PartitionKey, ItemRequestOptions, CancellationToken) Method

Definition

Upserts an item stream as an asynchronous operation in the Azure Cosmos service.

public abstract System.Threading.Tasks.Task<Azure.Response> UpsertItemStreamAsync (System.IO.Stream streamPayload, Azure.Cosmos.PartitionKey partitionKey, Azure.Cosmos.ItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member UpsertItemStreamAsync : System.IO.Stream * Azure.Cosmos.PartitionKey * Azure.Cosmos.ItemRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public MustOverride Function UpsertItemStreamAsync (streamPayload As Stream, partitionKey As PartitionKey, Optional requestOptions As ItemRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

streamPayload
System.IO.Stream

A System.IO.Stream containing the payload.

partitionKey
PartitionKey

The partition key for the item. PartitionKey

requestOptions
ItemRequestOptions

(Optional) The options for the item request ItemRequestOptions

cancellationToken
System.Threading.CancellationToken

(Optional) System.Threading.CancellationToken representing request cancellation.

Returns

System.Threading.Tasks.Task<Response>

A System.Threading.Tasks.Task containing a Response which wraps a System.IO.Stream containing the read resource record.

Examples

Upsert a Stream containing the item to Cosmos

using(Response response = await this.container.UpsertItemStreamAsync(stream, new PartitionKey("itemPartitionKey")))
{

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

Applies to