variables

Creates, updates, deletes, gets or lists a variables resource.

Overview

Name	variables
Type	Resource
Id	azure.automation.variables

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Gets or sets the properties of the variable.

list_by_automation_account

Name	Datatype	Description
properties	object	Gets or sets the properties of the variable.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, automationAccountName, variableName, subscriptionId		Retrieve the variable identified by variable name.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId		Retrieve a list of variables.
create_or_update	insert	resourceGroupName, automationAccountName, variableName, subscriptionId, data__name, data__properties		Create a variable.
update	update	resourceGroupName, automationAccountName, variableName, subscriptionId		Update a variable.
delete	delete	resourceGroupName, automationAccountName, variableName, subscriptionId		Delete the variable.

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.
variableName	string	The name of variable.

SELECT examples

get

Retrieve the variable identified by variable name.

SELECT
properties
FROM azure.automation.variables
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND variableName = '{{ variableName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_automation_account

Retrieve a list of variables.

SELECT
properties
FROM azure.automation.variables
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a variable.

INSERT INTO azure.automation.variables (
data__name,
data__properties,
resourceGroupName,
automationAccountName,
variableName,
subscriptionId
)
SELECT 
'{{ name }}' /* required */,
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ automationAccountName }}',
'{{ variableName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: variables
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the variables resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the variables resource.
    - name: variableName
      value: string
      description: Required parameter for the variables resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the variables resource.
    - name: name
      value: string
      description: |
        Gets or sets the name of the variable.
    - name: properties
      value: object
      description: |
        Gets or sets the properties of the variable.

UPDATE examples

update

Update a variable.

UPDATE azure.automation.variables
SET 
data__name = '{{ name }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND variableName = '{{ variableName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Delete the variable.

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