scaling_plans

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

Overview

Name	scaling_plans
Type	Resource
Id	azure.desktop_virtualization.scaling_plans

Fields

vw_scaling_plans

Name	Datatype	Description
description	text	field from the properties object
etag	text	The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
exclusion_tag	text	field from the properties object
friendly_name	text	field from the properties object
host_pool_references	text	field from the properties object
host_pool_type	text	field from the properties object
identity	text	Identity for the resource.
kind	text	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
managed_by	text	field from the properties object
object_id	text	field from the properties object
plan	text	Plan for the resource.
resourceGroupName	text	field from the properties object
scalingPlanName	text	field from the properties object
schedules	text	field from the properties object
sku	text	The resource model definition representing SKU
subscriptionId	text	field from the properties object
time_zone	text	field from the properties object

scaling_plans

Name	Datatype	Description
etag	string	The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
identity	object	Identity for the resource.
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
plan	object	Plan for the resource.
properties	object	Scaling plan properties.
sku	object	The resource model definition representing SKU

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, scalingPlanName, subscriptionId	Get a scaling plan.
list_by_host_pool	SELECT	hostPoolName, resourceGroupName, subscriptionId	List scaling plan associated with hostpool.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List scaling plans.
list_by_subscription	SELECT	subscriptionId	List scaling plans in subscription.
create	INSERT	resourceGroupName, scalingPlanName, subscriptionId, data__properties	Create or update a scaling plan.
delete	DELETE	resourceGroupName, scalingPlanName, subscriptionId	Remove a scaling plan.
update	UPDATE	resourceGroupName, scalingPlanName, subscriptionId	Update a scaling plan.

SELECT examples

List scaling plans in subscription.

vw_scaling_plans

SELECT
description,
etag,
exclusion_tag,
friendly_name,
host_pool_references,
host_pool_type,
identity,
kind,
managed_by,
object_id,
plan,
resourceGroupName,
scalingPlanName,
schedules,
sku,
subscriptionId,
time_zone
FROM azure.desktop_virtualization.vw_scaling_plans
WHERE subscriptionId = '{{ subscriptionId }}';

scaling_plans

SELECT
etag,
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.desktop_virtualization.scaling_plans
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new scaling_plans resource.

All Properties

/*+ create */
INSERT INTO azure.desktop_virtualization.scaling_plans (
resourceGroupName,
scalingPlanName,
subscriptionId,
data__properties,
managedBy,
kind,
identity,
sku,
plan,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ scalingPlanName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ managedBy }}',
'{{ kind }}',
'{{ identity }}',
'{{ sku }}',
'{{ plan }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: managedBy
      value: string
    - name: kind
      value: string
    - name: etag
      value: string
    - name: identity
      value: string
    - name: sku
      value: string
    - name: plan
      value: string
    - name: properties
      value:
        - name: objectId
          value: string
        - name: description
          value: string
        - name: friendlyName
          value: string
        - name: timeZone
          value: string
        - name: hostPoolType
          value: string
        - name: exclusionTag
          value: string
        - name: schedules
          value:
            - - name: name
                value: string
              - name: daysOfWeek
                value:
                  - string
              - name: rampUpStartTime
                value:
                  - name: hour
                    value: integer
                  - name: minute
                    value: integer
              - name: rampUpLoadBalancingAlgorithm
                value: string
              - name: rampUpMinimumHostsPct
                value: integer
              - name: rampUpCapacityThresholdPct
                value: integer
              - name: peakLoadBalancingAlgorithm
                value: string
              - name: rampDownLoadBalancingAlgorithm
                value: string
              - name: rampDownMinimumHostsPct
                value: integer
              - name: rampDownCapacityThresholdPct
                value: integer
              - name: rampDownForceLogoffUsers
                value: boolean
              - name: rampDownStopHostsWhen
                value: string
              - name: rampDownWaitTimeMinutes
                value: integer
              - name: rampDownNotificationMessage
                value: string
              - name: offPeakLoadBalancingAlgorithm
                value: string
        - name: hostPoolReferences
          value:
            - - name: hostPoolArmPath
                value: string
              - name: scalingPlanEnabled
                value: boolean

UPDATE example

Updates a scaling_plans resource.

/*+ update */
UPDATE azure.desktop_virtualization.scaling_plans
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND scalingPlanName = '{{ scalingPlanName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified scaling_plans resource.

/*+ delete */
DELETE FROM azure.desktop_virtualization.scaling_plans
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND scalingPlanName = '{{ scalingPlanName }}'
AND subscriptionId = '{{ subscriptionId }}';