automation_account

Creates, updates, deletes, gets or lists an automation_account resource.

Overview

Name	automation_account
Type	Resource
Id	azure.automation.automation_account

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
automationHybridServiceUrl	string	URL of automation hybrid service which is used for hybrid worker on-boarding.
creationTime	string (date-time)	Gets the creation time.
description	string	Gets or sets the description.
disableLocalAuth	boolean	Indicates whether requests using non-AAD authentication are blocked.
encryption	object	Encryption properties for the automation account.
etag	string	Gets or sets the etag of the resource.
identity	object	Identity for the resource.
lastModifiedBy	string	Gets or sets the last modified by.
lastModifiedTime	string (date-time)	Gets the last modified time.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of Automation operations supported by the Automation resource provider.
publicNetworkAccess	boolean	Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet.
sku	object	Gets or sets the SKU of account.
state	string	Gets status of account. Known values are: "Ok", "Unavailable", and "Suspended". (Ok, Unavailable, Suspended)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
automationHybridServiceUrl	string	URL of automation hybrid service which is used for hybrid worker on-boarding.
creationTime	string (date-time)	Gets the creation time.
description	string	Gets or sets the description.
disableLocalAuth	boolean	Indicates whether requests using non-AAD authentication are blocked.
encryption	object	Encryption properties for the automation account.
etag	string	Gets or sets the etag of the resource.
identity	object	Identity for the resource.
lastModifiedBy	string	Gets or sets the last modified by.
lastModifiedTime	string (date-time)	Gets the last modified time.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of Automation operations supported by the Automation resource provider.
publicNetworkAccess	boolean	Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet.
sku	object	Gets or sets the SKU of account.
state	string	Gets status of account. Known values are: "Ok", "Unavailable", and "Suspended". (Ok, Unavailable, Suspended)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
automationHybridServiceUrl	string	URL of automation hybrid service which is used for hybrid worker on-boarding.
creationTime	string (date-time)	Gets the creation time.
description	string	Gets or sets the description.
disableLocalAuth	boolean	Indicates whether requests using non-AAD authentication are blocked.
encryption	object	Encryption properties for the automation account.
etag	string	Gets or sets the etag of the resource.
identity	object	Identity for the resource.
lastModifiedBy	string	Gets or sets the last modified by.
lastModifiedTime	string (date-time)	Gets the last modified time.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	List of Automation operations supported by the Automation resource provider.
publicNetworkAccess	boolean	Indicates whether traffic on the non-ARM endpoint (Webhook/Agent) is allowed from the public internet.
sku	object	Gets or sets the SKU of account.
state	string	Gets status of account. Known values are: "Ok", "Unavailable", and "Suspended". (Ok, Unavailable, Suspended)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, automation_account_name, subscription_id		Get information about an Automation Account.
list_by_resource_group	select	resource_group_name, subscription_id		Retrieve a list of accounts within a given resource group.
list	select	subscription_id		Lists the Automation Accounts within an Azure subscription. Retrieve a list of accounts within a given subscription.
create_or_update	insert	resource_group_name, automation_account_name, subscription_id		Create or update automation account.
update	update	resource_group_name, automation_account_name, subscription_id		Update an automation account.
create_or_update	replace	resource_group_name, automation_account_name, subscription_id		Create or update automation account.
delete	delete	resource_group_name, automation_account_name, subscription_id		Delete an automation account.
list_deleted_runbooks	exec	resource_group_name, automation_account_name, subscription_id		Retrieve the deleted runbooks for an automation account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
automation_account_name	string	The name of the automation account. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get information about an Automation Account.

SELECT
id,
name,
automationHybridServiceUrl,
creationTime,
description,
disableLocalAuth,
encryption,
etag,
identity,
lastModifiedBy,
lastModifiedTime,
location,
privateEndpointConnections,
publicNetworkAccess,
sku,
state,
systemData,
tags,
type
FROM azure.automation.automation_account
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Retrieve a list of accounts within a given resource group.

SELECT
id,
name,
automationHybridServiceUrl,
creationTime,
description,
disableLocalAuth,
encryption,
etag,
identity,
lastModifiedBy,
lastModifiedTime,
location,
privateEndpointConnections,
publicNetworkAccess,
sku,
state,
systemData,
tags,
type
FROM azure.automation.automation_account
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists the Automation Accounts within an Azure subscription. Retrieve a list of accounts within a given subscription.

SELECT
id,
name,
automationHybridServiceUrl,
creationTime,
description,
disableLocalAuth,
encryption,
etag,
identity,
lastModifiedBy,
lastModifiedTime,
location,
privateEndpointConnections,
publicNetworkAccess,
sku,
state,
systemData,
tags,
type
FROM azure.automation.automation_account
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update automation account.

INSERT INTO azure.automation.automation_account (
properties,
name,
location,
identity,
tags,
resource_group_name,
automation_account_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ location }}',
'{{ identity }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ automation_account_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: automation_account
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the automation_account resource.
  - name: automation_account_name
    value: "{{ automation_account_name }}"
    description: Required parameter for the automation_account resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the automation_account resource.
  - name: properties
    description: |
      Gets or sets account create or update properties.
    value:
      sku:
        name: "{{ name }}"
        family: "{{ family }}"
        capacity: {{ capacity }}
      encryption:
        keyVaultProperties:
          keyvaultUri: "{{ keyvaultUri }}"
          keyName: "{{ keyName }}"
          keyVersion: "{{ keyVersion }}"
        keySource: "{{ keySource }}"
        identity:
          userAssignedIdentity: "{{ userAssignedIdentity }}"
      publicNetworkAccess: {{ publicNetworkAccess }}
      disableLocalAuth: {{ disableLocalAuth }}
  - name: name
    value: "{{ name }}"
    description: |
      Gets or sets name of the resource.
  - name: location
    value: "{{ location }}"
    description: |
      Gets or sets the location of the resource.
  - name: identity
    description: |
      Sets the identity property for automation account.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Gets or sets the tags attached to the resource.

UPDATE examples

update

Update an automation account.

UPDATE azure.automation.automation_account
SET 
properties = '{{ properties }}',
name = '{{ name }}',
location = '{{ location }}',
identity = '{{ identity }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update automation account.

REPLACE azure.automation.automation_account
SET 
properties = '{{ properties }}',
name = '{{ name }}',
location = '{{ location }}',
identity = '{{ identity }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete an automation account.

DELETE FROM azure.automation.automation_account
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_deleted_runbooks

Retrieve the deleted runbooks for an automation account.

EXEC azure.automation.automation_account.list_deleted_runbooks 
@resource_group_name='{{ resource_group_name }}' --required, 
@automation_account_name='{{ automation_account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;