Skip to main content

account

Overview

Nameaccount
TypeResource
Idazure.batch.account

Fields

NameDatatypeDescription
idstringThe ID of the resource.
namestringThe name of the resource.
identityobjectThe identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when ManagedIdentity is selected as the auto-storage authentication mode.
locationstringThe location of the resource.
propertiesobjectAccount specific properties.
tagsobjectThe tags of the resource.
typestringThe type of the resource.

Methods

NameAccessible byRequired ParamsDescription
getSELECTaccountName, resourceGroupName, subscriptionIdGets information about the specified Batch account.
listSELECTsubscriptionIdGets information about the Batch accounts associated with the subscription.
list_by_resource_groupSELECTresourceGroupName, subscriptionIdGets information about the Batch accounts associated with the specified resource group.
createINSERTaccountName, resourceGroupName, subscriptionId, data__locationCreates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
deleteDELETEaccountName, resourceGroupName, subscriptionIdDeletes the specified Batch account.
_listEXECsubscriptionIdGets information about the Batch accounts associated with the subscription.
_list_by_resource_groupEXECresourceGroupName, subscriptionIdGets information about the Batch accounts associated with the specified resource group.
regenerate_keyEXECaccountName, resourceGroupName, subscriptionId, data__keyNameThis 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.
synchronize_auto_storage_keysEXECaccountName, resourceGroupName, subscriptionIdSynchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.
updateEXECaccountName, resourceGroupName, subscriptionIdUpdates the properties of an existing Batch account.