IBatchAccountOperations.RegenerateKeyWithHttpMessagesAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Management.Batch
Assembly:
Microsoft.Azure.Management.Batch.dll
Package:
Microsoft.Azure.Management.Batch v15.0.0

Regenerates the specified account key for the Batch account.

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

Parameters

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'

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<BatchAccountKeys>>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

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