scheduled_actions

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

Overview

Name	`scheduled_actions`
Type	Resource
Id	`azure.compute_schedule.scheduled_actions`

Fields

The following fields are returned by SELECT queries:

get
list_by_resource_group
list_by_subscription

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.
`actionType`	`string`	The action the scheduled action should perform in the resources. Required. Known values are: "Start", "Deallocate", and "Hibernate". (Start, Deallocate, Hibernate)
`disabled`	`boolean`	Tell if the scheduled action is disabled or not.
`endTime`	`string (date-time)`	The time when the scheduled action is supposed to stop scheduling.
`location`	`string`	The geo-location where the resource lives. Required.
`notificationSettings`	`array`	The notification settings for the scheduled action. Required.
`provisioningState`	`string`	The status of the last provisioning operation performed on the resource. Known values are: "Succeeded", "Failed", "Canceled", and "Deleting". (Succeeded, Failed, Canceled, Deleting)
`resourceType`	`string`	The type of resource the scheduled action is targeting. Required. Known values are: "VirtualMachine" and "VirtualMachineScaleSet". (VirtualMachine, VirtualMachineScaleSet)
`schedule`	`object`	The schedule the scheduled action is supposed to follow. Required.
`startTime`	`string (date-time)`	The time which the scheduled action is supposed to start running. Required.
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
`actionType`	`string`	The action the scheduled action should perform in the resources. Required. Known values are: "Start", "Deallocate", and "Hibernate". (Start, Deallocate, Hibernate)
`disabled`	`boolean`	Tell if the scheduled action is disabled or not.
`endTime`	`string (date-time)`	The time when the scheduled action is supposed to stop scheduling.
`location`	`string`	The geo-location where the resource lives. Required.
`notificationSettings`	`array`	The notification settings for the scheduled action. Required.
`provisioningState`	`string`	The status of the last provisioning operation performed on the resource. Known values are: "Succeeded", "Failed", "Canceled", and "Deleting". (Succeeded, Failed, Canceled, Deleting)
`resourceType`	`string`	The type of resource the scheduled action is targeting. Required. Known values are: "VirtualMachine" and "VirtualMachineScaleSet". (VirtualMachine, VirtualMachineScaleSet)
`schedule`	`object`	The schedule the scheduled action is supposed to follow. Required.
`startTime`	`string (date-time)`	The time which the scheduled action is supposed to start running. Required.
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
`actionType`	`string`	The action the scheduled action should perform in the resources. Required. Known values are: "Start", "Deallocate", and "Hibernate". (Start, Deallocate, Hibernate)
`disabled`	`boolean`	Tell if the scheduled action is disabled or not.
`endTime`	`string (date-time)`	The time when the scheduled action is supposed to stop scheduling.
`location`	`string`	The geo-location where the resource lives. Required.
`notificationSettings`	`array`	The notification settings for the scheduled action. Required.
`provisioningState`	`string`	The status of the last provisioning operation performed on the resource. Known values are: "Succeeded", "Failed", "Canceled", and "Deleting". (Succeeded, Failed, Canceled, Deleting)
`resourceType`	`string`	The type of resource the scheduled action is targeting. Required. Known values are: "VirtualMachine" and "VirtualMachineScaleSet". (VirtualMachine, VirtualMachineScaleSet)
`schedule`	`object`	The schedule the scheduled action is supposed to follow. Required.
`startTime`	`string (date-time)`	The time which the scheduled action is supposed to start running. Required.
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`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	Description
`get`	`select`	`resource_group_name`, `scheduled_action_name`, `subscription_id`	Get a ScheduledAction.
`list_by_resource_group`	`select`	`resource_group_name`, `subscription_id`	List ScheduledAction resources by resource group.
`list_by_subscription`	`select`	`subscription_id`	List ScheduledAction resources by subscription ID.
`create_or_update`	`insert`	`resource_group_name`, `scheduled_action_name`, `subscription_id`, `location`	Create a ScheduledAction.
`update`	`update`	`resource_group_name`, `scheduled_action_name`, `subscription_id`	Update a ScheduledAction.
`create_or_update`	`replace`	`resource_group_name`, `scheduled_action_name`, `subscription_id`, `location`	Create a ScheduledAction.
`delete`	`delete`	`resource_group_name`, `scheduled_action_name`, `subscription_id`	Delete a ScheduledAction.
`list_resources`	`exec`	`resource_group_name`, `scheduled_action_name`, `subscription_id`	List resources attached to Scheduled Actions.
`virtual_machines_submit_deallocate`	`exec`	`locationparameter`, `subscription_id`, `schedule`, `executionParameters`, `resources`, `correlationid`	VirtualMachinesSubmitDeallocate: Schedule deallocate operation for a batch of virtual machines at datetime in future.
`virtual_machines_submit_hibernate`	`exec`	`locationparameter`, `subscription_id`, `schedule`, `executionParameters`, `resources`, `correlationid`	VirtualMachinesSubmitHibernate: Schedule hibernate operation for a batch of virtual machines at datetime in future.
`virtual_machines_submit_start`	`exec`	`locationparameter`, `subscription_id`, `schedule`, `executionParameters`, `resources`, `correlationid`	VirtualMachinesSubmitStart: Schedule start operation for a batch of virtual machines at datetime in future.
`virtual_machines_execute_deallocate`	`exec`	`locationparameter`, `subscription_id`, `executionParameters`, `resources`, `correlationid`	VirtualMachinesExecuteDeallocate: Execute deallocate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
`virtual_machines_execute_hibernate`	`exec`	`locationparameter`, `subscription_id`, `executionParameters`, `resources`, `correlationid`	VirtualMachinesExecuteHibernate: Execute hibernate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
`virtual_machines_execute_start`	`exec`	`locationparameter`, `subscription_id`, `executionParameters`, `resources`, `correlationid`	VirtualMachinesExecuteStart: Execute start operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
`virtual_machines_execute_create`	`exec`	`locationparameter`, `subscription_id`, `resourceConfigParameters`, `executionParameters`	VirtualMachinesExecuteCreate: Execute create operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
`virtual_machines_execute_delete`	`exec`	`locationparameter`, `subscription_id`, `executionParameters`, `resources`	VirtualMachinesExecuteDelete: Execute delete operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.
`virtual_machines_get_operation_status`	`exec`	`locationparameter`, `subscription_id`, `operationIds`, `correlationid`	VirtualMachinesGetOperationStatus: Polling endpoint to read status of operations performed on virtual machines.
`virtual_machines_cancel_operations`	`exec`	`locationparameter`, `subscription_id`, `operationIds`, `correlationid`	VirtualMachinesCancelOperations: Cancel a previously submitted (start/deallocate/hibernate) request.
`virtual_machines_get_operation_errors`	`exec`	`locationparameter`, `subscription_id`, `operationIds`	VirtualMachinesGetOperationErrors: Get error details on operation errors (like transient errors encountered, additional logs) if they exist.
`attach_resources`	`exec`	`resource_group_name`, `scheduled_action_name`, `subscription_id`, `resources`	A synchronous resource action.
`detach_resources`	`exec`	`resource_group_name`, `scheduled_action_name`, `subscription_id`, `resources`	A synchronous resource action.
`patch_resources`	`exec`	`resource_group_name`, `scheduled_action_name`, `subscription_id`, `resources`	A synchronous resource action.
`disable`	`exec`	`resource_group_name`, `scheduled_action_name`, `subscription_id`	A synchronous resource action.
`enable`	`exec`	`resource_group_name`, `scheduled_action_name`, `subscription_id`	A synchronous resource action.
`cancel_next_occurrence`	`exec`	`resource_group_name`, `scheduled_action_name`, `subscription_id`, `resourceIds`	A synchronous resource action.
`trigger_manual_occurrence`	`exec`	`resource_group_name`, `scheduled_action_name`, `subscription_id`	A synchronous resource action.

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
`locationparameter`	`string`	The location name. Required.
`resource_group_name`	`string`	The name of the resource group. The name is case insensitive. Required.
`scheduled_action_name`	`string`	The name of the ScheduledAction. Required.
`subscription_id`	`string`

`SELECT` examples

get
list_by_resource_group
list_by_subscription

Get a ScheduledAction.

SELECT
id,
name,
actionType,
disabled,
endTime,
location,
notificationSettings,
provisioningState,
resourceType,
schedule,
startTime,
systemData,
tags,
type
FROM azure.compute_schedule.scheduled_actions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND scheduled_action_name = '{{ scheduled_action_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

List ScheduledAction resources by resource group.

SELECT
id,
name,
actionType,
disabled,
endTime,
location,
notificationSettings,
provisioningState,
resourceType,
schedule,
startTime,
systemData,
tags,
type
FROM azure.compute_schedule.scheduled_actions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

List ScheduledAction resources by subscription ID.

SELECT
id,
name,
actionType,
disabled,
endTime,
location,
notificationSettings,
provisioningState,
resourceType,
schedule,
startTime,
systemData,
tags,
type
FROM azure.compute_schedule.scheduled_actions
WHERE subscription_id = '{{ subscription_id }}' -- required
;

`INSERT` examples

create_or_update
Manifest

Create a ScheduledAction.

INSERT INTO azure.compute_schedule.scheduled_actions (
tags,
location,
properties,
resource_group_name,
scheduled_action_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ scheduled_action_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

# Description fields are for documentation purposes
- name: scheduled_actions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the scheduled_actions resource.
  - name: scheduled_action_name
    value: "{{ scheduled_action_name }}"
    description: Required parameter for the scheduled_actions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the scheduled_actions resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      resourceType: "{{ resourceType }}"
      actionType: "{{ actionType }}"
      startTime: "{{ startTime }}"
      endTime: "{{ endTime }}"
      schedule:
        scheduledTime: "{{ scheduledTime }}"
        timeZone: "{{ timeZone }}"
        requestedWeekDays:
          - "{{ requestedWeekDays }}"
        requestedMonths:
          - "{{ requestedMonths }}"
        requestedDaysOfTheMonth:
          - {{ requestedDaysOfTheMonth }}
        executionParameters:
          optimizationPreference: "{{ optimizationPreference }}"
          retryPolicy:
            retryCount: {{ retryCount }}
            retryWindowInMinutes: {{ retryWindowInMinutes }}
        deadlineType: "{{ deadlineType }}"
      notificationSettings:
        - destination: "{{ destination }}"
          type: "{{ type }}"
          language: "{{ language }}"
          disabled: {{ disabled }}
      disabled: {{ disabled }}
      provisioningState: "{{ provisioningState }}"

`UPDATE` examples

update

Update a ScheduledAction.

UPDATE azure.compute_schedule.scheduled_actions
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND scheduled_action_name = '{{ scheduled_action_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

`REPLACE` examples

create_or_update

Create a ScheduledAction.

REPLACE azure.compute_schedule.scheduled_actions
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND scheduled_action_name = '{{ scheduled_action_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

`DELETE` examples

delete

Delete a ScheduledAction.

DELETE FROM azure.compute_schedule.scheduled_actions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND scheduled_action_name = '{{ scheduled_action_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

List resources attached to Scheduled Actions.

EXEC azure.compute_schedule.scheduled_actions.list_resources 
@resource_group_name='{{ resource_group_name }}' --required, 
@scheduled_action_name='{{ scheduled_action_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

VirtualMachinesSubmitDeallocate: Schedule deallocate operation for a batch of virtual machines at datetime in future.

EXEC azure.compute_schedule.scheduled_actions.virtual_machines_submit_deallocate 
@locationparameter='{{ locationparameter }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"schedule": "{{ schedule }}", 
"executionParameters": "{{ executionParameters }}", 
"resources": "{{ resources }}", 
"correlationid": "{{ correlationid }}"
}'
;

VirtualMachinesSubmitHibernate: Schedule hibernate operation for a batch of virtual machines at datetime in future.

EXEC azure.compute_schedule.scheduled_actions.virtual_machines_submit_hibernate 
@locationparameter='{{ locationparameter }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"schedule": "{{ schedule }}", 
"executionParameters": "{{ executionParameters }}", 
"resources": "{{ resources }}", 
"correlationid": "{{ correlationid }}"
}'
;

VirtualMachinesSubmitStart: Schedule start operation for a batch of virtual machines at datetime in future.

EXEC azure.compute_schedule.scheduled_actions.virtual_machines_submit_start 
@locationparameter='{{ locationparameter }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"schedule": "{{ schedule }}", 
"executionParameters": "{{ executionParameters }}", 
"resources": "{{ resources }}", 
"correlationid": "{{ correlationid }}"
}'
;

VirtualMachinesExecuteDeallocate: Execute deallocate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

EXEC azure.compute_schedule.scheduled_actions.virtual_machines_execute_deallocate 
@locationparameter='{{ locationparameter }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"executionParameters": "{{ executionParameters }}", 
"resources": "{{ resources }}", 
"correlationid": "{{ correlationid }}"
}'
;

VirtualMachinesExecuteHibernate: Execute hibernate operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

EXEC azure.compute_schedule.scheduled_actions.virtual_machines_execute_hibernate 
@locationparameter='{{ locationparameter }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"executionParameters": "{{ executionParameters }}", 
"resources": "{{ resources }}", 
"correlationid": "{{ correlationid }}"
}'
;

VirtualMachinesExecuteStart: Execute start operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

EXEC azure.compute_schedule.scheduled_actions.virtual_machines_execute_start 
@locationparameter='{{ locationparameter }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"executionParameters": "{{ executionParameters }}", 
"resources": "{{ resources }}", 
"correlationid": "{{ correlationid }}"
}'
;

VirtualMachinesExecuteCreate: Execute create operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

EXEC azure.compute_schedule.scheduled_actions.virtual_machines_execute_create 
@locationparameter='{{ locationparameter }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"resourceConfigParameters": "{{ resourceConfigParameters }}", 
"executionParameters": "{{ executionParameters }}", 
"correlationid": "{{ correlationid }}"
}'
;

VirtualMachinesExecuteDelete: Execute delete operation for a batch of virtual machines, this operation is triggered as soon as Computeschedule receives it.

EXEC azure.compute_schedule.scheduled_actions.virtual_machines_execute_delete 
@locationparameter='{{ locationparameter }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"executionParameters": "{{ executionParameters }}", 
"resources": "{{ resources }}", 
"correlationid": "{{ correlationid }}", 
"forceDeletion": {{ forceDeletion }}
}'
;

VirtualMachinesGetOperationStatus: Polling endpoint to read status of operations performed on virtual machines.

EXEC azure.compute_schedule.scheduled_actions.virtual_machines_get_operation_status 
@locationparameter='{{ locationparameter }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"operationIds": "{{ operationIds }}", 
"correlationid": "{{ correlationid }}"
}'
;

VirtualMachinesCancelOperations: Cancel a previously submitted (start/deallocate/hibernate) request.

EXEC azure.compute_schedule.scheduled_actions.virtual_machines_cancel_operations 
@locationparameter='{{ locationparameter }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"operationIds": "{{ operationIds }}", 
"correlationid": "{{ correlationid }}"
}'
;

VirtualMachinesGetOperationErrors: Get error details on operation errors (like transient errors encountered, additional logs) if they exist.

EXEC azure.compute_schedule.scheduled_actions.virtual_machines_get_operation_errors 
@locationparameter='{{ locationparameter }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"operationIds": "{{ operationIds }}"
}'
;