accounts

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

Overview

Name	accounts
Type	Resource
Id	azure.automation.accounts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
etag	string	Gets or sets the etag of the resource.
identity	object	Identity for the resource.
location	string	The Azure Region where the resource lives
properties	object	Gets or sets the automation account properties.
systemData	object	Resource system metadata.
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
etag	string	Gets or sets the etag of the resource.
identity	object	Identity for the resource.
location	string	The Azure Region where the resource lives
properties	object	Gets or sets the automation account properties.
systemData	object	Resource system metadata.
tags	object	Resource tags.

list

Name	Datatype	Description
etag	string	Gets or sets the etag of the resource.
identity	object	Identity for the resource.
location	string	The Azure Region where the resource lives
properties	object	Gets or sets the automation account properties.
systemData	object	Resource system metadata.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, automationAccountName, subscriptionId		Get information about an Automation Account.
list_by_resource_group	select	resourceGroupName, subscriptionId		Retrieve a list of accounts within a given resource group.
list	select	subscriptionId		Retrieve a list of accounts within a given subscription.
create_or_update	insert	resourceGroupName, automationAccountName, subscriptionId		Create or update automation account.
update	update	resourceGroupName, automationAccountName, subscriptionId		Update an automation account.
delete	delete	resourceGroupName, automationAccountName, subscriptionId		Delete 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
automationAccountName	string	The name of the automation account.
resourceGroupName	string	Name of an Azure Resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Get information about an Automation Account.

SELECT
etag,
identity,
location,
properties,
systemData,
tags
FROM azure.automation.accounts
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Retrieve a list of accounts within a given resource group.

SELECT
etag,
identity,
location,
properties,
systemData,
tags
FROM azure.automation.accounts
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Retrieve a list of accounts within a given subscription.

SELECT
etag,
identity,
location,
properties,
systemData,
tags
FROM azure.automation.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update automation account.

INSERT INTO azure.automation.accounts (
data__properties,
data__name,
data__location,
data__identity,
data__tags,
resourceGroupName,
automationAccountName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ location }}',
'{{ identity }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ automationAccountName }}',
'{{ subscriptionId }}'
RETURNING
etag,
identity,
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: accounts
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the accounts resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the accounts resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the accounts resource.
    - name: properties
      value: object
      description: |
        Gets or sets account create or update properties.
    - name: name
      value: string
      description: |
        Gets or sets name of the resource.
    - name: location
      value: string
      description: |
        Gets or sets the location of the resource.
    - name: identity
      value: object
      description: |
        Identity for the resource.
    - name: tags
      value: object
      description: |
        Gets or sets the tags attached to the resource.

UPDATE examples

update

Update an automation account.

UPDATE azure.automation.accounts
SET 
data__properties = '{{ properties }}',
data__name = '{{ name }}',
data__location = '{{ location }}',
data__identity = '{{ identity }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
etag,
identity,
location,
properties,
systemData,
tags;

DELETE examples

delete

Delete an automation account.

DELETE FROM azure.automation.accounts
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;