schedules

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

Overview

Name	schedules
Type	Resource
Id	azure.automation.schedules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Gets or sets the properties of the schedule.

list_by_automation_account

Name	Datatype	Description
properties	object	Gets or sets the properties of the schedule.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, automationAccountName, scheduleName, subscriptionId		Retrieve the schedule identified by schedule name.
list_by_automation_account	select	resourceGroupName, automationAccountName, subscriptionId		Retrieve a list of schedules.
create_or_update	insert	resourceGroupName, automationAccountName, scheduleName, subscriptionId, data__name, data__properties		Create a schedule.
update	update	resourceGroupName, automationAccountName, scheduleName, subscriptionId		Update the schedule identified by schedule name.
delete	delete	resourceGroupName, automationAccountName, scheduleName, subscriptionId		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
automationAccountName	string	The name of the automation account.
resourceGroupName	string	Name of an Azure Resource group.
scheduleName	string	The schedule name.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Retrieve the schedule identified by schedule name.

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

list_by_automation_account

Retrieve a list of schedules.

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

INSERT examples

create_or_update

Create a schedule.

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

Manifest

# Description fields are for documentation purposes
- name: schedules
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the schedules resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the schedules resource.
    - name: scheduleName
      value: string
      description: Required parameter for the schedules resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the schedules resource.
    - name: name
      value: string
      description: |
        Gets or sets the name of the Schedule.
    - name: properties
      value: object
      description: |
        Gets or sets the list of schedule properties.

UPDATE examples

update

Update the schedule identified by schedule name.

UPDATE azure.automation.schedules
SET 
data__name = '{{ name }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND scheduleName = '{{ scheduleName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Delete the schedule identified by schedule name.

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