Microsoft.Batch batchAccounts 2020-03-01

  • Article
  • 2 minutes to read

The batchAccounts resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Batch/batchAccounts resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Batch/batchAccounts@2020-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    autoStorage: {
      storageAccountId: 'string'
    }
    encryption: {
      keySource: 'string'
      keyVaultProperties: {
        keyIdentifier: 'string'
      }
    }
    keyVaultReference: {
      id: 'string'
      url: 'string'
    }
    poolAllocationMode: 'string'
    publicNetworkAccess: 'string'
  }
}

Property values

batchAccounts

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.		 'Microsoft.Batch/batchAccounts'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.		 '2020-03-01'
name The resource name string (required)
location The region in which to create the account. string (required)
tags The user-specified tags associated with the account. Dictionary of tag names and values. See Tags in templates
properties The properties of a Batch account. BatchAccountCreateProperties

BatchAccountCreateProperties

Name Description Value
autoStorage The properties related to the auto-storage account. AutoStorageBaseProperties
encryption EncryptionProperties
keyVaultReference Identifies the Azure key vault associated with a Batch account. KeyVaultReference
poolAllocationMode The allocation mode for creating pools in the Batch account. 'BatchService'
'UserSubscription'
publicNetworkAccess The network access type for operating on the resources in the Batch account. 'Disabled'
'Enabled'

AutoStorageBaseProperties

Name Description Value
storageAccountId The resource ID of the storage account to be used for auto-storage account. string (required)

EncryptionProperties

Name Description Value
keySource Type of the key source. 'Microsoft.Batch'
'Microsoft.KeyVault'
keyVaultProperties KeyVaultProperties

KeyVaultProperties

Name Description Value
keyIdentifier Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053 string

KeyVaultReference

Name Description Value
id The resource ID of the Azure key vault associated with the Batch account. string (required)
url The URL of the Azure key vault associated with the Batch account. string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a Batch Account using a template

Deploy to Azure		 This template creates a Batch Account and a storage account.