scaling_plan_pooled_schedules

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

Overview

Name	scaling_plan_pooled_schedules
Type	Resource
Id	azure.desktop_virtualization.scaling_plan_pooled_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.
offPeakLoadBalancingAlgorithm	string	Load balancing algorithm for off-peak period. Known values are: "BreadthFirst" and "DepthFirst".
offPeakStartTime	object	Starting time for off-peak period.
peakLoadBalancingAlgorithm	string	Load balancing algorithm for peak period. Known values are: "BreadthFirst" and "DepthFirst".
peakStartTime	object	Starting time for peak period.
rampDownCapacityThresholdPct	integer	Capacity threshold for ramp down period.
rampDownForceLogoffUsers	boolean	Should users be logged off forcefully from hosts.
rampDownLoadBalancingAlgorithm	string	Load balancing algorithm for ramp down period. Known values are: "BreadthFirst" and "DepthFirst".
rampDownMinimumHostsPct	integer	Minimum host percentage for ramp down period.
rampDownNotificationMessage	string	Notification message for users during ramp down period.
rampDownStartTime	object	Starting time for ramp down period.
rampDownStopHostsWhen	string	Specifies when to stop hosts during ramp down period. Known values are: "ZeroSessions" and "ZeroActiveSessions".
rampDownWaitTimeMinutes	integer	Number of minutes to wait to stop hosts during ramp down period.
rampUpCapacityThresholdPct	integer	Capacity threshold for ramp up period.
rampUpLoadBalancingAlgorithm	string	Load balancing algorithm for ramp up period. Known values are: "BreadthFirst" and "DepthFirst".
rampUpMinimumHostsPct	integer	Minimum host percentage for ramp up period.
rampUpStartTime	object	Starting time for ramp up period.
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.
offPeakLoadBalancingAlgorithm	string	Load balancing algorithm for off-peak period. Known values are: "BreadthFirst" and "DepthFirst".
offPeakStartTime	object	Starting time for off-peak period.
peakLoadBalancingAlgorithm	string	Load balancing algorithm for peak period. Known values are: "BreadthFirst" and "DepthFirst".
peakStartTime	object	Starting time for peak period.
rampDownCapacityThresholdPct	integer	Capacity threshold for ramp down period.
rampDownForceLogoffUsers	boolean	Should users be logged off forcefully from hosts.
rampDownLoadBalancingAlgorithm	string	Load balancing algorithm for ramp down period. Known values are: "BreadthFirst" and "DepthFirst".
rampDownMinimumHostsPct	integer	Minimum host percentage for ramp down period.
rampDownNotificationMessage	string	Notification message for users during ramp down period.
rampDownStartTime	object	Starting time for ramp down period.
rampDownStopHostsWhen	string	Specifies when to stop hosts during ramp down period. Known values are: "ZeroSessions" and "ZeroActiveSessions".
rampDownWaitTimeMinutes	integer	Number of minutes to wait to stop hosts during ramp down period.
rampUpCapacityThresholdPct	integer	Capacity threshold for ramp up period.
rampUpLoadBalancingAlgorithm	string	Load balancing algorithm for ramp up period. Known values are: "BreadthFirst" and "DepthFirst".
rampUpMinimumHostsPct	integer	Minimum host percentage for ramp up period.
rampUpStartTime	object	Starting time for ramp up period.
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 ScalingPlanPooledSchedule.
list	select	resource_group_name, scaling_plan_name, subscription_id	pageSize, isDescending, initialSkip	List ScalingPlanPooledSchedules.
create	insert	resource_group_name, scaling_plan_name, scaling_plan_schedule_name, subscription_id		Create or update a ScalingPlanPooledSchedule.
update	update	resource_group_name, scaling_plan_name, scaling_plan_schedule_name, subscription_id		Update a ScalingPlanPooledSchedule.
delete	delete	resource_group_name, scaling_plan_name, scaling_plan_schedule_name, subscription_id		Remove a ScalingPlanPooledSchedule.

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 ScalingPlanPooledSchedule.

SELECT
id,
name,
daysOfWeek,
offPeakLoadBalancingAlgorithm,
offPeakStartTime,
peakLoadBalancingAlgorithm,
peakStartTime,
rampDownCapacityThresholdPct,
rampDownForceLogoffUsers,
rampDownLoadBalancingAlgorithm,
rampDownMinimumHostsPct,
rampDownNotificationMessage,
rampDownStartTime,
rampDownStopHostsWhen,
rampDownWaitTimeMinutes,
rampUpCapacityThresholdPct,
rampUpLoadBalancingAlgorithm,
rampUpMinimumHostsPct,
rampUpStartTime,
systemData,
type
FROM azure.desktop_virtualization.scaling_plan_pooled_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 ScalingPlanPooledSchedules.

SELECT
id,
name,
daysOfWeek,
offPeakLoadBalancingAlgorithm,
offPeakStartTime,
peakLoadBalancingAlgorithm,
peakStartTime,
rampDownCapacityThresholdPct,
rampDownForceLogoffUsers,
rampDownLoadBalancingAlgorithm,
rampDownMinimumHostsPct,
rampDownNotificationMessage,
rampDownStartTime,
rampDownStopHostsWhen,
rampDownWaitTimeMinutes,
rampUpCapacityThresholdPct,
rampUpLoadBalancingAlgorithm,
rampUpMinimumHostsPct,
rampUpStartTime,
systemData,
type
FROM azure.desktop_virtualization.scaling_plan_pooled_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 ScalingPlanPooledSchedule.

INSERT INTO azure.desktop_virtualization.scaling_plan_pooled_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_pooled_schedules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the scaling_plan_pooled_schedules resource.
  - name: scaling_plan_name
    value: "{{ scaling_plan_name }}"
    description: Required parameter for the scaling_plan_pooled_schedules resource.
  - name: scaling_plan_schedule_name
    value: "{{ scaling_plan_schedule_name }}"
    description: Required parameter for the scaling_plan_pooled_schedules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the scaling_plan_pooled_schedules resource.
  - name: properties
    value:
      daysOfWeek:
        - "{{ daysOfWeek }}"
      rampUpStartTime:
        hour: {{ hour }}
        minute: {{ minute }}
      rampUpLoadBalancingAlgorithm: "{{ rampUpLoadBalancingAlgorithm }}"
      rampUpMinimumHostsPct: {{ rampUpMinimumHostsPct }}
      rampUpCapacityThresholdPct: {{ rampUpCapacityThresholdPct }}
      peakStartTime:
        hour: {{ hour }}
        minute: {{ minute }}
      peakLoadBalancingAlgorithm: "{{ peakLoadBalancingAlgorithm }}"
      rampDownStartTime:
        hour: {{ hour }}
        minute: {{ minute }}
      rampDownLoadBalancingAlgorithm: "{{ rampDownLoadBalancingAlgorithm }}"
      rampDownMinimumHostsPct: {{ rampDownMinimumHostsPct }}
      rampDownCapacityThresholdPct: {{ rampDownCapacityThresholdPct }}
      rampDownForceLogoffUsers: {{ rampDownForceLogoffUsers }}
      rampDownStopHostsWhen: "{{ rampDownStopHostsWhen }}"
      rampDownWaitTimeMinutes: {{ rampDownWaitTimeMinutes }}
      rampDownNotificationMessage: "{{ rampDownNotificationMessage }}"
      offPeakStartTime:
        hour: {{ hour }}
        minute: {{ minute }}
      offPeakLoadBalancingAlgorithm: "{{ offPeakLoadBalancingAlgorithm }}"

UPDATE examples

update

Update a ScalingPlanPooledSchedule.

UPDATE azure.desktop_virtualization.scaling_plan_pooled_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 ScalingPlanPooledSchedule.

DELETE FROM azure.desktop_virtualization.scaling_plan_pooled_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
;