jobs

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

Overview

Name	jobs
Type	Resource
Id	azure.automation.jobs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The properties of the job.

list_by_automation_account

Name	Datatype	Description
properties	object	Job properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, automationAccountName, jobName	clientRequestId	Retrieve the job identified by job name.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId	$filter, clientRequestId	Retrieve a list of jobs.
create	insert	subscriptionId, resourceGroupName, automationAccountName, jobName, data__properties	clientRequestId	Create a job of the runbook.
suspend	exec	subscriptionId, resourceGroupName, automationAccountName, jobName	clientRequestId	Suspend the job identified by job name.
stop	exec	resourceGroupName, automationAccountName, jobName, subscriptionId	clientRequestId	Stop the job identified by jobName.
resume	exec	resourceGroupName, automationAccountName, jobName, subscriptionId	clientRequestId	Resume the job identified by jobName.

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.
jobName	string	The job name.
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.
$filter	string	The filter to apply on the operation.
clientRequestId	string	Identifies this specific client request.

SELECT examples

get

Retrieve the job identified by job name.

SELECT
properties
FROM azure.automation.jobs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND jobName = '{{ jobName }}' -- required
AND clientRequestId = '{{ clientRequestId }}'
;

list_by_automation_account

Retrieve a list of jobs.

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

INSERT examples

create

Create a job of the runbook.

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

Manifest

# Description fields are for documentation purposes
- name: jobs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the jobs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the jobs resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the jobs resource.
    - name: jobName
      value: string
      description: Required parameter for the jobs resource.
    - name: properties
      value: object
      description: |
        Gets or sets the list of job properties.
    - name: clientRequestId
      value: string
      description: Identifies this specific client request.

Lifecycle Methods

suspend

Suspend the job identified by job name.

EXEC azure.automation.jobs.suspend 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@automationAccountName='{{ automationAccountName }}' --required, 
@jobName='{{ jobName }}' --required, 
@clientRequestId='{{ clientRequestId }}'
;

stop

Stop the job identified by jobName.

EXEC azure.automation.jobs.stop 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@automationAccountName='{{ automationAccountName }}' --required, 
@jobName='{{ jobName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@clientRequestId='{{ clientRequestId }}'
;

resume

Resume the job identified by jobName.

EXEC azure.automation.jobs.resume 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@automationAccountName='{{ automationAccountName }}' --required, 
@jobName='{{ jobName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@clientRequestId='{{ clientRequestId }}'
;