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

Successfully retrieved ScalingPlanPooledSchedule.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Detailed properties for ScalingPlanPooledSchedule
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

Successfully retrieved ScalingPlanPooledSchedules.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Detailed properties for ScalingPlanPooledSchedule
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	subscriptionId, resourceGroupName, scalingPlanName, scalingPlanScheduleName		Get a ScalingPlanPooledSchedule.
list	select	subscriptionId, resourceGroupName, scalingPlanName	pageSize, isDescending, initialSkip	List ScalingPlanPooledSchedules.
create	insert	subscriptionId, resourceGroupName, scalingPlanName, scalingPlanScheduleName, data__properties		Create or update a ScalingPlanPooledSchedule.
update	update	subscriptionId, resourceGroupName, scalingPlanName, scalingPlanScheduleName		Update a ScalingPlanPooledSchedule.
delete	delete	subscriptionId, resourceGroupName, scalingPlanName, scalingPlanScheduleName		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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
scalingPlanName	string	The name of the scaling plan.
scalingPlanScheduleName	string	The name of the ScalingPlanSchedule
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
initialSkip	integer (int32)	Initial number of items to skip.
isDescending	boolean	Indicates whether the collection is descending.
pageSize	integer (int32)	Number of items per page.

SELECT examples

get

Get a ScalingPlanPooledSchedule.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.desktop_virtualization.scaling_plan_pooled_schedules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND scalingPlanName = '{{ scalingPlanName }}' -- required
AND scalingPlanScheduleName = '{{ scalingPlanScheduleName }}' -- required
;

list

List ScalingPlanPooledSchedules.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.desktop_virtualization.scaling_plan_pooled_schedules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND scalingPlanName = '{{ scalingPlanName }}' -- 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 (
data__properties,
subscriptionId,
resourceGroupName,
scalingPlanName,
scalingPlanScheduleName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ scalingPlanName }}',
'{{ scalingPlanScheduleName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: scaling_plan_pooled_schedules
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the scaling_plan_pooled_schedules resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the scaling_plan_pooled_schedules resource.
    - name: scalingPlanName
      value: string
      description: Required parameter for the scaling_plan_pooled_schedules resource.
    - name: scalingPlanScheduleName
      value: string
      description: Required parameter for the scaling_plan_pooled_schedules resource.
    - name: properties
      value: object
      description: |
        Detailed properties for ScalingPlanPooledSchedule

UPDATE examples

update

Update a ScalingPlanPooledSchedule.

UPDATE azure.desktop_virtualization.scaling_plan_pooled_schedules
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND scalingPlanName = '{{ scalingPlanName }}' --required
AND scalingPlanScheduleName = '{{ scalingPlanScheduleName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Remove a ScalingPlanPooledSchedule.

DELETE FROM azure.desktop_virtualization.scaling_plan_pooled_schedules
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND scalingPlanName = '{{ scalingPlanName }}' --required
AND scalingPlanScheduleName = '{{ scalingPlanScheduleName }}' --required
;