job_schedule

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

Overview

Name	job_schedule
Type	Resource
Id	azure.automation.job_schedule

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
jobScheduleId	string	Gets or sets the id of job schedule.
parameters	object	Gets or sets the parameters of the job schedule.
runOn	string	Gets or sets the hybrid worker group that the scheduled job should run on.
runbook	object	Gets or sets the runbook.
schedule	object	Gets or sets the schedule.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_automation_account

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
jobScheduleId	string	Gets or sets the id of job schedule.
parameters	object	Gets or sets the parameters of the job schedule.
runOn	string	Gets or sets the hybrid worker group that the scheduled job should run on.
runbook	object	Gets or sets the runbook.
schedule	object	Gets or sets the schedule.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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, job_schedule_id, subscription_id		Retrieve the job schedule identified by job schedule name.
list_by_automation_account	select	resource_group_name, automation_account_name, subscription_id	$filter	Retrieve a list of job schedules.
create	insert	resource_group_name, automation_account_name, job_schedule_id, subscription_id, properties		Create a job schedule.
delete	delete	resource_group_name, automation_account_name, job_schedule_id, subscription_id		Delete the job schedule identified by job schedule name.

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.
job_schedule_id	string	The job schedule name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	The filter to apply on the operation. Default value is None.

SELECT examples

get

Retrieve the job schedule identified by job schedule name.

SELECT
id,
name,
jobScheduleId,
parameters,
runOn,
runbook,
schedule,
systemData,
type
FROM azure.automation.job_schedule
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND job_schedule_id = '{{ job_schedule_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_automation_account

Retrieve a list of job schedules.

SELECT
id,
name,
jobScheduleId,
parameters,
runOn,
runbook,
schedule,
systemData,
type
FROM azure.automation.job_schedule
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Create a job schedule.

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

Manifest

# Description fields are for documentation purposes
- name: job_schedule
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the job_schedule resource.
  - name: automation_account_name
    value: "{{ automation_account_name }}"
    description: Required parameter for the job_schedule resource.
  - name: job_schedule_id
    value: "{{ job_schedule_id }}"
    description: Required parameter for the job_schedule resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the job_schedule resource.
  - name: properties
    description: |
      Gets or sets the list of job schedule properties. Required.
    value:
      schedule:
        name: "{{ name }}"
      runbook:
        name: "{{ name }}"
      runOn: "{{ runOn }}"
      parameters: "{{ parameters }}"

DELETE examples

delete

Delete the job schedule identified by job schedule name.

DELETE FROM azure.automation.job_schedule
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND job_schedule_id = '{{ job_schedule_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;