connection_types

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

Overview

Name	connection_types
Type	Resource
Id	azure.automation.connection_types

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Gets the id of the resource.
name	string	Gets the name of the connection type.
properties	object	Gets or sets the properties of the connection type.
type	string	Resource type

list_by_automation_account

Name	Datatype	Description
id	string	Gets the id of the resource.
name	string	Gets the name of the connection type.
properties	object	Gets or sets the properties of the connection type.
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, automationAccountName, connectionTypeName, subscriptionId		Retrieve the connection type identified by connection type name.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId		Retrieve a list of connection types.
create_or_update	insert	resourceGroupName, automationAccountName, connectionTypeName, subscriptionId, data__name, data__properties		Create a connection type.
delete	delete	resourceGroupName, automationAccountName, connectionTypeName, subscriptionId		Delete the connection type.

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.
connectionTypeName	string	The name of connection type.
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 type identified by connection type name.

SELECT
id,
name,
properties,
type
FROM azure.automation.connection_types
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND connectionTypeName = '{{ connectionTypeName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_automation_account

Retrieve a list of connection types.

SELECT
id,
name,
properties,
type
FROM azure.automation.connection_types
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a connection type.

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

Manifest

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

DELETE examples

delete

Delete the connection type.

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