Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2025-03-01-preview
- 2024-11-01-preview
- 2024-08-08-preview
- 2024-04-08-preview
- 2024-04-03
- 2024-03-06-preview
- 2024-01-16-preview
- 2023-11-01-preview
- 2023-10-04-preview
- 2023-09-05
- 2022-10-14-preview
- 2022-09-09
- 2022-04-01-preview
- 2022-02-10-preview
- 2021-09-03-preview
- 2021-07-12
- 2021-04-01-preview
- 2021-03-09-preview
- 2021-02-01-preview
- 2021-01-14-preview
- 2020-11-10-preview
Bicep resource definition
The scalingPlans resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DesktopVirtualization/scalingPlans resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DesktopVirtualization/scalingPlans@2023-11-01-preview' = {
identity: {
type: 'SystemAssigned'
}
kind: 'string'
location: 'string'
managedBy: 'string'
name: 'string'
plan: {
name: 'string'
product: 'string'
promotionCode: 'string'
publisher: 'string'
version: 'string'
}
properties: {
description: 'string'
exclusionTag: 'string'
friendlyName: 'string'
hostPoolReferences: [
{
hostPoolArmPath: 'string'
scalingPlanEnabled: bool
}
]
hostPoolType: 'string'
schedules: [
{
daysOfWeek: [
'string'
]
name: 'string'
offPeakLoadBalancingAlgorithm: 'string'
offPeakStartTime: {
hour: int
minute: int
}
peakLoadBalancingAlgorithm: 'string'
peakStartTime: {
hour: int
minute: int
}
rampDownCapacityThresholdPct: int
rampDownForceLogoffUsers: bool
rampDownLoadBalancingAlgorithm: 'string'
rampDownMinimumHostsPct: int
rampDownNotificationMessage: 'string'
rampDownStartTime: {
hour: int
minute: int
}
rampDownStopHostsWhen: 'string'
rampDownWaitTimeMinutes: int
rampUpCapacityThresholdPct: int
rampUpLoadBalancingAlgorithm: 'string'
rampUpMinimumHostsPct: int
rampUpStartTime: {
hour: int
minute: int
}
}
]
timeZone: 'string'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.DesktopVirtualization/scalingPlans
| Name | Description | Value |
|---|---|---|
| identity | ResourceModelWithAllowedPropertySetIdentity | |
| 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. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ |
| location | The geo-location where the resource lives | string |
| 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. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| plan | ResourceModelWithAllowedPropertySetPlan | |
| properties | Detailed properties for scaling plan. | ScalingPlanProperties (required) |
| sku | ResourceModelWithAllowedPropertySetSku | |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ResourceModelWithAllowedPropertySetIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
ResourceModelWithAllowedPropertySetPlan
| Name | Description | Value |
|---|---|---|
| name | A user defined name of the 3rd Party Artifact that is being procured. | string (required) |
| product | The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. | string (required) |
| promotionCode | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | string |
| publisher | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | string (required) |
| version | The version of the desired product/artifact. | string |
ResourceModelWithAllowedPropertySetSku
| Name | Description | Value |
|---|---|---|
| capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | 'Basic' 'Free' 'Premium' 'Standard' |
ResourceModelWithAllowedPropertySetTags
| Name | Description | Value |
|---|
ScalingHostPoolReference
| Name | Description | Value |
|---|---|---|
| hostPoolArmPath | Arm path of referenced hostpool. | string |
| scalingPlanEnabled | Is the scaling plan enabled for this hostpool. | bool |
ScalingPlanProperties
| Name | Description | Value |
|---|---|---|
| description | Description of scaling plan. | string |
| exclusionTag | Exclusion tag for scaling plan. | string |
| friendlyName | User friendly name of scaling plan. | string |
| hostPoolReferences | List of ScalingHostPoolReference definitions. | ScalingHostPoolReference[] |
| hostPoolType | HostPool type for desktop. | 'Pooled' |
| schedules | List of ScalingPlanPooledSchedule definitions. | ScalingSchedule[] |
| timeZone | Timezone of the scaling plan. | string (required) |
ScalingSchedule
| Name | Description | Value |
|---|---|---|
| daysOfWeek | Set of days of the week on which this schedule is active. | String array containing any of: 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' |
| name | Name of the ScalingPlanPooledSchedule. | string |
| offPeakLoadBalancingAlgorithm | Load balancing algorithm for off-peak period. | 'BreadthFirst' 'DepthFirst' |
| offPeakStartTime | Starting time for off-peak period. | Time |
| peakLoadBalancingAlgorithm | Load balancing algorithm for peak period. | 'BreadthFirst' 'DepthFirst' |
| peakStartTime | Starting time for peak period. | Time |
| rampDownCapacityThresholdPct | Capacity threshold for ramp down period. | int Constraints: Min value = 1 Max value = 100 |
| rampDownForceLogoffUsers | Should users be logged off forcefully from hosts. | bool |
| rampDownLoadBalancingAlgorithm | Load balancing algorithm for ramp down period. | 'BreadthFirst' 'DepthFirst' |
| rampDownMinimumHostsPct | Minimum host percentage for ramp down period. | int Constraints: Min value = 0 Max value = 100 |
| rampDownNotificationMessage | Notification message for users during ramp down period. | string |
| rampDownStartTime | Starting time for ramp down period. | Time |
| rampDownStopHostsWhen | Specifies when to stop hosts during ramp down period. | 'ZeroActiveSessions' 'ZeroSessions' |
| rampDownWaitTimeMinutes | Number of minutes to wait to stop hosts during ramp down period. | int |
| rampUpCapacityThresholdPct | Capacity threshold for ramp up period. | int Constraints: Min value = 1 Max value = 100 |
| rampUpLoadBalancingAlgorithm | Load balancing algorithm for ramp up period. | 'BreadthFirst' 'DepthFirst' |
| rampUpMinimumHostsPct | Minimum host percentage for ramp up period. | int Constraints: Min value = 0 Max value = 100 |
| rampUpStartTime | Starting time for ramp up period. | Time |
Time
| Name | Description | Value |
|---|---|---|
| hour | The hour. | int Constraints: Min value = 0 Max value = 23 (required) |
| minute | The minute. | int Constraints: Min value = 0 Max value = 59 (required) |
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Azure Virtual Desktop (AVD) Scaling Plan | AVM Resource Module for Azure Virtual Desktop (AVD) Scaling Plan |
ARM template resource definition
The scalingPlans resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DesktopVirtualization/scalingPlans resource, add the following JSON to your template.
{
"type": "Microsoft.DesktopVirtualization/scalingPlans",
"apiVersion": "2023-11-01-preview",
"name": "string",
"identity": {
"type": "SystemAssigned"
},
"kind": "string",
"location": "string",
"managedBy": "string",
"plan": {
"name": "string",
"product": "string",
"promotionCode": "string",
"publisher": "string",
"version": "string"
},
"properties": {
"description": "string",
"exclusionTag": "string",
"friendlyName": "string",
"hostPoolReferences": [
{
"hostPoolArmPath": "string",
"scalingPlanEnabled": "bool"
}
],
"hostPoolType": "string",
"schedules": [
{
"daysOfWeek": [ "string" ],
"name": "string",
"offPeakLoadBalancingAlgorithm": "string",
"offPeakStartTime": {
"hour": "int",
"minute": "int"
},
"peakLoadBalancingAlgorithm": "string",
"peakStartTime": {
"hour": "int",
"minute": "int"
},
"rampDownCapacityThresholdPct": "int",
"rampDownForceLogoffUsers": "bool",
"rampDownLoadBalancingAlgorithm": "string",
"rampDownMinimumHostsPct": "int",
"rampDownNotificationMessage": "string",
"rampDownStartTime": {
"hour": "int",
"minute": "int"
},
"rampDownStopHostsWhen": "string",
"rampDownWaitTimeMinutes": "int",
"rampUpCapacityThresholdPct": "int",
"rampUpLoadBalancingAlgorithm": "string",
"rampUpMinimumHostsPct": "int",
"rampUpStartTime": {
"hour": "int",
"minute": "int"
}
}
],
"timeZone": "string"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.DesktopVirtualization/scalingPlans
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-11-01-preview' |
| identity | ResourceModelWithAllowedPropertySetIdentity | |
| 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. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ |
| location | The geo-location where the resource lives | string |
| 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. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| plan | ResourceModelWithAllowedPropertySetPlan | |
| properties | Detailed properties for scaling plan. | ScalingPlanProperties (required) |
| sku | ResourceModelWithAllowedPropertySetSku | |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.DesktopVirtualization/scalingPlans' |
ResourceModelWithAllowedPropertySetIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
ResourceModelWithAllowedPropertySetPlan
| Name | Description | Value |
|---|---|---|
| name | A user defined name of the 3rd Party Artifact that is being procured. | string (required) |
| product | The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. | string (required) |
| promotionCode | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | string |
| publisher | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | string (required) |
| version | The version of the desired product/artifact. | string |
ResourceModelWithAllowedPropertySetSku
| Name | Description | Value |
|---|---|---|
| capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | 'Basic' 'Free' 'Premium' 'Standard' |
ResourceModelWithAllowedPropertySetTags
| Name | Description | Value |
|---|
ScalingHostPoolReference
| Name | Description | Value |
|---|---|---|
| hostPoolArmPath | Arm path of referenced hostpool. | string |
| scalingPlanEnabled | Is the scaling plan enabled for this hostpool. | bool |
ScalingPlanProperties
| Name | Description | Value |
|---|---|---|
| description | Description of scaling plan. | string |
| exclusionTag | Exclusion tag for scaling plan. | string |
| friendlyName | User friendly name of scaling plan. | string |
| hostPoolReferences | List of ScalingHostPoolReference definitions. | ScalingHostPoolReference[] |
| hostPoolType | HostPool type for desktop. | 'Pooled' |
| schedules | List of ScalingPlanPooledSchedule definitions. | ScalingSchedule[] |
| timeZone | Timezone of the scaling plan. | string (required) |
ScalingSchedule
| Name | Description | Value |
|---|---|---|
| daysOfWeek | Set of days of the week on which this schedule is active. | String array containing any of: 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' |
| name | Name of the ScalingPlanPooledSchedule. | string |
| offPeakLoadBalancingAlgorithm | Load balancing algorithm for off-peak period. | 'BreadthFirst' 'DepthFirst' |
| offPeakStartTime | Starting time for off-peak period. | Time |
| peakLoadBalancingAlgorithm | Load balancing algorithm for peak period. | 'BreadthFirst' 'DepthFirst' |
| peakStartTime | Starting time for peak period. | Time |
| rampDownCapacityThresholdPct | Capacity threshold for ramp down period. | int Constraints: Min value = 1 Max value = 100 |
| rampDownForceLogoffUsers | Should users be logged off forcefully from hosts. | bool |
| rampDownLoadBalancingAlgorithm | Load balancing algorithm for ramp down period. | 'BreadthFirst' 'DepthFirst' |
| rampDownMinimumHostsPct | Minimum host percentage for ramp down period. | int Constraints: Min value = 0 Max value = 100 |
| rampDownNotificationMessage | Notification message for users during ramp down period. | string |
| rampDownStartTime | Starting time for ramp down period. | Time |
| rampDownStopHostsWhen | Specifies when to stop hosts during ramp down period. | 'ZeroActiveSessions' 'ZeroSessions' |
| rampDownWaitTimeMinutes | Number of minutes to wait to stop hosts during ramp down period. | int |
| rampUpCapacityThresholdPct | Capacity threshold for ramp up period. | int Constraints: Min value = 1 Max value = 100 |
| rampUpLoadBalancingAlgorithm | Load balancing algorithm for ramp up period. | 'BreadthFirst' 'DepthFirst' |
| rampUpMinimumHostsPct | Minimum host percentage for ramp up period. | int Constraints: Min value = 0 Max value = 100 |
| rampUpStartTime | Starting time for ramp up period. | Time |
Time
| Name | Description | Value |
|---|---|---|
| hour | The hour. | int Constraints: Min value = 0 Max value = 23 (required) |
| minute | The minute. | int Constraints: Min value = 0 Max value = 59 (required) |
Usage Examples
Terraform (AzAPI provider) resource definition
The scalingPlans resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DesktopVirtualization/scalingPlans resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DesktopVirtualization/scalingPlans@2023-11-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
managedBy = "string"
plan = {
name = "string"
product = "string"
promotionCode = "string"
publisher = "string"
version = "string"
}
properties = {
description = "string"
exclusionTag = "string"
friendlyName = "string"
hostPoolReferences = [
{
hostPoolArmPath = "string"
scalingPlanEnabled = bool
}
]
hostPoolType = "string"
schedules = [
{
daysOfWeek = [
"string"
]
name = "string"
offPeakLoadBalancingAlgorithm = "string"
offPeakStartTime = {
hour = int
minute = int
}
peakLoadBalancingAlgorithm = "string"
peakStartTime = {
hour = int
minute = int
}
rampDownCapacityThresholdPct = int
rampDownForceLogoffUsers = bool
rampDownLoadBalancingAlgorithm = "string"
rampDownMinimumHostsPct = int
rampDownNotificationMessage = "string"
rampDownStartTime = {
hour = int
minute = int
}
rampDownStopHostsWhen = "string"
rampDownWaitTimeMinutes = int
rampUpCapacityThresholdPct = int
rampUpLoadBalancingAlgorithm = "string"
rampUpMinimumHostsPct = int
rampUpStartTime = {
hour = int
minute = int
}
}
]
timeZone = "string"
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
}
}
Property Values
Microsoft.DesktopVirtualization/scalingPlans
| Name | Description | Value |
|---|---|---|
| identity | ResourceModelWithAllowedPropertySetIdentity | |
| 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. | string Constraints: Pattern = ^[-\w\._,\(\)]+$ |
| location | The geo-location where the resource lives | string |
| 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. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 (required) |
| plan | ResourceModelWithAllowedPropertySetPlan | |
| properties | Detailed properties for scaling plan. | ScalingPlanProperties (required) |
| sku | ResourceModelWithAllowedPropertySetSku | |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.DesktopVirtualization/scalingPlans@2023-11-01-preview" |
ResourceModelWithAllowedPropertySetIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
ResourceModelWithAllowedPropertySetPlan
| Name | Description | Value |
|---|---|---|
| name | A user defined name of the 3rd Party Artifact that is being procured. | string (required) |
| product | The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. | string (required) |
| promotionCode | A publisher provided promotion code as provisioned in Data Market for the said product/artifact. | string |
| publisher | The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic | string (required) |
| version | The version of the desired product/artifact. | string |
ResourceModelWithAllowedPropertySetSku
| Name | Description | Value |
|---|---|---|
| capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int |
| family | If the service has different generations of hardware, for the same SKU, then that can be captured here. | string |
| name | The name of the SKU. Ex - P3. It is typically a letter+number code | string (required) |
| size | The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. | string |
| tier | This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. | 'Basic' 'Free' 'Premium' 'Standard' |
ResourceModelWithAllowedPropertySetTags
| Name | Description | Value |
|---|
ScalingHostPoolReference
| Name | Description | Value |
|---|---|---|
| hostPoolArmPath | Arm path of referenced hostpool. | string |
| scalingPlanEnabled | Is the scaling plan enabled for this hostpool. | bool |
ScalingPlanProperties
| Name | Description | Value |
|---|---|---|
| description | Description of scaling plan. | string |
| exclusionTag | Exclusion tag for scaling plan. | string |
| friendlyName | User friendly name of scaling plan. | string |
| hostPoolReferences | List of ScalingHostPoolReference definitions. | ScalingHostPoolReference[] |
| hostPoolType | HostPool type for desktop. | 'Pooled' |
| schedules | List of ScalingPlanPooledSchedule definitions. | ScalingSchedule[] |
| timeZone | Timezone of the scaling plan. | string (required) |
ScalingSchedule
| Name | Description | Value |
|---|---|---|
| daysOfWeek | Set of days of the week on which this schedule is active. | String array containing any of: 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' |
| name | Name of the ScalingPlanPooledSchedule. | string |
| offPeakLoadBalancingAlgorithm | Load balancing algorithm for off-peak period. | 'BreadthFirst' 'DepthFirst' |
| offPeakStartTime | Starting time for off-peak period. | Time |
| peakLoadBalancingAlgorithm | Load balancing algorithm for peak period. | 'BreadthFirst' 'DepthFirst' |
| peakStartTime | Starting time for peak period. | Time |
| rampDownCapacityThresholdPct | Capacity threshold for ramp down period. | int Constraints: Min value = 1 Max value = 100 |
| rampDownForceLogoffUsers | Should users be logged off forcefully from hosts. | bool |
| rampDownLoadBalancingAlgorithm | Load balancing algorithm for ramp down period. | 'BreadthFirst' 'DepthFirst' |
| rampDownMinimumHostsPct | Minimum host percentage for ramp down period. | int Constraints: Min value = 0 Max value = 100 |
| rampDownNotificationMessage | Notification message for users during ramp down period. | string |
| rampDownStartTime | Starting time for ramp down period. | Time |
| rampDownStopHostsWhen | Specifies when to stop hosts during ramp down period. | 'ZeroActiveSessions' 'ZeroSessions' |
| rampDownWaitTimeMinutes | Number of minutes to wait to stop hosts during ramp down period. | int |
| rampUpCapacityThresholdPct | Capacity threshold for ramp up period. | int Constraints: Min value = 1 Max value = 100 |
| rampUpLoadBalancingAlgorithm | Load balancing algorithm for ramp up period. | 'BreadthFirst' 'DepthFirst' |
| rampUpMinimumHostsPct | Minimum host percentage for ramp up period. | int Constraints: Min value = 0 Max value = 100 |
| rampUpStartTime | Starting time for ramp up period. | Time |
Time
| Name | Description | Value |
|---|---|---|
| hour | The hour. | int Constraints: Min value = 0 Max value = 23 (required) |
| minute | The minute. | int Constraints: Min value = 0 Max value = 59 (required) |
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Azure Virtual Desktop (AVD) Scaling Plan | AVM Resource Module for Azure Virtual Desktop (AVD) Scaling Plan |