scaling_plan_personal_schedules

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

Overview

Name	scaling_plan_personal_schedules
Type	Resource
Id	azure.desktop_virtualization.scaling_plan_personal_schedules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
daysOfWeek	array	Set of days of the week on which this schedule is active.
offPeakActionOnDisconnect	string	Action to be taken after a user disconnect during the off-peak period. Known values are: "None", "Deallocate", and "Hibernate".
offPeakActionOnLogoff	string	Action to be taken after a logoff during the off-peak period. Known values are: "None", "Deallocate", and "Hibernate".
offPeakMinutesToWaitOnDisconnect	integer	The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period.
offPeakMinutesToWaitOnLogoff	integer	The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period.
offPeakStartTime	object	Starting time for off-peak period.
offPeakStartVMOnConnect	string	The desired configuration of Start VM On Connect for the hostpool during the off-peak phase. Known values are: "Enable" and "Disable".
peakActionOnDisconnect	string	Action to be taken after a user disconnect during the peak period. Known values are: "None", "Deallocate", and "Hibernate".
peakActionOnLogoff	string	Action to be taken after a logoff during the peak period. Known values are: "None", "Deallocate", and "Hibernate".
peakMinutesToWaitOnDisconnect	integer	The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period.
peakMinutesToWaitOnLogoff	integer	The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period.
peakStartTime	object	Starting time for peak period.
peakStartVMOnConnect	string	The desired configuration of Start VM On Connect for the hostpool during the peak phase. Known values are: "Enable" and "Disable".
rampDownActionOnDisconnect	string	Action to be taken after a user disconnect during the ramp down period. Known values are: "None", "Deallocate", and "Hibernate".
rampDownActionOnLogoff	string	Action to be taken after a logoff during the ramp down period. Known values are: "None", "Deallocate", and "Hibernate".
rampDownMinutesToWaitOnDisconnect	integer	The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period.
rampDownMinutesToWaitOnLogoff	integer	The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period.
rampDownStartTime	object	Starting time for ramp down period.
rampDownStartVMOnConnect	string	The desired configuration of Start VM On Connect for the hostpool during the ramp down phase. Known values are: "Enable" and "Disable".
rampUpActionOnDisconnect	string	Action to be taken after a user disconnect during the ramp up period. Known values are: "None", "Deallocate", and "Hibernate".
rampUpActionOnLogoff	string	Action to be taken after a logoff during the ramp up period. Known values are: "None", "Deallocate", and "Hibernate".
rampUpAutoStartHosts	string	The desired startup behavior during the ramp up period for personal vms in the hostpool. Known values are: "None", "WithAssignedUser", and "All".
rampUpMinutesToWaitOnDisconnect	integer	The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period.
rampUpMinutesToWaitOnLogoff	integer	The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period.
rampUpStartTime	object	Starting time for ramp up period.
rampUpStartVMOnConnect	string	The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually. Known values are: "Enable" and "Disable".
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".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
daysOfWeek	array	Set of days of the week on which this schedule is active.
offPeakActionOnDisconnect	string	Action to be taken after a user disconnect during the off-peak period. Known values are: "None", "Deallocate", and "Hibernate".
offPeakActionOnLogoff	string	Action to be taken after a logoff during the off-peak period. Known values are: "None", "Deallocate", and "Hibernate".
offPeakMinutesToWaitOnDisconnect	integer	The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period.
offPeakMinutesToWaitOnLogoff	integer	The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period.
offPeakStartTime	object	Starting time for off-peak period.
offPeakStartVMOnConnect	string	The desired configuration of Start VM On Connect for the hostpool during the off-peak phase. Known values are: "Enable" and "Disable".
peakActionOnDisconnect	string	Action to be taken after a user disconnect during the peak period. Known values are: "None", "Deallocate", and "Hibernate".
peakActionOnLogoff	string	Action to be taken after a logoff during the peak period. Known values are: "None", "Deallocate", and "Hibernate".
peakMinutesToWaitOnDisconnect	integer	The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period.
peakMinutesToWaitOnLogoff	integer	The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period.
peakStartTime	object	Starting time for peak period.
peakStartVMOnConnect	string	The desired configuration of Start VM On Connect for the hostpool during the peak phase. Known values are: "Enable" and "Disable".
rampDownActionOnDisconnect	string	Action to be taken after a user disconnect during the ramp down period. Known values are: "None", "Deallocate", and "Hibernate".
rampDownActionOnLogoff	string	Action to be taken after a logoff during the ramp down period. Known values are: "None", "Deallocate", and "Hibernate".
rampDownMinutesToWaitOnDisconnect	integer	The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period.
rampDownMinutesToWaitOnLogoff	integer	The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period.
rampDownStartTime	object	Starting time for ramp down period.
rampDownStartVMOnConnect	string	The desired configuration of Start VM On Connect for the hostpool during the ramp down phase. Known values are: "Enable" and "Disable".
rampUpActionOnDisconnect	string	Action to be taken after a user disconnect during the ramp up period. Known values are: "None", "Deallocate", and "Hibernate".
rampUpActionOnLogoff	string	Action to be taken after a logoff during the ramp up period. Known values are: "None", "Deallocate", and "Hibernate".
rampUpAutoStartHosts	string	The desired startup behavior during the ramp up period for personal vms in the hostpool. Known values are: "None", "WithAssignedUser", and "All".
rampUpMinutesToWaitOnDisconnect	integer	The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period.
rampUpMinutesToWaitOnLogoff	integer	The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period.
rampUpStartTime	object	Starting time for ramp up period.
rampUpStartVMOnConnect	string	The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually. Known values are: "Enable" and "Disable".
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
get	select	resource_group_name, scaling_plan_name, scaling_plan_schedule_name, subscription_id		Get a ScalingPlanPersonalSchedule.
list	select	resource_group_name, scaling_plan_name, subscription_id	pageSize, isDescending, initialSkip	List ScalingPlanPersonalSchedules.
create	insert	resource_group_name, scaling_plan_name, scaling_plan_schedule_name, subscription_id		Create or update a ScalingPlanPersonalSchedule.
update	update	resource_group_name, scaling_plan_name, scaling_plan_schedule_name, subscription_id		Update a ScalingPlanPersonalSchedule.
delete	delete	resource_group_name, scaling_plan_name, scaling_plan_schedule_name, subscription_id		Remove a ScalingPlanPersonalSchedule.

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_group_name	string	The name of the resource group. The name is case insensitive. Required.
scaling_plan_name	string	The name of the scaling plan. Required.
scaling_plan_schedule_name	string	The name of the ScalingPlanSchedule. Required.
subscription_id	string
initialSkip	integer	Initial number of items to skip. Default value is None.
isDescending	boolean	Indicates whether the collection is descending. Default value is None.
pageSize	integer	Number of items per page. Default value is None.

SELECT examples

get

Get a ScalingPlanPersonalSchedule.

SELECT
id,
name,
daysOfWeek,
offPeakActionOnDisconnect,
offPeakActionOnLogoff,
offPeakMinutesToWaitOnDisconnect,
offPeakMinutesToWaitOnLogoff,
offPeakStartTime,
offPeakStartVMOnConnect,
peakActionOnDisconnect,
peakActionOnLogoff,
peakMinutesToWaitOnDisconnect,
peakMinutesToWaitOnLogoff,
peakStartTime,
peakStartVMOnConnect,
rampDownActionOnDisconnect,
rampDownActionOnLogoff,
rampDownMinutesToWaitOnDisconnect,
rampDownMinutesToWaitOnLogoff,
rampDownStartTime,
rampDownStartVMOnConnect,
rampUpActionOnDisconnect,
rampUpActionOnLogoff,
rampUpAutoStartHosts,
rampUpMinutesToWaitOnDisconnect,
rampUpMinutesToWaitOnLogoff,
rampUpStartTime,
rampUpStartVMOnConnect,
systemData,
type
FROM azure.desktop_virtualization.scaling_plan_personal_schedules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND scaling_plan_name = '{{ scaling_plan_name }}' -- required
AND scaling_plan_schedule_name = '{{ scaling_plan_schedule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List ScalingPlanPersonalSchedules.

SELECT
id,
name,
daysOfWeek,
offPeakActionOnDisconnect,
offPeakActionOnLogoff,
offPeakMinutesToWaitOnDisconnect,
offPeakMinutesToWaitOnLogoff,
offPeakStartTime,
offPeakStartVMOnConnect,
peakActionOnDisconnect,
peakActionOnLogoff,
peakMinutesToWaitOnDisconnect,
peakMinutesToWaitOnLogoff,
peakStartTime,
peakStartVMOnConnect,
rampDownActionOnDisconnect,
rampDownActionOnLogoff,
rampDownMinutesToWaitOnDisconnect,
rampDownMinutesToWaitOnLogoff,
rampDownStartTime,
rampDownStartVMOnConnect,
rampUpActionOnDisconnect,
rampUpActionOnLogoff,
rampUpAutoStartHosts,
rampUpMinutesToWaitOnDisconnect,
rampUpMinutesToWaitOnLogoff,
rampUpStartTime,
rampUpStartVMOnConnect,
systemData,
type
FROM azure.desktop_virtualization.scaling_plan_personal_schedules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND scaling_plan_name = '{{ scaling_plan_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

INSERT examples

create

Create or update a ScalingPlanPersonalSchedule.

INSERT INTO azure.desktop_virtualization.scaling_plan_personal_schedules (
properties,
resource_group_name,
scaling_plan_name,
scaling_plan_schedule_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ scaling_plan_name }}',
'{{ scaling_plan_schedule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: scaling_plan_personal_schedules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the scaling_plan_personal_schedules resource.
  - name: scaling_plan_name
    value: "{{ scaling_plan_name }}"
    description: Required parameter for the scaling_plan_personal_schedules resource.
  - name: scaling_plan_schedule_name
    value: "{{ scaling_plan_schedule_name }}"
    description: Required parameter for the scaling_plan_personal_schedules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the scaling_plan_personal_schedules resource.
  - name: properties
    value:
      daysOfWeek:
        - "{{ daysOfWeek }}"
      rampUpStartTime:
        hour: {{ hour }}
        minute: {{ minute }}
      rampUpAutoStartHosts: "{{ rampUpAutoStartHosts }}"
      rampUpStartVMOnConnect: "{{ rampUpStartVMOnConnect }}"
      rampUpActionOnDisconnect: "{{ rampUpActionOnDisconnect }}"
      rampUpMinutesToWaitOnDisconnect: {{ rampUpMinutesToWaitOnDisconnect }}
      rampUpActionOnLogoff: "{{ rampUpActionOnLogoff }}"
      rampUpMinutesToWaitOnLogoff: {{ rampUpMinutesToWaitOnLogoff }}
      peakStartTime:
        hour: {{ hour }}
        minute: {{ minute }}
      peakStartVMOnConnect: "{{ peakStartVMOnConnect }}"
      peakActionOnDisconnect: "{{ peakActionOnDisconnect }}"
      peakMinutesToWaitOnDisconnect: {{ peakMinutesToWaitOnDisconnect }}
      peakActionOnLogoff: "{{ peakActionOnLogoff }}"
      peakMinutesToWaitOnLogoff: {{ peakMinutesToWaitOnLogoff }}
      rampDownStartTime:
        hour: {{ hour }}
        minute: {{ minute }}
      rampDownStartVMOnConnect: "{{ rampDownStartVMOnConnect }}"
      rampDownActionOnDisconnect: "{{ rampDownActionOnDisconnect }}"
      rampDownMinutesToWaitOnDisconnect: {{ rampDownMinutesToWaitOnDisconnect }}
      rampDownActionOnLogoff: "{{ rampDownActionOnLogoff }}"
      rampDownMinutesToWaitOnLogoff: {{ rampDownMinutesToWaitOnLogoff }}
      offPeakStartTime:
        hour: {{ hour }}
        minute: {{ minute }}
      offPeakStartVMOnConnect: "{{ offPeakStartVMOnConnect }}"
      offPeakActionOnDisconnect: "{{ offPeakActionOnDisconnect }}"
      offPeakMinutesToWaitOnDisconnect: {{ offPeakMinutesToWaitOnDisconnect }}
      offPeakActionOnLogoff: "{{ offPeakActionOnLogoff }}"
      offPeakMinutesToWaitOnLogoff: {{ offPeakMinutesToWaitOnLogoff }}

UPDATE examples

update

Update a ScalingPlanPersonalSchedule.

UPDATE azure.desktop_virtualization.scaling_plan_personal_schedules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND scaling_plan_name = '{{ scaling_plan_name }}' --required
AND scaling_plan_schedule_name = '{{ scaling_plan_schedule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Remove a ScalingPlanPersonalSchedule.

DELETE FROM azure.desktop_virtualization.scaling_plan_personal_schedules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND scaling_plan_name = '{{ scaling_plan_name }}' --required
AND scaling_plan_schedule_name = '{{ scaling_plan_schedule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;