Microsoft.Automation automationAccounts 2023-11-01
Article 12/09/2024
2 contributors
Feedback
In this article
Bicep resource definition
The automationAccounts resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Automation/automationAccounts resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Automation/automationAccounts@2023-11-01' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
disableLocalAuth: bool
encryption: {
identity: {
userAssignedIdentity: any(Azure.Bicep.Types.Concrete.AnyType)
}
keySource: 'string'
keyVaultProperties: {
keyName: 'string'
keyvaultUri: 'string'
keyVersion: 'string'
}
}
publicNetworkAccess: bool
sku: {
capacity: int
family: 'string'
name: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property values
AutomationAccountCreateOrUpdatePropertiesOrAutomationAccountProperties
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
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}'.
any
Identity
Name
Description
Value
type
The identity type.
'None'
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
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
Microsoft.Automation/automationAccounts
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'
UserAssignedIdentitiesProperties
Quickstart samples
The following quickstart samples deploy this resource type.
Bicep File
Description
ASR Runbooks Deploys Automation Runbooks for ASR Recovery Plans
ARM template resource definition
The automationAccounts resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Automation/automationAccounts resource, add the following JSON to your template.
{
"type": "Microsoft.Automation/automationAccounts",
"apiVersion": "2023-11-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"disableLocalAuth": "bool",
"encryption": {
"identity": {
"userAssignedIdentity": {}
},
"keySource": "string",
"keyVaultProperties": {
"keyName": "string",
"keyvaultUri": "string",
"keyVersion": "string"
}
},
"publicNetworkAccess": "bool",
"sku": {
"capacity": "int",
"family": "string",
"name": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property values
AutomationAccountCreateOrUpdatePropertiesOrAutomationAccountProperties
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
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}'.
any
Identity
Name
Description
Value
type
The identity type.
'None'
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
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
Microsoft.Automation/automationAccounts
Name
Description
Value
apiVersion
The api version
'2023-11-01'
identity
Sets the identity property for automation account
Identity
location
Gets or sets the location of the resource.
string
name
The resource name
string (required)
properties
Gets or sets account create or update properties.
AutomationAccountCreateOrUpdatePropertiesOrAutomationAccountProperties
tags
Resource tags
Dictionary of tag names and values. See Tags in templates
type
The resource type
'Microsoft.Automation/automationAccounts'
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'
UserAssignedIdentitiesProperties
Quickstart templates
The following quickstart templates deploy this resource type.
Template
Description
ASR Runbooks Deploys Automation Runbooks for ASR Recovery Plans
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.
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.
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 ASR Solution Enables the ASR (v2) Solution in OMS
OMS Service Bus Solution Monitors Azure Service Bus instances
OMS Solution - Hyper-V Replica A template for creating an OMS solution to monitor Hyper-V replica.
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.
The automationAccounts resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Automation/automationAccounts resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Automation/automationAccounts@2023-11-01"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
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
AutomationAccountCreateOrUpdatePropertiesOrAutomationAccountProperties
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
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}'.
any
Identity
Name
Description
Value
type
The identity type.
'None'
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
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
Microsoft.Automation/automationAccounts
Name
Description
Value
identity
Sets the identity property for automation account
Identity
location
Gets or sets the location of the resource.
string
name
The resource name
string (required)
properties
Gets or sets account create or update properties.
AutomationAccountCreateOrUpdatePropertiesOrAutomationAccountProperties
tags
Resource tags
Dictionary of tag names and values.
type
The resource type
"Microsoft.Automation/automationAccounts@2023-11-01"
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'
UserAssignedIdentitiesProperties
