The following tables describe the values you need to set in the schema.
Microsoft.Batch/batchAccounts object
Name
Type
Required
Value
name
string
Yes
A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: https://accountname.region.batch.azure.com/. Min length: 3 Max length: 24
type
enum
Yes
Microsoft.Batch/batchAccounts
apiVersion
enum
Yes
2020-09-01
location
string
Yes
The region in which to create the account.
tags
object
No
The user-specified tags associated with the account.
The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService. - BatchService or UserSubscription
keyVaultReference
object
No
A reference to the Azure key vault associated with the Batch account. - KeyVaultReference object
publicNetworkAccess
enum
No
If not specified, the default value is 'enabled'. - Enabled or Disabled
encryption
object
No
Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. - EncryptionProperties object
BatchAccountIdentity object
Name
Type
Required
Value
type
enum
Yes
The type of identity used for the Batch account. - SystemAssigned or None
AutoStorageBaseProperties object
Name
Type
Required
Value
storageAccountId
string
Yes
The resource ID of the storage account to be used for auto-storage account.
KeyVaultReference object
Name
Type
Required
Value
id
string
Yes
The resource ID of the Azure key vault associated with the Batch account.
url
string
Yes
The URL of the Azure key vault associated with the Batch account.
EncryptionProperties object
Name
Type
Required
Value
keySource
enum
No
Type of the key source. - Microsoft.Batch or Microsoft.KeyVault
Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met: The Batch Account has a System Assigned identity The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions The KeyVault has soft-delete and purge protection enabled
Quickstart templates
The following quickstart templates deploy this resource type.