CosmosDBSqlRoleDefinitionCollection.CreateOrUpdateAsync Method

Definition

Creates or updates an Azure Cosmos DB SQL Role Definition.

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

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.

roleDefinitionId
String

The GUID for the Role Definition.

content
CosmosDBSqlRoleDefinitionCreateOrUpdateContent

The properties required to create or update a Role Definition.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

roleDefinitionId or content is null.

Applies to