connections

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

Overview

Name	connections
Type	Resource
Id	azure.automation.connections

Fields

The following fields are returned by SELECT queries:

get

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

list_by_automation_account

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

Methods

The following methods are available for this resource:

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

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.
connectionName	string	The name of connection.
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

Retrieve the connection identified by connection name.

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

list_by_automation_account

Retrieve a list of connections.

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

INSERT examples

create_or_update

Create or update a connection.

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

Manifest

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

UPDATE examples

update

Update a connection.

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

DELETE examples

delete

Delete the connection.

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