Share via


CosmosDBSqlClientEncryptionKeyCollection.CreateOrUpdateAsync Method

Definition

Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).

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

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.

clientEncryptionKeyName
String

Cosmos DB ClientEncryptionKey name.

content
CosmosDBSqlClientEncryptionKeyCreateOrUpdateContent

The parameters to provide for the client encryption key.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

clientEncryptionKeyName or content is null.

Applies to