source_controls

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

Overview

Name	source_controls
Type	Resource
Id	azure.automation.source_controls

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The properties of the source control.

list_by_automation_account

Name	Datatype	Description
properties	object	The properties of the source control.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, automationAccountName, sourceControlName, subscriptionId		Retrieve the source control identified by source control name.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId	$filter	Retrieve a list of source controls.
create_or_update	insert	resourceGroupName, automationAccountName, sourceControlName, subscriptionId, data__properties		Create a source control.
update	update	resourceGroupName, automationAccountName, sourceControlName, subscriptionId		Update a source control.
delete	delete	resourceGroupName, automationAccountName, sourceControlName, subscriptionId		Delete the source control.

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.
sourceControlName	string	The name of source control.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$filter	string	The filter to apply on the operation.

SELECT examples

get

Retrieve the source control identified by source control name.

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

list_by_automation_account

Retrieve a list of source controls.

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

INSERT examples

create_or_update

Create a source control.

INSERT INTO azure.automation.source_controls (
data__properties,
resourceGroupName,
automationAccountName,
sourceControlName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ automationAccountName }}',
'{{ sourceControlName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: source_controls
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the source_controls resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the source_controls resource.
    - name: sourceControlName
      value: string
      description: Required parameter for the source_controls resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the source_controls resource.
    - name: properties
      value: object
      description: |
        The properties of the source control.

UPDATE examples

update

Update a source control.

UPDATE azure.automation.source_controls
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND sourceControlName = '{{ sourceControlName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Delete the source control.

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