Microsoft.Batch batchAccounts 2020-03-01
Bicep resource definition
The batchAccounts resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2020-03-01' = {
location: 'string'
name: 'string'
properties: {
autoStorage: {
storageAccountId: 'string'
}
encryption: {
keySource: 'string'
keyVaultProperties: {
keyIdentifier: 'string'
}
}
keyVaultReference: {
id: 'string'
url: 'string'
}
poolAllocationMode: 'string'
publicNetworkAccess: '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) |
BatchAccountCreateParametersTags
| Name | Description | Value |
|---|
BatchAccountCreatePropertiesOrBatchAccountProperties
| Name | Description | Value |
|---|---|---|
| autoStorage | The properties related to the auto-storage account. | AutoStorageBasePropertiesOrAutoStorageProperties |
| encryption | EncryptionProperties | |
| 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' |
| publicNetworkAccess | If not specified, the default value is 'enabled'. | 'Disabled' 'Enabled' |
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| keySource | Type of the key source. | 'Microsoft.Batch' 'Microsoft.KeyVault' |
| keyVaultProperties | Additional details when using Microsoft.KeyVault | 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) |
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 = 3 Pattern = ^[a-z0-9]+$ (required) |
| properties | The properties of the Batch account. | BatchAccountCreatePropertiesOrBatchAccountProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
Quickstart samples
The following quickstart samples deploy 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:
- Resource groups - See resource group deployment commands
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": "2020-03-01",
"name": "string",
"location": "string",
"properties": {
"autoStorage": {
"storageAccountId": "string"
},
"encryption": {
"keySource": "string",
"keyVaultProperties": {
"keyIdentifier": "string"
}
},
"keyVaultReference": {
"id": "string",
"url": "string"
},
"poolAllocationMode": "string",
"publicNetworkAccess": "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) |
BatchAccountCreateParametersTags
| Name | Description | Value |
|---|
BatchAccountCreatePropertiesOrBatchAccountProperties
| Name | Description | Value |
|---|---|---|
| autoStorage | The properties related to the auto-storage account. | AutoStorageBasePropertiesOrAutoStorageProperties |
| encryption | EncryptionProperties | |
| 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' |
| publicNetworkAccess | If not specified, the default value is 'enabled'. | 'Disabled' 'Enabled' |
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| keySource | Type of the key source. | 'Microsoft.Batch' 'Microsoft.KeyVault' |
| keyVaultProperties | Additional details when using Microsoft.KeyVault | 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) |
Microsoft.Batch/batchAccounts
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-03-01' |
| location | The region in which to create the account. | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 3 Pattern = ^[a-z0-9]+$ (required) |
| properties | The properties of the Batch account. | BatchAccountCreatePropertiesOrBatchAccountProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Batch/batchAccounts' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | 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. |
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@2020-03-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
autoStorage = {
storageAccountId = "string"
}
encryption = {
keySource = "string"
keyVaultProperties = {
keyIdentifier = "string"
}
}
keyVaultReference = {
id = "string"
url = "string"
}
poolAllocationMode = "string"
publicNetworkAccess = "string"
}
})
}
Property values
AutoStorageBasePropertiesOrAutoStorageProperties
| Name | Description | Value |
|---|---|---|
| storageAccountId | The resource ID of the storage account to be used for auto-storage account. | string (required) |
BatchAccountCreateParametersTags
| Name | Description | Value |
|---|
BatchAccountCreatePropertiesOrBatchAccountProperties
| Name | Description | Value |
|---|---|---|
| autoStorage | The properties related to the auto-storage account. | AutoStorageBasePropertiesOrAutoStorageProperties |
| encryption | EncryptionProperties | |
| 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' |
| publicNetworkAccess | If not specified, the default value is 'enabled'. | 'Disabled' 'Enabled' |
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| keySource | Type of the key source. | 'Microsoft.Batch' 'Microsoft.KeyVault' |
| keyVaultProperties | Additional details when using Microsoft.KeyVault | 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) |
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 = 3 Pattern = ^[a-z0-9]+$ (required) |
| properties | The properties of the Batch account. | BatchAccountCreatePropertiesOrBatchAccountProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Batch/batchAccounts@2020-03-01" |