ScalingPlan interface
Represents a scaling plan definition.
Properties
| description | Description of scaling plan. |
| exclusion |
Exclusion tag for scaling plan. |
| friendly |
User friendly name of scaling plan. |
| host |
List of ScalingHostPoolReference definitions. |
| host |
HostPool type for desktop. |
| object |
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. |
| time |
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. E.g. "/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 |
| managed |
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 | |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server. |
| 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?: stringProperty Value
string
exclusionTag
Exclusion tag for scaling plan.
exclusionTag?: stringProperty Value
string
friendlyName
User friendly name of scaling plan.
friendlyName?: stringProperty Value
string
hostPoolReferences
List of ScalingHostPoolReference definitions.
hostPoolReferences?: ScalingHostPoolReference[]Property Value
hostPoolType
HostPool type for desktop.
hostPoolType?: stringProperty 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?: stringProperty Value
string
schedules
List of ScalingPlanPooledSchedule definitions.
schedules?: ScalingSchedule[]Property Value
timeZone
Timezone of the scaling plan.
timeZone: stringProperty 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?: stringProperty Value
string
Inherited From ResourceModelWithAllowedPropertySet.etag
id
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
id?: stringProperty Value
string
Inherited From ResourceModelWithAllowedPropertySet.id
identity
identity?: ResourceModelWithAllowedPropertySetIdentityProperty Value
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?: stringProperty Value
string
Inherited From ResourceModelWithAllowedPropertySet.kind
location
The geo-location where the resource lives
location: stringProperty 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?: stringProperty 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?: stringProperty Value
string
Inherited From ResourceModelWithAllowedPropertySet.name
plan
plan?: ResourceModelWithAllowedPropertySetPlanProperty Value
Inherited From ResourceModelWithAllowedPropertySet.plan
sku
sku?: ResourceModelWithAllowedPropertySetSkuProperty Value
Inherited From ResourceModelWithAllowedPropertySet.sku
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
systemData?: SystemDataProperty Value
Inherited From ResourceModelWithAllowedPropertySet.systemData
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?: stringProperty Value
string
Inherited From ResourceModelWithAllowedPropertySet.type