BatchAccountOperationsExtensions.RegenerateKeyAsync Method

Definition

Regenerates the specified account key for the Batch account.

public static System.Threading.Tasks.Task<Microsoft.Azure.Management.Batch.Models.BatchAccountKeys> RegenerateKeyAsync (this Microsoft.Azure.Management.Batch.IBatchAccountOperations operations, string resourceGroupName, string accountName, Microsoft.Azure.Management.Batch.Models.AccountKeyType keyName, System.Threading.CancellationToken cancellationToken = default);
static member RegenerateKeyAsync : Microsoft.Azure.Management.Batch.IBatchAccountOperations * string * string * Microsoft.Azure.Management.Batch.Models.AccountKeyType * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Management.Batch.Models.BatchAccountKeys>
<Extension()>
Public Function RegenerateKeyAsync (operations As IBatchAccountOperations, resourceGroupName As String, accountName As String, keyName As AccountKeyType, Optional cancellationToken As CancellationToken = Nothing) As Task(Of BatchAccountKeys)

Parameters

operations
IBatchAccountOperations

The operations group for this extension method.

resourceGroupName
String

The name of the resource group that contains the Batch account.

accountName
String

The name of the Batch account.

keyName
AccountKeyType

The type of account key to regenerate. Possible values include: 'Primary', 'Secondary'

cancellationToken
CancellationToken

The cancellation token.

Returns

Remarks

This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, regenerating the keys will fail.

Applies to