Microsoft.Automation automationAccounts 2021-06-22
Bicep resource definition
The automationAccounts 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.Automation/automationAccounts resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Automation/automationAccounts@2021-06-22' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
disableLocalAuth: bool
encryption: {
identity: {
userAssignedIdentity: any()
}
keySource: 'string'
keyVaultProperties: {
keyName: 'string'
keyvaultUri: 'string'
keyVersion: 'string'
}
}
publicNetworkAccess: bool
sku: {
capacity: int
family: 'string'
name: 'string'
}
}
}
Property values
automationAccounts
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 6-50 Valid characters: Alphanumerics and hyphens. Start with letter and end with alphanumeric. |
| location | Gets or sets the location of the resource. | string |
| tags | Gets or sets the tags attached to the resource. | Dictionary of tag names and values. See Tags in templates |
| identity | Sets the identity property for automation account | Identity |
| properties | Gets or sets account create or update properties. | AutomationAccountCreateOrUpdatePropertiesOrAutomatio... |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | ComponentsSgqdofSchemasIdentityPropertiesUserassigne... |
ComponentsSgqdofSchemasIdentityPropertiesUserassigne...
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
AutomationAccountCreateOrUpdatePropertiesOrAutomatio...
| Name | Description | Value |
|---|---|---|
| disableLocalAuth | Indicates whether requests using non-AAD authentication are blocked | bool |
| encryption | Set the encryption properties for the automation account | EncryptionProperties |
| publicNetworkAccess | Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet | bool |
| sku | Gets or sets account SKU. | Sku |
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| identity | User identity used for CMK. | EncryptionPropertiesIdentity |
| keySource | Encryption Key Source | 'Microsoft.Automation' 'Microsoft.Keyvault' |
| keyVaultProperties | Key vault properties. | KeyVaultProperties |
EncryptionPropertiesIdentity
| Name | Description | Value |
|---|---|---|
| userAssignedIdentity | The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | For Bicep, you can use the any() function. |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of key used to encrypt data. | string |
| keyvaultUri | The URI of the key vault key used to encrypt data. | string |
| keyVersion | The key version of the key used to encrypt data. | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Gets or sets the SKU capacity. | int |
| family | Gets or sets the SKU family. | string |
| name | Gets or sets the SKU name of the account. | 'Basic' 'Free' (required) |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
ASR Runbooks |
Deploys Automation Runbooks for ASR Recovery Plans |
| OMS ASR Solution |
Enables the ASR (v2) Solution in OMS |
| Azure Resource Optimization (ARO) Toolkit |
The Azure Resource Optimization Toolkit is a decentralized, native Azure solution using serverless technologies to optimize Azure resources on your subscription. Optimization happens automatically on your subscription once you enable or create your own schedule, including on new resources. This is an Azure Automation account with preconfigured runbooks and schedules you can utilize on your subscription to start saving money. |
| OMS - Azure Resource Usage Solution |
Solution brings billing infortmation about Azure Resources into OMS. Cost of resources can be displayed in different currency and locale. |
| OMS - Azure VM Inventory Solution |
Enables Azure VM Inventory Solution in OMS. Solution collects Azure VM inventory along with disks, networking components, NSG rules and extensions into OMS workspace. |
| OMS Solution - Hyper-V Replica |
A template for creating an OMS solution to monitor Hyper-V replica. |
| OMS Service Bus Solution |
Monitors Azure Service Bus instances |
| OMS VMM Analytics |
Provides a single view of the jobs' status across multiple VMM instances that helps you gain insight about the health & performance of these jobs. |
| Create Azure Automation account |
This template provides an example of how create an Azure Automation account and links it to a new or existing Azure Monitor Log Analytics workspace. |
ARM template resource definition
The automationAccounts 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.Automation/automationAccounts resource, add the following JSON to your template.
{
"type": "Microsoft.Automation/automationAccounts",
"apiVersion": "2021-06-22",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"disableLocalAuth": "bool",
"encryption": {
"identity": {
"userAssignedIdentity": {}
},
"keySource": "string",
"keyVaultProperties": {
"keyName": "string",
"keyvaultUri": "string",
"keyVersion": "string"
}
},
"publicNetworkAccess": "bool",
"sku": {
"capacity": "int",
"family": "string",
"name": "string"
}
}
}
Property values
automationAccounts
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Automation/automationAccounts' |
| apiVersion | The resource api version | '2021-06-22' |
| name | The resource name | string (required) Character limit: 6-50 Valid characters: Alphanumerics and hyphens. Start with letter and end with alphanumeric. |
| location | Gets or sets the location of the resource. | string |
| tags | Gets or sets the tags attached to the resource. | Dictionary of tag names and values. See Tags in templates |
| identity | Sets the identity property for automation account | Identity |
| properties | Gets or sets account create or update properties. | AutomationAccountCreateOrUpdatePropertiesOrAutomatio... |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
| userAssignedIdentities | The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | IdentityUserAssignedIdentities |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | ComponentsSgqdofSchemasIdentityPropertiesUserassigne... |
ComponentsSgqdofSchemasIdentityPropertiesUserassigne...
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
AutomationAccountCreateOrUpdatePropertiesOrAutomatio...
| Name | Description | Value |
|---|---|---|
| disableLocalAuth | Indicates whether requests using non-AAD authentication are blocked | bool |
| encryption | Set the encryption properties for the automation account | EncryptionProperties |
| publicNetworkAccess | Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet | bool |
| sku | Gets or sets account SKU. | Sku |
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| identity | User identity used for CMK. | EncryptionPropertiesIdentity |
| keySource | Encryption Key Source | 'Microsoft.Automation' 'Microsoft.Keyvault' |
| keyVaultProperties | Key vault properties. | KeyVaultProperties |
EncryptionPropertiesIdentity
| Name | Description | Value |
|---|---|---|
| userAssignedIdentity | The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of key used to encrypt data. | string |
| keyvaultUri | The URI of the key vault key used to encrypt data. | string |
| keyVersion | The key version of the key used to encrypt data. | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Gets or sets the SKU capacity. | int |
| family | Gets or sets the SKU family. | string |
| name | Gets or sets the SKU name of the account. | 'Basic' 'Free' (required) |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| ASR Runbooks |
Deploys Automation Runbooks for ASR Recovery Plans |
| OMS ASR Solution |
Enables the ASR (v2) Solution in OMS |
| Azure Resource Optimization (ARO) Toolkit |
The Azure Resource Optimization Toolkit is a decentralized, native Azure solution using serverless technologies to optimize Azure resources on your subscription. Optimization happens automatically on your subscription once you enable or create your own schedule, including on new resources. This is an Azure Automation account with preconfigured runbooks and schedules you can utilize on your subscription to start saving money. |
| OMS - Azure Resource Usage Solution |
Solution brings billing infortmation about Azure Resources into OMS. Cost of resources can be displayed in different currency and locale. |
| OMS - Azure VM Inventory Solution |
Enables Azure VM Inventory Solution in OMS. Solution collects Azure VM inventory along with disks, networking components, NSG rules and extensions into OMS workspace. |
| OMS Solution - Hyper-V Replica |
A template for creating an OMS solution to monitor Hyper-V replica. |
| OMS Service Bus Solution |
Monitors Azure Service Bus instances |
| OMS VMM Analytics |
Provides a single view of the jobs' status across multiple VMM instances that helps you gain insight about the health & performance of these jobs. |
| Create Azure Automation account |
This template provides an example of how create an Azure Automation account and links it to a new or existing Azure Monitor Log Analytics workspace. |
Terraform (AzAPI provider) resource definition
The automationAccounts 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.Automation/automationAccounts resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Automation/automationAccounts@2021-06-22"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
disableLocalAuth = bool
encryption = {
identity = {}
keySource = "string"
keyVaultProperties = {
keyName = "string"
keyvaultUri = "string"
keyVersion = "string"
}
}
publicNetworkAccess = bool
sku = {
capacity = int
family = "string"
name = "string"
}
}
})
}
Property values
automationAccounts
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Automation/automationAccounts@2021-06-22" |
| name | The resource name | string (required) Character limit: 6-50 Valid characters: Alphanumerics and hyphens. Start with letter and end with alphanumeric. |
| location | Gets or sets the location of the resource. | string |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Gets or sets the tags attached to the resource. | Dictionary of tag names and values. |
| identity | Sets the identity property for automation account | Identity |
| properties | Gets or sets account create or update properties. | AutomationAccountCreateOrUpdatePropertiesOrAutomatio... |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" |
| identity_ids | The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | Array of user identity IDs. |
IdentityUserAssignedIdentities
| Name | Description | Value |
|---|---|---|
| {customized property} | ComponentsSgqdofSchemasIdentityPropertiesUserassigne... |
ComponentsSgqdofSchemasIdentityPropertiesUserassigne...
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
AutomationAccountCreateOrUpdatePropertiesOrAutomatio...
| Name | Description | Value |
|---|---|---|
| disableLocalAuth | Indicates whether requests using non-AAD authentication are blocked | bool |
| encryption | Set the encryption properties for the automation account | EncryptionProperties |
| publicNetworkAccess | Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet | bool |
| sku | Gets or sets account SKU. | Sku |
EncryptionProperties
| Name | Description | Value |
|---|---|---|
| identity | User identity used for CMK. | EncryptionPropertiesIdentity |
| keySource | Encryption Key Source | "Microsoft.Automation" "Microsoft.Keyvault" |
| keyVaultProperties | Key vault properties. | KeyVaultProperties |
EncryptionPropertiesIdentity
| Name | Description | Value |
|---|---|---|
| userAssignedIdentity | The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The name of key used to encrypt data. | string |
| keyvaultUri | The URI of the key vault key used to encrypt data. | string |
| keyVersion | The key version of the key used to encrypt data. | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Gets or sets the SKU capacity. | int |
| family | Gets or sets the SKU family. | string |
| name | Gets or sets the SKU name of the account. | "Basic" "Free" (required) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for