Microsoft.Batch batchAccounts 2017-01-01
Template format
To create a Microsoft.Batch/batchAccounts resource, add the following JSON to the resources section of your template.
{
"name": "string",
"type": "Microsoft.Batch/batchAccounts",
"apiVersion": "2017-01-01",
"location": "string",
"tags": {},
"properties": {
"autoStorage": {
"storageAccountId": "string"
},
"poolAllocationMode": "string",
"keyVaultReference": {
"id": "string",
"url": "string"
}
},
"resources": []
}
Property values
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 | 2017-01-01 |
| location | string | Yes | The region in which to create the account. |
| tags | object | No | The user specified tags associated with the account. |
| properties | object | Yes | The properties of the Batch account. - BatchAccountBaseProperties object |
| resources | array | No | applications |
BatchAccountBaseProperties object
| Name | Type | Required | Value |
|---|---|---|---|
| autoStorage | object | No | The properties related to auto storage account. - AutoStorageBaseProperties object |
| poolAllocationMode | enum | No | 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 |
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. |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create a Batch Account using a template |
This template creates a Batch Account and a storage account. |