Microsoft.Batch batchAccounts 2015-12-01

Bicep resource definition

The batchAccounts resource type can be deployed with operations that target:

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@2015-12-01' = {
  location: 'string'
  name: 'string'
  properties: {
    autoStorage: {
      storageAccountId: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

AutoStorageBasePropertiesOrAutoStorageProperties

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

BatchAccountBasePropertiesOrBatchAccountProperties

Name Description Value
autoStorage The properties related to auto storage account. AutoStorageBasePropertiesOrAutoStorageProperties

BatchAccountCreateParametersTags

Name Description Value

Microsoft.Batch/batchAccounts

Name Description Value
location The region in which to create the account. string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 24
Pattern = ^[-\w\._]+$ (required)
properties The properties of the account. BatchAccountBasePropertiesOrBatchAccountProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Batch Account AVM Resource Module for Batch Account

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Azure Batch pool without public IP addresses This template creates Azure Batch simplified node communication pool without public IP addresses.
Create a Batch Account using a template This template creates a Batch Account and a storage account.

ARM template resource definition

The batchAccounts resource type can be deployed with operations that target:

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": "2015-12-01",
  "name": "string",
  "location": "string",
  "properties": {
    "autoStorage": {
      "storageAccountId": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

AutoStorageBasePropertiesOrAutoStorageProperties

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

BatchAccountBasePropertiesOrBatchAccountProperties

Name Description Value
autoStorage The properties related to auto storage account. AutoStorageBasePropertiesOrAutoStorageProperties

BatchAccountCreateParametersTags

Name Description Value

Microsoft.Batch/batchAccounts

Name Description Value
apiVersion The api version '2015-12-01'
location The region in which to create the account. string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 24
Pattern = ^[-\w\._]+$ (required)
properties The properties of the account. BatchAccountBasePropertiesOrBatchAccountProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Batch/batchAccounts'

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Azure Batch pool without public IP addresses

Deploy to Azure
This template creates Azure Batch simplified node communication pool without public IP addresses.
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 with operations that target:

  • 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@2015-12-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      autoStorage = {
        storageAccountId = "string"
      }
    }
  })
}

Property Values

AutoStorageBasePropertiesOrAutoStorageProperties

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

BatchAccountBasePropertiesOrBatchAccountProperties

Name Description Value
autoStorage The properties related to auto storage account. AutoStorageBasePropertiesOrAutoStorageProperties

BatchAccountCreateParametersTags

Name Description Value

Microsoft.Batch/batchAccounts

Name Description Value
location The region in which to create the account. string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 24
Pattern = ^[-\w\._]+$ (required)
properties The properties of the account. BatchAccountBasePropertiesOrBatchAccountProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Batch/batchAccounts@2015-12-01"

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Batch Account AVM Resource Module for Batch Account