CosmosDatabase.CreateContainerAsync Method

Definition

Namespace:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Package:

Azure.Cosmos v4.0.0-preview3

Overloads

CreateContainerAsync(ContainerProperties, Nullable<Int32>, RequestOptions, CancellationToken)	Creates a container as an asynchronous operation in the Azure Cosmos service.
CreateContainerAsync(String, String, Nullable<Int32>, RequestOptions, CancellationToken)	Creates a container as an asynchronous operation in the Azure Cosmos service.

CreateContainerAsync(ContainerProperties, Nullable<Int32>, RequestOptions, CancellationToken)

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

public abstract System.Threading.Tasks.Task<Azure.Cosmos.ContainerResponse> CreateContainerAsync (Azure.Cosmos.ContainerProperties containerProperties, int? throughput = default, Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateContainerAsync : Azure.Cosmos.ContainerProperties * Nullable<int> * Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Cosmos.ContainerResponse>

Public MustOverride Function CreateContainerAsync (containerProperties As ContainerProperties, Optional throughput As Nullable(Of Integer) = Nothing, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)

Parameters

containerProperties

ContainerProperties

The ContainerProperties object.

throughput

Nullable<Int32>

(Optional) The throughput provisioned for a container in measurement of Requests Units per second in the Azure Cosmos DB service.

requestOptions

RequestOptions

(Optional) The options for the container request RequestOptions

cancellationToken

CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<ContainerResponse>

A Task containing a Response which wraps a ContainerProperties containing the read resource record.

Exceptions

ArgumentNullException

If either containerProperties is not set.

AggregateException

Represents a consolidation of failures that occurred during async processing. Look within InnerExceptions to find the actual exception(s).

CosmosException

This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a container are:

StatusCode	Reason for exception
400	BadRequest - This means something was wrong with the request supplied. It is likely that an id was not supplied for the new container.
403	Forbidden - This means you attempted to exceed your quota for containers. Contact support to have this quota increased.
409	Conflict - This means a ContainerProperties with an id matching the id you supplied already existed.

Examples

ContainerProperties containerProperties = new ContainerProperties()
{
    Id = Guid.NewGuid().ToString(),
    PartitionKeyPath = "/pk",
    IndexingPolicy = new IndexingPolicy()
   {
        Automatic = false,
        IndexingMode = IndexingMode.Lazy,
   };
};

ContainerResponse response = await this.cosmosDatabase.CreateContainerAsync(containerProperties);

Remarks

https://docs.microsoft.com/azure/cosmos-db/request-units for details on provision throughput.

CreateContainerAsync(String, String, Nullable<Int32>, RequestOptions, CancellationToken)

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

public abstract System.Threading.Tasks.Task<Azure.Cosmos.ContainerResponse> CreateContainerAsync (string id, string partitionKeyPath, int? throughput = default, Azure.Cosmos.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateContainerAsync : string * string * Nullable<int> * Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Cosmos.ContainerResponse>

Public MustOverride Function CreateContainerAsync (id As String, partitionKeyPath As String, Optional throughput As Nullable(Of Integer) = Nothing, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ContainerResponse)

Parameters

id

String

The cosmos container id

partitionKeyPath

String

The path to the partition key. Example: /location

throughput

Nullable<Int32>

(Optional) The throughput provisioned for a container in measurement of Requests Units per second in the Azure Cosmos DB service.

requestOptions

RequestOptions

(Optional) The options for the container request RequestOptions

cancellationToken

CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<ContainerResponse>

A Task containing a Response which wraps a ContainerProperties containing the read resource record.

Exceptions

ArgumentNullException

If id is not set.

AggregateException

Represents a consolidation of failures that occurred during async processing. Look within InnerExceptions to find the actual exception(s).

CosmosException

This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a container are:

StatusCode	Reason for exception
400	BadRequest - This means something was wrong with the request supplied. It is likely that an id was not supplied for the new container.
403	Forbidden - This means you attempted to exceed your quota for containers. Contact support to have this quota increased.
409	Conflict - This means a ContainerProperties with an id matching the id you supplied already existed.

Examples

ContainerResponse response = await this.cosmosDatabase.CreateContainerAsync(Guid.NewGuid().ToString(), "/pk");

Remarks

https://docs.microsoft.com/azure/cosmos-db/request-units for details on provision throughput.