schedules

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

Overview

Name	schedules
Type	Resource
Id	azure.automation.schedules

Fields

vw_schedules

Name	Datatype	Description
description	text	field from the properties object
advanced_schedule	text	field from the properties object
automationAccountName	text	field from the properties object
creation_time	text	field from the properties object
expiry_time	text	field from the properties object
expiry_time_offset_minutes	text	field from the properties object
frequency	text	field from the properties object
interval	text	field from the properties object
is_enabled	text	field from the properties object
last_modified_time	text	field from the properties object
next_run	text	field from the properties object
next_run_offset_minutes	text	field from the properties object
resourceGroupName	text	field from the properties object
scheduleName	text	field from the properties object
start_time	text	field from the properties object
start_time_offset_minutes	text	field from the properties object
subscriptionId	text	field from the properties object
time_zone	text	field from the properties object

schedules

Name	Datatype	Description
properties	object	Definition of schedule parameters.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	automationAccountName, resourceGroupName, scheduleName, subscriptionId	Retrieve the schedule identified by schedule name.
list_by_automation_account	SELECT	automationAccountName, resourceGroupName, subscriptionId	Retrieve a list of schedules.
create_or_update	INSERT	automationAccountName, resourceGroupName, scheduleName, subscriptionId, data__name, data__properties	Create a schedule.
delete	DELETE	automationAccountName, resourceGroupName, scheduleName, subscriptionId	Delete the schedule identified by schedule name.
update	UPDATE	automationAccountName, resourceGroupName, scheduleName, subscriptionId	Update the schedule identified by schedule name.

SELECT examples

Retrieve a list of schedules.

vw_schedules

SELECT
description,
advanced_schedule,
automationAccountName,
creation_time,
expiry_time,
expiry_time_offset_minutes,
frequency,
interval,
is_enabled,
last_modified_time,
next_run,
next_run_offset_minutes,
resourceGroupName,
scheduleName,
start_time,
start_time_offset_minutes,
subscriptionId,
time_zone
FROM azure.automation.vw_schedules
WHERE automationAccountName = '{{ automationAccountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

schedules

SELECT
properties
FROM azure.automation.schedules
WHERE automationAccountName = '{{ automationAccountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new schedules resource.

All Properties

/*+ create */
INSERT INTO azure.automation.schedules (
automationAccountName,
resourceGroupName,
scheduleName,
subscriptionId,
data__name,
data__properties,
name,
properties
)
SELECT 
'{{ automationAccountName }}',
'{{ resourceGroupName }}',
'{{ scheduleName }}',
'{{ subscriptionId }}',
'{{ data__name }}',
'{{ data__properties }}',
'{{ name }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: properties
      value:
        - name: description
          value: string
        - name: startTime
          value: string
        - name: expiryTime
          value: string
        - name: interval
          value: string
        - name: frequency
          value: []
        - name: timeZone
          value: string
        - name: advancedSchedule
          value:
            - name: weekDays
              value:
                - string
            - name: monthDays
              value:
                - integer
            - name: monthlyOccurrences
              value:
                - - name: occurrence
                    value: integer
                  - name: day
                    value: string

UPDATE example

Updates a schedules resource.

/*+ update */
UPDATE azure.automation.schedules
SET 
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
automationAccountName = '{{ automationAccountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND scheduleName = '{{ scheduleName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified schedules resource.

/*+ delete */
DELETE FROM azure.automation.schedules
WHERE automationAccountName = '{{ automationAccountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND scheduleName = '{{ scheduleName }}'
AND subscriptionId = '{{ subscriptionId }}';