source_control_sync_job

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

Overview

Name	source_control_sync_job
Type	Resource
Id	azure.automation.source_control_sync_job

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The id of the job.
creationTime	string (date-time)	The creation time of the job.
endTime	string (date-time)	The end time of the job.
exception	string	The exceptions that occurred while running the sync job.
provisioningState	string	The provisioning state of the job. Known values are: "Completed", "Failed", and "Running". (Completed, Failed, Running)
sourceControlSyncJobId	string	The source control sync job id.
startTime	string (date-time)	The start time of the job.
syncType	string	The sync type. Known values are: "PartialSync" and "FullSync". (PartialSync, FullSync)

list_by_automation_account

Name	Datatype	Description
id	string	Resource id.
name	string	Resource name.
creationTime	string (date-time)	The creation time of the job.
endTime	string (date-time)	The end time of the job.
provisioningState	string	The provisioning state of the job. Known values are: "Completed", "Failed", and "Running". (Completed, Failed, Running)
sourceControlSyncJobId	string	The source control sync job id.
startTime	string (date-time)	The start time of the job.
syncType	string	The sync type. Known values are: "PartialSync" and "FullSync". (PartialSync, FullSync)
type	string	Resource type.

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, source_control_name, source_control_sync_job_id, subscription_id		Retrieve the source control sync job identified by job id.
list_by_automation_account	select	resource_group_name, automation_account_name, source_control_name, subscription_id	$filter	Retrieve a list of source control sync jobs.
create	insert	resource_group_name, automation_account_name, source_control_name, source_control_sync_job_id, subscription_id, 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
automation_account_name	string	The name of the automation account. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
source_control_name	string	The name of source control. Required.
source_control_sync_job_id	string	The source control sync job id. Required.
subscription_id	string
$filter	string	The filter to apply on the operation. Default value is None.

SELECT examples

get

Retrieve the source control sync job identified by job id.

SELECT
id,
creationTime,
endTime,
exception,
provisioningState,
sourceControlSyncJobId,
startTime,
syncType
FROM azure.automation.source_control_sync_job
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND source_control_name = '{{ source_control_name }}' -- required
AND source_control_sync_job_id = '{{ source_control_sync_job_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_automation_account

Retrieve a list of source control sync jobs.

SELECT
id,
name,
creationTime,
endTime,
provisioningState,
sourceControlSyncJobId,
startTime,
syncType,
type
FROM azure.automation.source_control_sync_job
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND source_control_name = '{{ source_control_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Creates the sync job for a source control.

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

Manifest

# Description fields are for documentation purposes
- name: source_control_sync_job
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the source_control_sync_job resource.
  - name: automation_account_name
    value: "{{ automation_account_name }}"
    description: Required parameter for the source_control_sync_job resource.
  - name: source_control_name
    value: "{{ source_control_name }}"
    description: Required parameter for the source_control_sync_job resource.
  - name: source_control_sync_job_id
    value: "{{ source_control_sync_job_id }}"
    description: Required parameter for the source_control_sync_job resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the source_control_sync_job resource.
  - name: properties
    description: |
      The properties of the source control sync job. Required.
    value:
      commitId: "{{ commitId }}"