connection

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

Overview

Name	connection
Type	Resource
Id	azure.automation.connection

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.
connectionType	object	Gets or sets the connectionType of the connection.
creationTime	string (date-time)	Gets the creation time.
description	string	Gets or sets the description.
fieldDefinitionValues	object	Gets the field definition values of the connection.
lastModifiedTime	string (date-time)	Gets the last modified time.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_automation_account

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.
connectionType	object	Gets or sets the connectionType of the connection.
creationTime	string (date-time)	Gets the creation time.
description	string	Gets or sets the description.
fieldDefinitionValues	object	Gets the field definition values of the connection.
lastModifiedTime	string (date-time)	Gets the last modified time.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, connection_name, subscription_id		Retrieve the connection identified by connection name.
list_by_automation_account	select	resource_group_name, automation_account_name, subscription_id		Retrieve a list of connections.
create_or_update	insert	resource_group_name, automation_account_name, connection_name, subscription_id, name, properties		Create or update a connection.
update	update	resource_group_name, automation_account_name, connection_name, subscription_id		Update a connection.
create_or_update	replace	resource_group_name, automation_account_name, connection_name, subscription_id, name, properties		Create or update a connection.
delete	delete	resource_group_name, automation_account_name, connection_name, subscription_id		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
automation_account_name	string	The name of the automation account. Required.
connection_name	string	The name of connection. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Retrieve the connection identified by connection name.

SELECT
id,
name,
connectionType,
creationTime,
description,
fieldDefinitionValues,
lastModifiedTime,
systemData,
type
FROM azure.automation.connection
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND connection_name = '{{ connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_automation_account

Retrieve a list of connections.

SELECT
id,
name,
connectionType,
creationTime,
description,
fieldDefinitionValues,
lastModifiedTime,
systemData,
type
FROM azure.automation.connection
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a connection.

INSERT INTO azure.automation.connection (
name,
properties,
resource_group_name,
automation_account_name,
connection_name,
subscription_id
)
SELECT 
'{{ name }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ automation_account_name }}',
'{{ connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: connection
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the connection resource.
  - name: automation_account_name
    value: "{{ automation_account_name }}"
    description: Required parameter for the connection resource.
  - name: connection_name
    value: "{{ connection_name }}"
    description: Required parameter for the connection resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the connection resource.
  - name: name
    value: "{{ name }}"
    description: |
      Gets or sets the name of the connection. Required.
  - name: properties
    description: |
      Gets or sets the properties of the connection. Required.
    value:
      description: "{{ description }}"
      connectionType:
        name: "{{ name }}"
      fieldDefinitionValues: "{{ fieldDefinitionValues }}"

UPDATE examples

update

Update a connection.

UPDATE azure.automation.connection
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or update a connection.

REPLACE azure.automation.connection
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND name = '{{ name }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete the connection.

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