scheduled_action_extension

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

Overview

Name	scheduled_action_extension
Type	Resource
Id	azure.compute_schedule.scheduled_action_extension

Fields

The following fields are returned by SELECT queries:

list_by_vms

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.
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.
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
list_by_vms	select	resource_uri		List ScheduledActionResources resources by parent.

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
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.

SELECT examples

list_by_vms

List ScheduledActionResources resources by parent.

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