BatchAccountOperationsExtensions.RegenerateKey Method

Reference

Definition

Namespace:: Microsoft.Azure.Management.Batch

Assembly:: Microsoft.Azure.Management.Batch.dll

Package:: Microsoft.Azure.Management.Batch v15.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Regenerates the specified account key for the Batch account.

public static Microsoft.Azure.Management.Batch.Models.BatchAccountKeys RegenerateKey (this Microsoft.Azure.Management.Batch.IBatchAccountOperations operations, string resourceGroupName, string accountName, Microsoft.Azure.Management.Batch.Models.AccountKeyType keyName);

static member RegenerateKey : Microsoft.Azure.Management.Batch.IBatchAccountOperations * string * string * Microsoft.Azure.Management.Batch.Models.AccountKeyType -> Microsoft.Azure.Management.Batch.Models.BatchAccountKeys

<Extension()>
Public Function RegenerateKey (operations As IBatchAccountOperations, resourceGroupName As String, accountName As String, keyName As AccountKeyType) As 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'

Returns

BatchAccountKeys

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

Share via