Batch Account - Synchronize Auto Storage Keys

Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys?api-version=2024-07-01

URI Parameters

Name In Required Type Description
accountName
path True

string

The name of the Batch account.

Regex pattern: ^[a-zA-Z0-9]+$

resourceGroupName
path True

string

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

subscriptionId
path True

string

The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)

api-version
query True

string

The API version to be used with the HTTP request.

Responses

Name Type Description
204 No Content

The operation was successful.

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Microsoft Entra OAuth 2.0 auth code flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

BatchAccountSynchronizeAutoStorageKeys

Sample request

POST https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/syncAutoStorageKeys?api-version=2024-07-01

Sample response

Definitions

Name Description
CloudError

An error response from the Batch service.

CloudErrorBody

An error response from the Batch service.

CloudError

An error response from the Batch service.

Name Type Description
error

CloudErrorBody

The body of the error response.

CloudErrorBody

An error response from the Batch service.

Name Type Description
code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.