schedule

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

Overview

Name	schedule
Type	Resource
Id	azure.automation.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.
advancedSchedule	object	Gets or sets the advanced schedule.
creationTime	string (date-time)	Gets or sets the creation time.
description	string	Gets or sets the description.
expiryTime	string (date-time)	Gets or sets the end time of the schedule.
expiryTimeOffsetMinutes	number	Gets or sets the expiry time's offset in minutes.
frequency	string	Gets or sets the frequency of the schedule. Known values are: "OneTime", "Day", "Hour", "Week", "Month", and "Minute". (OneTime, Day, Hour, Week, Month, Minute)
interval	object	Gets or sets the interval of the schedule.
isEnabled	boolean	Gets or sets a value indicating whether this schedule is enabled.
lastModifiedTime	string (date-time)	Gets or sets the last modified time.
nextRun	string (date-time)	Gets or sets the next run time of the schedule.
nextRunOffsetMinutes	number	Gets or sets the next run time's offset in minutes.
startTime	string (date-time)	Gets or sets the start time of the schedule.
startTimeOffsetMinutes	number	Gets the start time's offset in minutes.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeZone	string	Gets or sets the time zone of the schedule.
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.
advancedSchedule	object	Gets or sets the advanced schedule.
creationTime	string (date-time)	Gets or sets the creation time.
description	string	Gets or sets the description.
expiryTime	string (date-time)	Gets or sets the end time of the schedule.
expiryTimeOffsetMinutes	number	Gets or sets the expiry time's offset in minutes.
frequency	string	Gets or sets the frequency of the schedule. Known values are: "OneTime", "Day", "Hour", "Week", "Month", and "Minute". (OneTime, Day, Hour, Week, Month, Minute)
interval	object	Gets or sets the interval of the schedule.
isEnabled	boolean	Gets or sets a value indicating whether this schedule is enabled.
lastModifiedTime	string (date-time)	Gets or sets the last modified time.
nextRun	string (date-time)	Gets or sets the next run time of the schedule.
nextRunOffsetMinutes	number	Gets or sets the next run time's offset in minutes.
startTime	string (date-time)	Gets or sets the start time of the schedule.
startTimeOffsetMinutes	number	Gets the start time's offset in minutes.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeZone	string	Gets or sets the time zone of the schedule.
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, schedule_name, subscription_id		Retrieve the schedule identified by schedule name.
list_by_automation_account	select	resource_group_name, automation_account_name, subscription_id		Retrieve a list of schedules.
create_or_update	insert	resource_group_name, automation_account_name, schedule_name, subscription_id, name, properties		Create a schedule.
update	update	resource_group_name, automation_account_name, schedule_name, subscription_id		Update the schedule identified by schedule name.
create_or_update	replace	resource_group_name, automation_account_name, schedule_name, subscription_id, name, properties		Create a schedule.
delete	delete	resource_group_name, automation_account_name, schedule_name, subscription_id		Delete the schedule identified by 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.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
schedule_name	string	The schedule name. Required.
subscription_id	string

SELECT examples

get

Retrieve the schedule identified by schedule name.

SELECT
id,
name,
advancedSchedule,
creationTime,
description,
expiryTime,
expiryTimeOffsetMinutes,
frequency,
interval,
isEnabled,
lastModifiedTime,
nextRun,
nextRunOffsetMinutes,
startTime,
startTimeOffsetMinutes,
systemData,
timeZone,
type
FROM azure.automation.schedule
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND schedule_name = '{{ schedule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_automation_account

Retrieve a list of schedules.

SELECT
id,
name,
advancedSchedule,
creationTime,
description,
expiryTime,
expiryTimeOffsetMinutes,
frequency,
interval,
isEnabled,
lastModifiedTime,
nextRun,
nextRunOffsetMinutes,
startTime,
startTimeOffsetMinutes,
systemData,
timeZone,
type
FROM azure.automation.schedule
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a schedule.

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

Manifest

# Description fields are for documentation purposes
- name: schedule
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the schedule resource.
  - name: automation_account_name
    value: "{{ automation_account_name }}"
    description: Required parameter for the schedule resource.
  - name: schedule_name
    value: "{{ schedule_name }}"
    description: Required parameter for the schedule resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the schedule resource.
  - name: name
    value: "{{ name }}"
    description: |
      Gets or sets the name of the Schedule. Required.
  - name: properties
    description: |
      Gets or sets the list of schedule properties. Required.
    value:
      description: "{{ description }}"
      startTime: "{{ startTime }}"
      expiryTime: "{{ expiryTime }}"
      interval: "{{ interval }}"
      frequency: "{{ frequency }}"
      timeZone: "{{ timeZone }}"
      advancedSchedule:
        weekDays:
          - "{{ weekDays }}"
        monthDays:
          - {{ monthDays }}
        monthlyOccurrences:
          - occurrence: {{ occurrence }}
            day: "{{ day }}"

UPDATE examples

update

Update the schedule identified by schedule name.

UPDATE azure.automation.schedule
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND schedule_name = '{{ schedule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create a schedule.

REPLACE azure.automation.schedule
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND schedule_name = '{{ schedule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND name = '{{ name }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete the schedule identified by schedule name.

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