CosmosDBSqlContainerCollection.CreateOrUpdateAsync Method

Definition

Create or update an Azure Cosmos DB SQL container

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}
  • Operation Id: SqlResources_CreateUpdateSqlContainer
  • Default Api Version: 2024-02-15-preview
  • Resource: CosmosDBSqlContainerResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBSqlContainerResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, string containerName, Azure.ResourceManager.CosmosDB.Models.CosmosDBSqlContainerCreateOrUpdateContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.Models.CosmosDBSqlContainerCreateOrUpdateContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBSqlContainerResource>>
override this.CreateOrUpdateAsync : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.Models.CosmosDBSqlContainerCreateOrUpdateContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBSqlContainerResource>>
Public Overridable Function CreateOrUpdateAsync (waitUntil As WaitUntil, containerName As String, content As CosmosDBSqlContainerCreateOrUpdateContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of CosmosDBSqlContainerResource))

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

containerName
String

Cosmos DB container name.

content
CosmosDBSqlContainerCreateOrUpdateContent

The parameters to provide for the current SQL container.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

containerName is an empty string, and was expected to be non-empty.

containerName or content is null.

Applies to