CosmosDBAccountResource.RegenerateKeyAsync Method

Definition

Regenerates an access key for the specified Azure Cosmos DB database account.

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

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.

content
CosmosDBAccountRegenerateKeyContent

The name of the key to regenerate.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

content is null.

Applies to