Azure Native v2 v2.90.0, Mar 27 25

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.desktopvirtualization.getScalingPlan

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Using getScalingPlan

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getScalingPlan(args: GetScalingPlanArgs, opts?: InvokeOptions): Promise<GetScalingPlanResult>
function getScalingPlanOutput(args: GetScalingPlanOutputArgs, opts?: InvokeOptions): Output<GetScalingPlanResult>

def get_scaling_plan(resource_group_name: Optional[str] = None,
                     scaling_plan_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetScalingPlanResult
def get_scaling_plan_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                     scaling_plan_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetScalingPlanResult]

func LookupScalingPlan(ctx *Context, args *LookupScalingPlanArgs, opts ...InvokeOption) (*LookupScalingPlanResult, error)
func LookupScalingPlanOutput(ctx *Context, args *LookupScalingPlanOutputArgs, opts ...InvokeOption) LookupScalingPlanResultOutput

> Note: This function is named LookupScalingPlan in the Go SDK.

public static class GetScalingPlan 
{
    public static Task<GetScalingPlanResult> InvokeAsync(GetScalingPlanArgs args, InvokeOptions? opts = null)
    public static Output<GetScalingPlanResult> Invoke(GetScalingPlanInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetScalingPlanResult> getScalingPlan(GetScalingPlanArgs args, InvokeOptions options)
public static Output<GetScalingPlanResult> getScalingPlan(GetScalingPlanArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:desktopvirtualization:getScalingPlan
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group. The name is case insensitive.
ScalingPlanName string: The name of the scaling plan.

ResourceGroupName string: The name of the resource group. The name is case insensitive.
ScalingPlanName string: The name of the scaling plan.

resourceGroupName String: The name of the resource group. The name is case insensitive.
scalingPlanName String: The name of the scaling plan.

resourceGroupName string: The name of the resource group. The name is case insensitive.
scalingPlanName string: The name of the scaling plan.

resource_group_name str: The name of the resource group. The name is case insensitive.
scaling_plan_name str: The name of the scaling plan.

resourceGroupName String: The name of the resource group. The name is case insensitive.
scalingPlanName String: The name of the scaling plan.

getScalingPlan Result

The following output properties are available:

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.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
ObjectId string: ObjectId of scaling plan. (internal use)
SystemData Pulumi.AzureNative.DesktopVirtualization.Outputs.SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
TimeZone string: Timezone of the scaling plan.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Description string: Description of scaling plan.
ExclusionTag string: Exclusion tag for scaling plan.
FriendlyName string: User friendly name of scaling plan.
HostPoolReferences List<Pulumi.AzureNative.DesktopVirtualization.Outputs.ScalingHostPoolReferenceResponse>: List of ScalingHostPoolReference definitions.
HostPoolType string: HostPool type for desktop.
Identity Pulumi.AzureNative.DesktopVirtualization.Outputs.ResourceModelWithAllowedPropertySetResponseIdentity
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.
Location string: The geo-location where the resource lives
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 Pulumi.AzureNative.DesktopVirtualization.Outputs.ResourceModelWithAllowedPropertySetResponsePlan
Schedules List<Pulumi.AzureNative.DesktopVirtualization.Outputs.ScalingScheduleResponse>: List of ScalingPlanPooledSchedule definitions.
Sku Pulumi.AzureNative.DesktopVirtualization.Outputs.ResourceModelWithAllowedPropertySetResponseSku
Tags Dictionary<string, string>: Resource tags.

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.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
ObjectId string: ObjectId of scaling plan. (internal use)
SystemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
TimeZone string: Timezone of the scaling plan.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Description string: Description of scaling plan.
ExclusionTag string: Exclusion tag for scaling plan.
FriendlyName string: User friendly name of scaling plan.
HostPoolReferences []ScalingHostPoolReferenceResponse: List of ScalingHostPoolReference definitions.
HostPoolType string: HostPool type for desktop.
Identity ResourceModelWithAllowedPropertySetResponseIdentity
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.
Location string: The geo-location where the resource lives
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 ResourceModelWithAllowedPropertySetResponsePlan
Schedules []ScalingScheduleResponse: List of ScalingPlanPooledSchedule definitions.
Sku ResourceModelWithAllowedPropertySetResponseSku
Tags map[string]string: Resource tags.

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.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
objectId String: ObjectId of scaling plan. (internal use)
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
timeZone String: Timezone of the scaling plan.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description String: Description of scaling plan.
exclusionTag String: Exclusion tag for scaling plan.
friendlyName String: User friendly name of scaling plan.
hostPoolReferences List<ScalingHostPoolReferenceResponse>: List of ScalingHostPoolReference definitions.
hostPoolType String: HostPool type for desktop.
identity ResourceModelWithAllowedPropertySetResponseIdentity
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.
location String: The geo-location where the resource lives
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 ResourceModelWithAllowedPropertySetResponsePlan
schedules List<ScalingScheduleResponse>: List of ScalingPlanPooledSchedule definitions.
sku ResourceModelWithAllowedPropertySetResponseSku
tags Map<String,String>: Resource tags.

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.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string: The name of the resource
objectId string: ObjectId of scaling plan. (internal use)
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
timeZone string: Timezone of the scaling plan.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description string: Description of scaling plan.
exclusionTag string: Exclusion tag for scaling plan.
friendlyName string: User friendly name of scaling plan.
hostPoolReferences ScalingHostPoolReferenceResponse[]: List of ScalingHostPoolReference definitions.
hostPoolType string: HostPool type for desktop.
identity ResourceModelWithAllowedPropertySetResponseIdentity
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.
location string: The geo-location where the resource lives
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 ResourceModelWithAllowedPropertySetResponsePlan
schedules ScalingScheduleResponse[]: List of ScalingPlanPooledSchedule definitions.
sku ResourceModelWithAllowedPropertySetResponseSku
tags {[key: string]: string}: Resource tags.

etag str: 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.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str: The name of the resource
object_id str: ObjectId of scaling plan. (internal use)
system_data SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
time_zone str: Timezone of the scaling plan.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description str: Description of scaling plan.
exclusion_tag str: Exclusion tag for scaling plan.
friendly_name str: User friendly name of scaling plan.
host_pool_references Sequence[ScalingHostPoolReferenceResponse]: List of ScalingHostPoolReference definitions.
host_pool_type str: HostPool type for desktop.
identity ResourceModelWithAllowedPropertySetResponseIdentity
kind str: 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 str: The geo-location where the resource lives
managed_by str: 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 ResourceModelWithAllowedPropertySetResponsePlan
schedules Sequence[ScalingScheduleResponse]: List of ScalingPlanPooledSchedule definitions.
sku ResourceModelWithAllowedPropertySetResponseSku
tags Mapping[str, str]: Resource tags.

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.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
objectId String: ObjectId of scaling plan. (internal use)
systemData Property Map: Metadata pertaining to creation and last modification of the resource.
timeZone String: Timezone of the scaling plan.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description String: Description of scaling plan.
exclusionTag String: Exclusion tag for scaling plan.
friendlyName String: User friendly name of scaling plan.
hostPoolReferences List<Property Map>: List of ScalingHostPoolReference definitions.
hostPoolType String: HostPool type for desktop.
identity Property Map
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.
location String: The geo-location where the resource lives
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 Property Map
schedules List<Property Map>: List of ScalingPlanPooledSchedule definitions.
sku Property Map
tags Map<String>: Resource tags.

Supporting Types

ResourceModelWithAllowedPropertySetResponseIdentity

PrincipalId string: The principal ID of resource identity.
TenantId string: The tenant ID of resource.
Type string: The identity type.

PrincipalId string: The principal ID of resource identity.
TenantId string: The tenant ID of resource.
Type string: The identity type.

principalId String: The principal ID of resource identity.
tenantId String: The tenant ID of resource.
type String: The identity type.

principalId string: The principal ID of resource identity.
tenantId string: The tenant ID of resource.
type string: The identity type.

principal_id str: The principal ID of resource identity.
tenant_id str: The tenant ID of resource.
type str: The identity type.

principalId String: The principal ID of resource identity.
tenantId String: The tenant ID of resource.
type String: The identity type.

ResourceModelWithAllowedPropertySetResponsePlan

Name string: A user defined name of the 3rd Party Artifact that is being procured.
Product string: 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.
Publisher string: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
PromotionCode string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
Version string: The version of the desired product/artifact.

Name string: A user defined name of the 3rd Party Artifact that is being procured.
Product string: 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.
Publisher string: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
PromotionCode string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
Version string: The version of the desired product/artifact.

name String: A user defined name of the 3rd Party Artifact that is being procured.
product String: 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.
publisher String: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotionCode String: A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version String: The version of the desired product/artifact.

name string: A user defined name of the 3rd Party Artifact that is being procured.
product string: 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.
publisher string: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotionCode string: A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version string: The version of the desired product/artifact.

name str: A user defined name of the 3rd Party Artifact that is being procured.
product str: 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.
publisher str: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotion_code str: A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version str: The version of the desired product/artifact.

name String: A user defined name of the 3rd Party Artifact that is being procured.
product String: 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.
publisher String: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
promotionCode String: A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
version String: The version of the desired product/artifact.

ResourceModelWithAllowedPropertySetResponseSku

Name string: The name of the SKU. Ex - P3. It is typically a letter+number code
Capacity int: 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.
Family string: If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
Tier string: 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.

Name string: The name of the SKU. Ex - P3. It is typically a letter+number code
Capacity int: 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.
Family string: If the service has different generations of hardware, for the same SKU, then that can be captured here.
Size string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
Tier string: 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.

name String: The name of the SKU. Ex - P3. It is typically a letter+number code
capacity Integer: 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.
family String: If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier String: 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.

name string: The name of the SKU. Ex - P3. It is typically a letter+number code
capacity number: 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.
family string: If the service has different generations of hardware, for the same SKU, then that can be captured here.
size string: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier string: 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.

name str: The name of the SKU. Ex - P3. It is typically a letter+number code
capacity int: 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.
family str: If the service has different generations of hardware, for the same SKU, then that can be captured here.
size str: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier str: 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.

name String: The name of the SKU. Ex - P3. It is typically a letter+number code
capacity Number: 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.
family String: If the service has different generations of hardware, for the same SKU, then that can be captured here.
size String: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier String: 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.

ScalingHostPoolReferenceResponse

HostPoolArmPath string: Arm path of referenced hostpool.
ScalingPlanEnabled bool: Is the scaling plan enabled for this hostpool.

HostPoolArmPath string: Arm path of referenced hostpool.
ScalingPlanEnabled bool: Is the scaling plan enabled for this hostpool.

hostPoolArmPath String: Arm path of referenced hostpool.
scalingPlanEnabled Boolean: Is the scaling plan enabled for this hostpool.

hostPoolArmPath string: Arm path of referenced hostpool.
scalingPlanEnabled boolean: Is the scaling plan enabled for this hostpool.

host_pool_arm_path str: Arm path of referenced hostpool.
scaling_plan_enabled bool: Is the scaling plan enabled for this hostpool.

hostPoolArmPath String: Arm path of referenced hostpool.
scalingPlanEnabled Boolean: Is the scaling plan enabled for this hostpool.

ScalingScheduleResponse

DaysOfWeek List<string>: Set of days of the week on which this schedule is active.
Name string: Name of the ScalingPlanPooledSchedule.
OffPeakLoadBalancingAlgorithm string: Load balancing algorithm for off-peak period.
OffPeakStartTime Pulumi.AzureNative.DesktopVirtualization.Inputs.TimeResponse: Starting time for off-peak period.
PeakLoadBalancingAlgorithm string: Load balancing algorithm for peak period.
PeakStartTime Pulumi.AzureNative.DesktopVirtualization.Inputs.TimeResponse: Starting time for peak period.
RampDownCapacityThresholdPct int: Capacity threshold for ramp down period.
RampDownForceLogoffUsers bool: Should users be logged off forcefully from hosts.
RampDownLoadBalancingAlgorithm string: Load balancing algorithm for ramp down period.
RampDownMinimumHostsPct int: Minimum host percentage for ramp down period.
RampDownNotificationMessage string: Notification message for users during ramp down period.
RampDownStartTime Pulumi.AzureNative.DesktopVirtualization.Inputs.TimeResponse: Starting time for ramp down period.
RampDownStopHostsWhen string: Specifies when to stop hosts during ramp down period.
RampDownWaitTimeMinutes int: Number of minutes to wait to stop hosts during ramp down period.
RampUpCapacityThresholdPct int: Capacity threshold for ramp up period.
RampUpLoadBalancingAlgorithm string: Load balancing algorithm for ramp up period.
RampUpMinimumHostsPct int: Minimum host percentage for ramp up period.
RampUpStartTime Pulumi.AzureNative.DesktopVirtualization.Inputs.TimeResponse: Starting time for ramp up period.

DaysOfWeek []string: Set of days of the week on which this schedule is active.
Name string: Name of the ScalingPlanPooledSchedule.
OffPeakLoadBalancingAlgorithm string: Load balancing algorithm for off-peak period.
OffPeakStartTime TimeResponse: Starting time for off-peak period.
PeakLoadBalancingAlgorithm string: Load balancing algorithm for peak period.
PeakStartTime TimeResponse: Starting time for peak period.
RampDownCapacityThresholdPct int: Capacity threshold for ramp down period.
RampDownForceLogoffUsers bool: Should users be logged off forcefully from hosts.
RampDownLoadBalancingAlgorithm string: Load balancing algorithm for ramp down period.
RampDownMinimumHostsPct int: Minimum host percentage for ramp down period.
RampDownNotificationMessage string: Notification message for users during ramp down period.
RampDownStartTime TimeResponse: Starting time for ramp down period.
RampDownStopHostsWhen string: Specifies when to stop hosts during ramp down period.
RampDownWaitTimeMinutes int: Number of minutes to wait to stop hosts during ramp down period.
RampUpCapacityThresholdPct int: Capacity threshold for ramp up period.
RampUpLoadBalancingAlgorithm string: Load balancing algorithm for ramp up period.
RampUpMinimumHostsPct int: Minimum host percentage for ramp up period.
RampUpStartTime TimeResponse: Starting time for ramp up period.

daysOfWeek List<String>: Set of days of the week on which this schedule is active.
name String: Name of the ScalingPlanPooledSchedule.
offPeakLoadBalancingAlgorithm String: Load balancing algorithm for off-peak period.
offPeakStartTime TimeResponse: Starting time for off-peak period.
peakLoadBalancingAlgorithm String: Load balancing algorithm for peak period.
peakStartTime TimeResponse: Starting time for peak period.
rampDownCapacityThresholdPct Integer: Capacity threshold for ramp down period.
rampDownForceLogoffUsers Boolean: Should users be logged off forcefully from hosts.
rampDownLoadBalancingAlgorithm String: Load balancing algorithm for ramp down period.
rampDownMinimumHostsPct Integer: Minimum host percentage for ramp down period.
rampDownNotificationMessage String: Notification message for users during ramp down period.
rampDownStartTime TimeResponse: Starting time for ramp down period.
rampDownStopHostsWhen String: Specifies when to stop hosts during ramp down period.
rampDownWaitTimeMinutes Integer: Number of minutes to wait to stop hosts during ramp down period.
rampUpCapacityThresholdPct Integer: Capacity threshold for ramp up period.
rampUpLoadBalancingAlgorithm String: Load balancing algorithm for ramp up period.
rampUpMinimumHostsPct Integer: Minimum host percentage for ramp up period.
rampUpStartTime TimeResponse: Starting time for ramp up period.

daysOfWeek string[]: Set of days of the week on which this schedule is active.
name string: Name of the ScalingPlanPooledSchedule.
offPeakLoadBalancingAlgorithm string: Load balancing algorithm for off-peak period.
offPeakStartTime TimeResponse: Starting time for off-peak period.
peakLoadBalancingAlgorithm string: Load balancing algorithm for peak period.
peakStartTime TimeResponse: Starting time for peak period.
rampDownCapacityThresholdPct number: Capacity threshold for ramp down period.
rampDownForceLogoffUsers boolean: Should users be logged off forcefully from hosts.
rampDownLoadBalancingAlgorithm string: Load balancing algorithm for ramp down period.
rampDownMinimumHostsPct number: Minimum host percentage for ramp down period.
rampDownNotificationMessage string: Notification message for users during ramp down period.
rampDownStartTime TimeResponse: Starting time for ramp down period.
rampDownStopHostsWhen string: Specifies when to stop hosts during ramp down period.
rampDownWaitTimeMinutes number: Number of minutes to wait to stop hosts during ramp down period.
rampUpCapacityThresholdPct number: Capacity threshold for ramp up period.
rampUpLoadBalancingAlgorithm string: Load balancing algorithm for ramp up period.
rampUpMinimumHostsPct number: Minimum host percentage for ramp up period.
rampUpStartTime TimeResponse: Starting time for ramp up period.

days_of_week Sequence[str]: Set of days of the week on which this schedule is active.
name str: Name of the ScalingPlanPooledSchedule.
off_peak_load_balancing_algorithm str: Load balancing algorithm for off-peak period.
off_peak_start_time TimeResponse: Starting time for off-peak period.
peak_load_balancing_algorithm str: Load balancing algorithm for peak period.
peak_start_time TimeResponse: Starting time for peak period.
ramp_down_capacity_threshold_pct int: Capacity threshold for ramp down period.
ramp_down_force_logoff_users bool: Should users be logged off forcefully from hosts.
ramp_down_load_balancing_algorithm str: Load balancing algorithm for ramp down period.
ramp_down_minimum_hosts_pct int: Minimum host percentage for ramp down period.
ramp_down_notification_message str: Notification message for users during ramp down period.
ramp_down_start_time TimeResponse: Starting time for ramp down period.
ramp_down_stop_hosts_when str: Specifies when to stop hosts during ramp down period.
ramp_down_wait_time_minutes int: Number of minutes to wait to stop hosts during ramp down period.
ramp_up_capacity_threshold_pct int: Capacity threshold for ramp up period.
ramp_up_load_balancing_algorithm str: Load balancing algorithm for ramp up period.
ramp_up_minimum_hosts_pct int: Minimum host percentage for ramp up period.
ramp_up_start_time TimeResponse: Starting time for ramp up period.

daysOfWeek List<String>: Set of days of the week on which this schedule is active.
name String: Name of the ScalingPlanPooledSchedule.
offPeakLoadBalancingAlgorithm String: Load balancing algorithm for off-peak period.
offPeakStartTime Property Map: Starting time for off-peak period.
peakLoadBalancingAlgorithm String: Load balancing algorithm for peak period.
peakStartTime Property Map: Starting time for peak period.
rampDownCapacityThresholdPct Number: Capacity threshold for ramp down period.
rampDownForceLogoffUsers Boolean: Should users be logged off forcefully from hosts.
rampDownLoadBalancingAlgorithm String: Load balancing algorithm for ramp down period.
rampDownMinimumHostsPct Number: Minimum host percentage for ramp down period.
rampDownNotificationMessage String: Notification message for users during ramp down period.
rampDownStartTime Property Map: Starting time for ramp down period.
rampDownStopHostsWhen String: Specifies when to stop hosts during ramp down period.
rampDownWaitTimeMinutes Number: Number of minutes to wait to stop hosts during ramp down period.
rampUpCapacityThresholdPct Number: Capacity threshold for ramp up period.
rampUpLoadBalancingAlgorithm String: Load balancing algorithm for ramp up period.
rampUpMinimumHostsPct Number: Minimum host percentage for ramp up period.
rampUpStartTime Property Map: Starting time for ramp up period.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

TimeResponse

Hour int: The hour.
Minute int: The minute.

Hour int: The hour.
Minute int: The minute.

hour Integer: The hour.
minute Integer: The minute.

hour number: The hour.
minute number: The minute.

hour int: The hour.
minute int: The minute.

hour Number: The hour.
minute Number: The minute.

Package Details

Repository: azure-native-v2 pulumi/pulumi-azure-native
License: Apache-2.0

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native-v2.desktopvirtualization.getScalingPlan

On this page

On this page

Using getScalingPlan

getScalingPlan Result

Supporting Types

ResourceModelWithAllowedPropertySetResponseIdentity

ResourceModelWithAllowedPropertySetResponsePlan

ResourceModelWithAllowedPropertySetResponseSku

ScalingHostPoolReferenceResponse

ScalingScheduleResponse

SystemDataResponse

TimeResponse

Package Details

On this page

On this page