job_schedules

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

Overview

Name	job_schedules
Type	Resource
Id	azure.automation.job_schedules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Gets the id of the resource.
name	string	Gets the name of the variable.
properties	object	Gets or sets the properties of the job schedule.
type	string	Resource type

list_by_automation_account

Name	Datatype	Description
id	string	Gets the id of the resource.
name	string	Gets the name of the variable.
properties	object	Gets or sets the properties of the job schedule.
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, jobScheduleId, subscriptionId		Retrieve the job schedule identified by job schedule name.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId	$filter	Retrieve a list of job schedules.
create	insert	resourceGroupName, automationAccountName, jobScheduleId, subscriptionId, data__properties		Create a job schedule.
delete	delete	resourceGroupName, automationAccountName, jobScheduleId, subscriptionId		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
automationAccountName	string	The name of the automation account.
jobScheduleId	string (uuid)	The job schedule 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.

SELECT examples

get

Retrieve the job schedule identified by job schedule name.

SELECT
id,
name,
properties,
type
FROM azure.automation.job_schedules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND jobScheduleId = '{{ jobScheduleId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_automation_account

Retrieve a list of job schedules.

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

INSERT examples

create

Create a job schedule.

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

Manifest

# Description fields are for documentation purposes
- name: job_schedules
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the job_schedules resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the job_schedules resource.
    - name: jobScheduleId
      value: string (uuid)
      description: Required parameter for the job_schedules resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the job_schedules resource.
    - name: properties
      value: object
      description: |
        Gets or sets the list of job schedule properties.

DELETE examples

delete

Delete the job schedule identified by job schedule name.

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