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

Definition

Creates a Item as an asynchronous operation in the Azure Cosmos service.

public abstract System.Threading.Tasks.Task<Azure.Response> CreateItemStreamAsync (System.IO.Stream streamPayload, Azure.Cosmos.PartitionKey partitionKey, Azure.Cosmos.ItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateItemStreamAsync : System.IO.Stream * Azure.Cosmos.PartitionKey * Azure.Cosmos.ItemRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public MustOverride Function CreateItemStreamAsync (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>

The Response that was created contained within a System.Threading.Tasks.Task object representing the service response for the asynchronous operation.

Examples

This example creates an item in a Cosmos container.

//Create the object in Cosmos
using (Response response = await this.Container.CreateItemStreamAsync(partitionKey: new PartitionKey("streamPartitionKey"), streamPayload: stream))
{

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

Applies to