Container.ReplaceItemStreamAsync Method

Definition

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Package:

Microsoft.Azure.Cosmos v3.39.0

Source:

Container.cs

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

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

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

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 ResponseMessage)

Parameters

streamPayload

Stream

A Stream containing the payload.

id

String

The Cosmos item id

partitionKey

PartitionKey

The partition key for the item.

requestOptions

ItemRequestOptions

(Optional) The options for the item request.

cancellationToken

CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<ResponseMessage>

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

Examples

Replace an item in Cosmos

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

Remarks

The item's partition key value is immutable. To change an item's partition key value you must delete the original item and insert a new item.