ScalingPlan interface

Package:

@azure/arm-desktopvirtualization

Represents a scaling plan definition.

Extends

ResourceModelWithAllowedPropertySet

Properties

description	Description of scaling plan.
exclusionTag	Exclusion tag for scaling plan.
friendlyName	User friendly name of scaling plan.
hostPoolReferences	List of ScalingHostPoolReference definitions.
hostPoolType	HostPool type for desktop.
objectId	ObjectId of scaling plan. (internal use) NOTE: This property will not be serialized. It can only be populated by the server.
schedules	List of ScalingPlanPooledSchedule definitions.
systemData	Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
timeZone	Timezone of the scaling plan.

Inherited Properties

etag	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. NOTE: This property will not be serialized. It can only be populated by the server.
id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
identity
kind	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.
location	The geo-location where the resource lives
managedBy	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	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
plan
sku
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

description

Description of scaling plan.

description?: string

Property Value

string

exclusionTag

Exclusion tag for scaling plan.

exclusionTag?: string

Property Value

string

friendlyName

User friendly name of scaling plan.

friendlyName?: string

Property Value

string

hostPoolReferences

List of ScalingHostPoolReference definitions.

hostPoolReferences?: ScalingHostPoolReference[]

Property Value

ScalingHostPoolReference[]

hostPoolType

HostPool type for desktop.

hostPoolType?: string

Property Value

string

objectId

ObjectId of scaling plan. (internal use) NOTE: This property will not be serialized. It can only be populated by the server.

objectId?: string

Property Value

string

schedules

List of ScalingPlanPooledSchedule definitions.

schedules?: ScalingSchedule[]

Property Value

ScalingSchedule[]

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

timeZone

Timezone of the scaling plan.

timeZone: string

Property Value

string

Inherited Property Details

etag

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. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

Inherited From ResourceModelWithAllowedPropertySet.etag

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ResourceModelWithAllowedPropertySet.id

identity

identity?: ResourceModelWithAllowedPropertySetIdentity

Property Value

ResourceModelWithAllowedPropertySetIdentity

Inherited From ResourceModelWithAllowedPropertySet.identity

kind

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.

kind?: string

Property Value

string

Inherited From ResourceModelWithAllowedPropertySet.kind

location

The geo-location where the resource lives

location?: string

Property Value

string

Inherited From ResourceModelWithAllowedPropertySet.location

managedBy

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.

managedBy?: string

Property Value

string

Inherited From ResourceModelWithAllowedPropertySet.managedBy

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ResourceModelWithAllowedPropertySet.name

plan

plan?: ResourceModelWithAllowedPropertySetPlan

Property Value

ResourceModelWithAllowedPropertySetPlan

Inherited From ResourceModelWithAllowedPropertySet.plan

sku

sku?: ResourceModelWithAllowedPropertySetSku

Property Value

ResourceModelWithAllowedPropertySetSku

Inherited From ResourceModelWithAllowedPropertySet.sku

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From ResourceModelWithAllowedPropertySet.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ResourceModelWithAllowedPropertySet.type