source_control_sync_jobs

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

Overview

Name	source_control_sync_jobs
Type	Resource
Id	azure.automation.source_control_sync_jobs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The id of the job.
properties	object	The properties of the source control sync job.

list_by_automation_account

Name	Datatype	Description
id	string	Resource id.
name	string	Resource name.
properties	object	The properties of the source control sync job.
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, sourceControlName, sourceControlSyncJobId, subscriptionId		Retrieve the source control sync job identified by job id.
list_by_automation_account	select	resourceGroupName, automationAccountName, sourceControlName, subscriptionId	$filter	Retrieve a list of source control sync jobs.
create	insert	resourceGroupName, automationAccountName, sourceControlName, sourceControlSyncJobId, subscriptionId, data__properties		Creates the sync job for a 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 source control name.
sourceControlSyncJobId	string (uuid)	The source control sync job id.
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 sync job identified by job id.

SELECT
id,
properties
FROM azure.automation.source_control_sync_jobs
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND sourceControlName = '{{ sourceControlName }}' -- required
AND sourceControlSyncJobId = '{{ sourceControlSyncJobId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_automation_account

Retrieve a list of source control sync jobs.

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

INSERT examples

create

Creates the sync job for a source control.

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

Manifest

# Description fields are for documentation purposes
- name: source_control_sync_jobs
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the source_control_sync_jobs resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the source_control_sync_jobs resource.
    - name: sourceControlName
      value: string
      description: Required parameter for the source_control_sync_jobs resource.
    - name: sourceControlSyncJobId
      value: string (uuid)
      description: Required parameter for the source_control_sync_jobs resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the source_control_sync_jobs resource.
    - name: properties
      value: object
      description: |
        The properties of the source control sync job.