Udostępnij za pośrednictwem


CosmosDBSqlClientEncryptionKeyCollection.CreateOrUpdate 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-05-15-preview
  • Resource: CosmosDBSqlClientEncryptionKeyResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBSqlClientEncryptionKeyResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string clientEncryptionKeyName, Azure.ResourceManager.CosmosDB.Models.CosmosDBSqlClientEncryptionKeyCreateOrUpdateContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.Models.CosmosDBSqlClientEncryptionKeyCreateOrUpdateContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBSqlClientEncryptionKeyResource>
override this.CreateOrUpdate : Azure.WaitUntil * string * Azure.ResourceManager.CosmosDB.Models.CosmosDBSqlClientEncryptionKeyCreateOrUpdateContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.CosmosDBSqlClientEncryptionKeyResource>
Public Overridable Function CreateOrUpdate (waitUntil As WaitUntil, clientEncryptionKeyName As String, content As CosmosDBSqlClientEncryptionKeyCreateOrUpdateContent, Optional cancellationToken As CancellationToken = Nothing) As 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