IDatabaseAccountsOperations.BeginRegenerateKeyWithHttpMessagesAsync Method

Definition

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

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> BeginRegenerateKeyWithHttpMessagesAsync (string resourceGroupName, string accountName, Microsoft.Azure.Management.CosmosDB.Fluent.Models.KeyKind keyKind, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member BeginRegenerateKeyWithHttpMessagesAsync : string * string * Microsoft.Azure.Management.CosmosDB.Fluent.Models.KeyKind * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>
Public Function BeginRegenerateKeyWithHttpMessagesAsync (resourceGroupName As String, accountName As String, keyKind As KeyKind, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

resourceGroupName
String

Name of an Azure resource group.

accountName
String

Cosmos DB database account name.

keyKind
KeyKind

The access key to regenerate. Possible values include: 'primary', 'secondary', 'primaryReadonly', 'secondaryReadonly'

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Applies to