CosmosContainer.ReplaceItemStreamAsync Method

Definition

Namespace:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Package:

Azure.Cosmos v4.0.0-preview3

Replaces a item in the Azure Cosmos service as an asynchronous operation.

public abstract System.Threading.Tasks.Task<Azure.Response> ReplaceItemStreamAsync (System.IO.Stream streamPayload, string id, Azure.Cosmos.PartitionKey partitionKey, Azure.Cosmos.ItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReplaceItemStreamAsync : System.IO.Stream * string * Azure.Cosmos.PartitionKey * Azure.Cosmos.ItemRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public MustOverride Function ReplaceItemStreamAsync (streamPayload As Stream, id As String, partitionKey As PartitionKey, Optional requestOptions As ItemRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

streamPayload

Stream

A Stream containing the payload.

id

String

The cosmos item id

partitionKey

PartitionKey

The partition key for the item. PartitionKey

requestOptions

ItemRequestOptions

(Optional) The options for the item request ItemRequestOptions

cancellationToken

CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<Response>

A Task containing a Response which wraps a Stream containing the replace resource record.

Examples

Replace an item in Cosmos

using(Response response = await this.container.ReplaceItemStreamAsync(stream, "itemId", 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();
        }
    }
}