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

The following fields are returned by SELECT queries:

get

Successfully retrieved scaling plan.

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. (pattern: ^[-\w._,()]+$)
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	Detailed properties for scaling plan.
sku	object	The resource model definition representing SKU

list_by_host_pool

Successfully retrieved scaling plan associated with hostpool.

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. (pattern: ^[-\w._,()]+$)
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	Detailed properties for scaling plan.
sku	object	The resource model definition representing SKU

list_by_resource_group

Successfully retrieved scaling plans in resource group.

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. (pattern: ^[-\w._,()]+$)
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	Detailed properties for scaling plan.
sku	object	The resource model definition representing SKU

list_by_subscription

Successfully retrieved scaling plans in subscription.

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. (pattern: ^[-\w._,()]+$)
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	Detailed properties for scaling plan.
sku	object	The resource model definition representing SKU

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, scalingPlanName		Get a scaling plan.
list_by_host_pool	select	subscriptionId, resourceGroupName, hostPoolName	pageSize, isDescending, initialSkip	List scaling plan associated with hostpool.
list_by_resource_group	select	subscriptionId, resourceGroupName	pageSize, isDescending, initialSkip	List scaling plans.
list_by_subscription	select	subscriptionId	pageSize, isDescending, initialSkip	List scaling plans in subscription.
create	insert	subscriptionId, resourceGroupName, scalingPlanName, data__properties		Create or update a scaling plan.
update	update	subscriptionId, resourceGroupName, scalingPlanName		Update a scaling plan.
delete	delete	subscriptionId, resourceGroupName, scalingPlanName		Remove a scaling plan.

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
hostPoolName	string	The name of the host pool within the specified resource group
resourceGroupName	string	The name of the resource group. The name is case insensitive.
scalingPlanName	string	The name of the scaling plan.
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 scaling plan.

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

list_by_host_pool

List scaling plan associated with hostpool.

SELECT
etag,
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.desktop_virtualization.scaling_plans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND hostPoolName = '{{ hostPoolName }}' -- required
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

list_by_resource_group

List scaling plans.

SELECT
etag,
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.desktop_virtualization.scaling_plans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

list_by_subscription

List scaling plans in subscription.

SELECT
etag,
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.desktop_virtualization.scaling_plans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

INSERT examples

create

Create or update a scaling plan.

INSERT INTO azure.desktop_virtualization.scaling_plans (
data__managedBy,
data__kind,
data__identity,
data__sku,
data__plan,
data__properties,
subscriptionId,
resourceGroupName,
scalingPlanName
)
SELECT 
'{{ managedBy }}',
'{{ kind }}',
'{{ identity }}',
'{{ sku }}',
'{{ plan }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ scalingPlanName }}'
RETURNING
etag,
identity,
kind,
managedBy,
plan,
properties,
sku
;

Manifest

# Description fields are for documentation purposes
- name: scaling_plans
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the scaling_plans resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the scaling_plans resource.
    - name: scalingPlanName
      value: string
      description: Required parameter for the scaling_plans resource.
    - name: managedBy
      value: string
      description: |
        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.
    - name: kind
      value: string
      description: |
        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.
    - name: identity
      value: object
      description: |
        Identity for the resource.
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU
    - name: plan
      value: object
      description: |
        Plan for the resource.
    - name: properties
      value: object
      description: |
        Detailed properties for scaling plan.

UPDATE examples

update

Update a scaling plan.

UPDATE azure.desktop_virtualization.scaling_plans
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND scalingPlanName = '{{ scalingPlanName }}' --required
RETURNING
etag,
identity,
kind,
managedBy,
plan,
properties,
sku;

DELETE examples

delete

Remove a scaling plan.

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