Microsoft.Batch batchAccounts 2019-08-01

Bicep resource definition

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

To learn about resource group deployments, see Bicep.

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.Batch/batchAccounts@2019-08-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    autoStorage: {
      storageAccountId: 'string'
    }
    keyVaultReference: {
      id: 'string'
      url: 'string'
    }
    poolAllocationMode: 'string'
  }
}

Property values

batchAccounts

Name Description Value
name The resource name string (required)

Character limit: 3-24

Valid characters:
Lowercase letters and numbers.
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 the Batch account. BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountCreatePropertiesOrBatchAccountProperties

Name Description Value
autoStorage The properties related to the auto-storage account. AutoStorageBasePropertiesOrAutoStorageProperties
keyVaultReference A reference to the Azure key vault associated with the Batch account. KeyVaultReference
poolAllocationMode 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'
'UserSubscription'

AutoStorageBasePropertiesOrAutoStorageProperties

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

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.

ARM template resource definition

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

To learn about resource group deployments, see ARM template.

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.Batch/batchAccounts",
  "apiVersion": "2019-08-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "autoStorage": {
      "storageAccountId": "string"
    },
    "keyVaultReference": {
      "id": "string",
      "url": "string"
    },
    "poolAllocationMode": "string"
  }
}

Property values

batchAccounts

Name Description Value
type The resource type 'Microsoft.Batch/batchAccounts'
apiVersion The resource api version '2019-08-01'
name The resource name string (required)

Character limit: 3-24

Valid characters:
Lowercase letters and numbers.
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 the Batch account. BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountCreatePropertiesOrBatchAccountProperties

Name Description Value
autoStorage The properties related to the auto-storage account. AutoStorageBasePropertiesOrAutoStorageProperties
keyVaultReference A reference to the Azure key vault associated with the Batch account. KeyVaultReference
poolAllocationMode 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'
'UserSubscription'

AutoStorageBasePropertiesOrAutoStorageProperties

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

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.

Terraform (AzAPI provider) resource definition

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

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Batch/batchAccounts@2019-08-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      autoStorage = {
        storageAccountId = "string"
      }
      keyVaultReference = {
        id = "string"
        url = "string"
      }
      poolAllocationMode = "string"
    }
  })
}

Property values

batchAccounts

Name Description Value
type The resource type "Microsoft.Batch/batchAccounts@2019-08-01"
name The resource name string (required)

Character limit: 3-24

Valid characters:
Lowercase letters and numbers.
location The region in which to create the account. string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags The user-specified tags associated with the account. Dictionary of tag names and values.
properties The properties of the Batch account. BatchAccountCreatePropertiesOrBatchAccountProperties

BatchAccountCreatePropertiesOrBatchAccountProperties

Name Description Value
autoStorage The properties related to the auto-storage account. AutoStorageBasePropertiesOrAutoStorageProperties
keyVaultReference A reference to the Azure key vault associated with the Batch account. KeyVaultReference
poolAllocationMode 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"
"UserSubscription"

AutoStorageBasePropertiesOrAutoStorageProperties

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

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)