Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.2 published on Tuesday, Aug 16, 2022 by Pulumi

ScalingPlan

Represents a scaling plan definition. API Version: 2021-02-01-preview.

Example Usage

ScalingPlans_Create

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var scalingPlan = new AzureNative.DesktopVirtualization.ScalingPlan("scalingPlan", new()
    {
        Description = "des1",
        ExclusionTag = "value",
        FriendlyName = "friendly",
        HostPoolReferences = new[]
        {
            new AzureNative.DesktopVirtualization.Inputs.ScalingHostPoolReferenceArgs
            {
                HostPoolArmPath = "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
                ScalingPlanEnabled = true,
            },
        },
        HostPoolType = "Personal",
        Location = "centralus",
        ResourceGroupName = "resourceGroup1",
        Ring = 1,
        ScalingPlanName = "scalingPlan1",
        Schedules = new[]
        {
            new AzureNative.DesktopVirtualization.Inputs.ScalingScheduleArgs
            {
                DaysOfWeek = new[]
                {
                    "Monday",
                    "Tuesday",
                    "Wednesday",
                    "Thursday",
                    "Friday",
                },
                Name = "schedule1",
                OffPeakLoadBalancingAlgorithm = "DepthFirst",
                OffPeakStartTime = "2020-11-10T20:00:00.000Z",
                PeakLoadBalancingAlgorithm = "BreadthFirst",
                PeakStartTime = "2020-11-10T08:00:00.000Z",
                RampDownCapacityThresholdPct = 50,
                RampDownForceLogoffUsers = true,
                RampDownLoadBalancingAlgorithm = "DepthFirst",
                RampDownMinimumHostsPct = 20,
                RampDownNotificationMessage = "message",
                RampDownStartTime = "2020-11-10T18:00:00.000Z",
                RampDownWaitTimeMinutes = 30,
                RampUpCapacityThresholdPct = 80,
                RampUpLoadBalancingAlgorithm = "DepthFirst",
                RampUpMinimumHostsPct = 20,
                RampUpStartTime = "2020-11-10T06:00:00.000Z",
            },
        },
        Tags = 
        {
            { "tag1", "value1" },
            { "tag2", "value2" },
        },
        TimeZone = "",
    });

});
package main

import (
	desktopvirtualization "github.com/pulumi/pulumi-azure-native/sdk/go/azure/desktopvirtualization"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := desktopvirtualization.NewScalingPlan(ctx, "scalingPlan", &desktopvirtualization.ScalingPlanArgs{
			Description:  pulumi.String("des1"),
			ExclusionTag: pulumi.String("value"),
			FriendlyName: pulumi.String("friendly"),
			HostPoolReferences: []desktopvirtualization.ScalingHostPoolReferenceArgs{
				&desktopvirtualization.ScalingHostPoolReferenceArgs{
					HostPoolArmPath:    pulumi.String("/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1"),
					ScalingPlanEnabled: pulumi.Bool(true),
				},
			},
			HostPoolType:      pulumi.String("Personal"),
			Location:          pulumi.String("centralus"),
			ResourceGroupName: pulumi.String("resourceGroup1"),
			Ring:              pulumi.Int(1),
			ScalingPlanName:   pulumi.String("scalingPlan1"),
			Schedules: []desktopvirtualization.ScalingScheduleArgs{
				&desktopvirtualization.ScalingScheduleArgs{
					DaysOfWeek: pulumi.StringArray{
						pulumi.String("Monday"),
						pulumi.String("Tuesday"),
						pulumi.String("Wednesday"),
						pulumi.String("Thursday"),
						pulumi.String("Friday"),
					},
					Name:                           pulumi.String("schedule1"),
					OffPeakLoadBalancingAlgorithm:  pulumi.String("DepthFirst"),
					OffPeakStartTime:               pulumi.String("2020-11-10T20:00:00.000Z"),
					PeakLoadBalancingAlgorithm:     pulumi.String("BreadthFirst"),
					PeakStartTime:                  pulumi.String("2020-11-10T08:00:00.000Z"),
					RampDownCapacityThresholdPct:   pulumi.Int(50),
					RampDownForceLogoffUsers:       pulumi.Bool(true),
					RampDownLoadBalancingAlgorithm: pulumi.String("DepthFirst"),
					RampDownMinimumHostsPct:        pulumi.Int(20),
					RampDownNotificationMessage:    pulumi.String("message"),
					RampDownStartTime:              pulumi.String("2020-11-10T18:00:00.000Z"),
					RampDownWaitTimeMinutes:        pulumi.Int(30),
					RampUpCapacityThresholdPct:     pulumi.Int(80),
					RampUpLoadBalancingAlgorithm:   pulumi.String("DepthFirst"),
					RampUpMinimumHostsPct:          pulumi.Int(20),
					RampUpStartTime:                pulumi.String("2020-11-10T06:00:00.000Z"),
				},
			},
			Tags: pulumi.StringMap{
				"tag1": pulumi.String("value1"),
				"tag2": pulumi.String("value2"),
			},
			TimeZone: pulumi.String(""),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.desktopvirtualization.ScalingPlan;
import com.pulumi.azurenative.desktopvirtualization.ScalingPlanArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var scalingPlan = new ScalingPlan("scalingPlan", ScalingPlanArgs.builder()        
            .description("des1")
            .exclusionTag("value")
            .friendlyName("friendly")
            .hostPoolReferences(Map.ofEntries(
                Map.entry("hostPoolArmPath", "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1"),
                Map.entry("scalingPlanEnabled", true)
            ))
            .hostPoolType("Personal")
            .location("centralus")
            .resourceGroupName("resourceGroup1")
            .ring(1)
            .scalingPlanName("scalingPlan1")
            .schedules(Map.ofEntries(
                Map.entry("daysOfWeek",                 
                    "Monday",
                    "Tuesday",
                    "Wednesday",
                    "Thursday",
                    "Friday"),
                Map.entry("name", "schedule1"),
                Map.entry("offPeakLoadBalancingAlgorithm", "DepthFirst"),
                Map.entry("offPeakStartTime", "2020-11-10T20:00:00.000Z"),
                Map.entry("peakLoadBalancingAlgorithm", "BreadthFirst"),
                Map.entry("peakStartTime", "2020-11-10T08:00:00.000Z"),
                Map.entry("rampDownCapacityThresholdPct", 50),
                Map.entry("rampDownForceLogoffUsers", true),
                Map.entry("rampDownLoadBalancingAlgorithm", "DepthFirst"),
                Map.entry("rampDownMinimumHostsPct", 20),
                Map.entry("rampDownNotificationMessage", "message"),
                Map.entry("rampDownStartTime", "2020-11-10T18:00:00.000Z"),
                Map.entry("rampDownWaitTimeMinutes", 30),
                Map.entry("rampUpCapacityThresholdPct", 80),
                Map.entry("rampUpLoadBalancingAlgorithm", "DepthFirst"),
                Map.entry("rampUpMinimumHostsPct", 20),
                Map.entry("rampUpStartTime", "2020-11-10T06:00:00.000Z")
            ))
            .tags(Map.ofEntries(
                Map.entry("tag1", "value1"),
                Map.entry("tag2", "value2")
            ))
            .timeZone("")
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

scaling_plan = azure_native.desktopvirtualization.ScalingPlan("scalingPlan",
    description="des1",
    exclusion_tag="value",
    friendly_name="friendly",
    host_pool_references=[azure_native.desktopvirtualization.ScalingHostPoolReferenceArgs(
        host_pool_arm_path="/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
        scaling_plan_enabled=True,
    )],
    host_pool_type="Personal",
    location="centralus",
    resource_group_name="resourceGroup1",
    ring=1,
    scaling_plan_name="scalingPlan1",
    schedules=[azure_native.desktopvirtualization.ScalingScheduleArgs(
        days_of_week=[
            "Monday",
            "Tuesday",
            "Wednesday",
            "Thursday",
            "Friday",
        ],
        name="schedule1",
        off_peak_load_balancing_algorithm="DepthFirst",
        off_peak_start_time="2020-11-10T20:00:00.000Z",
        peak_load_balancing_algorithm="BreadthFirst",
        peak_start_time="2020-11-10T08:00:00.000Z",
        ramp_down_capacity_threshold_pct=50,
        ramp_down_force_logoff_users=True,
        ramp_down_load_balancing_algorithm="DepthFirst",
        ramp_down_minimum_hosts_pct=20,
        ramp_down_notification_message="message",
        ramp_down_start_time="2020-11-10T18:00:00.000Z",
        ramp_down_wait_time_minutes=30,
        ramp_up_capacity_threshold_pct=80,
        ramp_up_load_balancing_algorithm="DepthFirst",
        ramp_up_minimum_hosts_pct=20,
        ramp_up_start_time="2020-11-10T06:00:00.000Z",
    )],
    tags={
        "tag1": "value1",
        "tag2": "value2",
    },
    time_zone="")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const scalingPlan = new azure_native.desktopvirtualization.ScalingPlan("scalingPlan", {
    description: "des1",
    exclusionTag: "value",
    friendlyName: "friendly",
    hostPoolReferences: [{
        hostPoolArmPath: "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
        scalingPlanEnabled: true,
    }],
    hostPoolType: "Personal",
    location: "centralus",
    resourceGroupName: "resourceGroup1",
    ring: 1,
    scalingPlanName: "scalingPlan1",
    schedules: [{
        daysOfWeek: [
            "Monday",
            "Tuesday",
            "Wednesday",
            "Thursday",
            "Friday",
        ],
        name: "schedule1",
        offPeakLoadBalancingAlgorithm: "DepthFirst",
        offPeakStartTime: "2020-11-10T20:00:00.000Z",
        peakLoadBalancingAlgorithm: "BreadthFirst",
        peakStartTime: "2020-11-10T08:00:00.000Z",
        rampDownCapacityThresholdPct: 50,
        rampDownForceLogoffUsers: true,
        rampDownLoadBalancingAlgorithm: "DepthFirst",
        rampDownMinimumHostsPct: 20,
        rampDownNotificationMessage: "message",
        rampDownStartTime: "2020-11-10T18:00:00.000Z",
        rampDownWaitTimeMinutes: 30,
        rampUpCapacityThresholdPct: 80,
        rampUpLoadBalancingAlgorithm: "DepthFirst",
        rampUpMinimumHostsPct: 20,
        rampUpStartTime: "2020-11-10T06:00:00.000Z",
    }],
    tags: {
        tag1: "value1",
        tag2: "value2",
    },
    timeZone: "",
});
resources:
  scalingPlan:
    type: azure-native:desktopvirtualization:ScalingPlan
    properties:
      description: des1
      exclusionTag: value
      friendlyName: friendly
      hostPoolReferences:
        - hostPoolArmPath: /subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1
          scalingPlanEnabled: true
      hostPoolType: Personal
      location: centralus
      resourceGroupName: resourceGroup1
      ring: 1
      scalingPlanName: scalingPlan1
      schedules:
        - daysOfWeek:
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
          name: schedule1
          offPeakLoadBalancingAlgorithm: DepthFirst
          offPeakStartTime: 2020-11-10T20:00:00.000Z
          peakLoadBalancingAlgorithm: BreadthFirst
          peakStartTime: 2020-11-10T08:00:00.000Z
          rampDownCapacityThresholdPct: 50
          rampDownForceLogoffUsers: true
          rampDownLoadBalancingAlgorithm: DepthFirst
          rampDownMinimumHostsPct: 20
          rampDownNotificationMessage: message
          rampDownStartTime: 2020-11-10T18:00:00.000Z
          rampDownWaitTimeMinutes: 30
          rampUpCapacityThresholdPct: 80
          rampUpLoadBalancingAlgorithm: DepthFirst
          rampUpMinimumHostsPct: 20
          rampUpStartTime: 2020-11-10T06:00:00.000Z
      tags:
        tag1: value1
        tag2: value2
      timeZone:

Create a ScalingPlan Resource

new ScalingPlan(name: string, args: ScalingPlanArgs, opts?: CustomResourceOptions);
@overload
def ScalingPlan(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                description: Optional[str] = None,
                exclusion_tag: Optional[str] = None,
                friendly_name: Optional[str] = None,
                host_pool_references: Optional[Sequence[ScalingHostPoolReferenceArgs]] = None,
                host_pool_type: Optional[Union[str, HostPoolType]] = None,
                identity: Optional[ResourceModelWithAllowedPropertySetIdentityArgs] = None,
                kind: Optional[str] = None,
                location: Optional[str] = None,
                managed_by: Optional[str] = None,
                plan: Optional[ResourceModelWithAllowedPropertySetPlanArgs] = None,
                resource_group_name: Optional[str] = None,
                ring: Optional[int] = None,
                scaling_plan_name: Optional[str] = None,
                schedules: Optional[Sequence[ScalingScheduleArgs]] = None,
                sku: Optional[ResourceModelWithAllowedPropertySetSkuArgs] = None,
                tags: Optional[Mapping[str, str]] = None,
                time_zone: Optional[str] = None)
@overload
def ScalingPlan(resource_name: str,
                args: ScalingPlanArgs,
                opts: Optional[ResourceOptions] = None)
func NewScalingPlan(ctx *Context, name string, args ScalingPlanArgs, opts ...ResourceOption) (*ScalingPlan, error)
public ScalingPlan(string name, ScalingPlanArgs args, CustomResourceOptions? opts = null)
public ScalingPlan(String name, ScalingPlanArgs args)
public ScalingPlan(String name, ScalingPlanArgs args, CustomResourceOptions options)
type: azure-native:desktopvirtualization:ScalingPlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ScalingPlanArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ScalingPlanArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ScalingPlanArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ScalingPlanArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ScalingPlanArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ScalingPlan Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ScalingPlan resource accepts the following input properties:

ResourceGroupName string

The name of the resource group. The name is case insensitive.

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.Inputs.ScalingHostPoolReferenceArgs>

List of ScalingHostPoolReference definitions.

HostPoolType string | Pulumi.AzureNative.DesktopVirtualization.HostPoolType

HostPool type for desktop.

Identity Pulumi.AzureNative.DesktopVirtualization.Inputs.ResourceModelWithAllowedPropertySetIdentityArgs
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.Inputs.ResourceModelWithAllowedPropertySetPlanArgs
Ring int

The ring number of scaling plan.

ScalingPlanName string

The name of the scaling plan.

Schedules List<Pulumi.AzureNative.DesktopVirtualization.Inputs.ScalingScheduleArgs>

List of ScalingSchedule definitions.

Sku Pulumi.AzureNative.DesktopVirtualization.Inputs.ResourceModelWithAllowedPropertySetSkuArgs
Tags Dictionary<string, string>

Resource tags.

TimeZone string

Timezone of the scaling plan.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

Description string

Description of scaling plan.

ExclusionTag string

Exclusion tag for scaling plan.

FriendlyName string

User friendly name of scaling plan.

HostPoolReferences []ScalingHostPoolReferenceArgs

List of ScalingHostPoolReference definitions.

HostPoolType string | HostPoolType

HostPool type for desktop.

Identity ResourceModelWithAllowedPropertySetIdentityArgs
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 ResourceModelWithAllowedPropertySetPlanArgs
Ring int

The ring number of scaling plan.

ScalingPlanName string

The name of the scaling plan.

Schedules []ScalingScheduleArgs

List of ScalingSchedule definitions.

Sku ResourceModelWithAllowedPropertySetSkuArgs
Tags map[string]string

Resource tags.

TimeZone string

Timezone of the scaling plan.

resourceGroupName String

The name of the resource group. The name is case insensitive.

description String

Description of scaling plan.

exclusionTag String

Exclusion tag for scaling plan.

friendlyName String

User friendly name of scaling plan.

hostPoolReferences List<ScalingHostPoolReferenceArgs>

List of ScalingHostPoolReference definitions.

hostPoolType String | HostPoolType

HostPool type for desktop.

identity ResourceModelWithAllowedPropertySetIdentityArgs
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 ResourceModelWithAllowedPropertySetPlanArgs
ring Integer

The ring number of scaling plan.

scalingPlanName String

The name of the scaling plan.

schedules List<ScalingScheduleArgs>

List of ScalingSchedule definitions.

sku ResourceModelWithAllowedPropertySetSkuArgs
tags Map<String,String>

Resource tags.

timeZone String

Timezone of the scaling plan.

resourceGroupName string

The name of the resource group. The name is case insensitive.

description string

Description of scaling plan.

exclusionTag string

Exclusion tag for scaling plan.

friendlyName string

User friendly name of scaling plan.

hostPoolReferences ScalingHostPoolReferenceArgs[]

List of ScalingHostPoolReference definitions.

hostPoolType string | HostPoolType

HostPool type for desktop.

identity ResourceModelWithAllowedPropertySetIdentityArgs
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 ResourceModelWithAllowedPropertySetPlanArgs
ring number

The ring number of scaling plan.

scalingPlanName string

The name of the scaling plan.

schedules ScalingScheduleArgs[]

List of ScalingSchedule definitions.

sku ResourceModelWithAllowedPropertySetSkuArgs
tags {[key: string]: string}

Resource tags.

timeZone string

Timezone of the scaling plan.

resource_group_name str

The name of the resource group. The name is case insensitive.

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[ScalingHostPoolReferenceArgs]

List of ScalingHostPoolReference definitions.

host_pool_type str | HostPoolType

HostPool type for desktop.

identity ResourceModelWithAllowedPropertySetIdentityArgs
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 ResourceModelWithAllowedPropertySetPlanArgs
ring int

The ring number of scaling plan.

scaling_plan_name str

The name of the scaling plan.

schedules Sequence[ScalingScheduleArgs]

List of ScalingSchedule definitions.

sku ResourceModelWithAllowedPropertySetSkuArgs
tags Mapping[str, str]

Resource tags.

time_zone str

Timezone of the scaling plan.

resourceGroupName String

The name of the resource group. The name is case insensitive.

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 | "Personal" | "Pooled" | "BYODesktop"

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
ring Number

The ring number of scaling plan.

scalingPlanName String

The name of the scaling plan.

schedules List<Property Map>

List of ScalingSchedule definitions.

sku Property Map
tags Map<String>

Resource tags.

timeZone String

Timezone of the scaling plan.

Outputs

All input properties are implicitly available as output properties. Additionally, the ScalingPlan resource produces the following output properties:

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

The provider-assigned unique ID for this managed resource.

Name string

The name of the resource

ObjectId string

ObjectId of scaling plan. (internal use)

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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

The provider-assigned unique ID for this managed resource.

Name string

The name of the resource

ObjectId string

ObjectId of scaling plan. (internal use)

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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

The provider-assigned unique ID for this managed resource.

name String

The name of the resource

objectId String

ObjectId of scaling plan. (internal use)

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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

The provider-assigned unique ID for this managed resource.

name string

The name of the resource

objectId string

ObjectId of scaling plan. (internal use)

type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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

The provider-assigned unique ID for this managed resource.

name str

The name of the resource

object_id str

ObjectId of scaling plan. (internal use)

type str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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

The provider-assigned unique ID for this managed resource.

name String

The name of the resource

objectId String

ObjectId of scaling plan. (internal use)

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

HostPoolType

Personal
Personal

Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.

Pooled
Pooled

Users get a new (random) SessionHost every time it connects to the HostPool.

BYODesktop
BYODesktop

Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.

HostPoolTypePersonal
Personal

Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.

HostPoolTypePooled
Pooled

Users get a new (random) SessionHost every time it connects to the HostPool.

HostPoolTypeBYODesktop
BYODesktop

Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.

Personal
Personal

Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.

Pooled
Pooled

Users get a new (random) SessionHost every time it connects to the HostPool.

BYODesktop
BYODesktop

Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.

Personal
Personal

Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.

Pooled
Pooled

Users get a new (random) SessionHost every time it connects to the HostPool.

BYODesktop
BYODesktop

Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.

PERSONAL
Personal

Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.

POOLED
Pooled

Users get a new (random) SessionHost every time it connects to the HostPool.

BYO_DESKTOP
BYODesktop

Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.

"Personal"
Personal

Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.

"Pooled"
Pooled

Users get a new (random) SessionHost every time it connects to the HostPool.

"BYODesktop"
BYODesktop

Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.

ResourceIdentityType

SystemAssigned
SystemAssigned
ResourceIdentityTypeSystemAssigned
SystemAssigned
SystemAssigned
SystemAssigned
SystemAssigned
SystemAssigned
SYSTEM_ASSIGNED
SystemAssigned
"SystemAssigned"
SystemAssigned

ResourceModelWithAllowedPropertySetIdentity

Type ResourceIdentityType

The identity type.

type ResourceIdentityType

The identity type.

type ResourceIdentityType

The identity type.

type ResourceIdentityType

The identity type.

type "SystemAssigned"

The identity type.

ResourceModelWithAllowedPropertySetPlan

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.

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.

ResourceModelWithAllowedPropertySetSku

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 Pulumi.AzureNative.DesktopVirtualization.SkuTier

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 SkuTier

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 SkuTier

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 SkuTier

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 SkuTier

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 "Free" | "Basic" | "Standard" | "Premium"

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.

ScalingHostPoolReference

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.

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.

ScalingSchedule

DaysOfWeek List<string>

Set of days of the week on which this schedule is active.

Name string

Name of the scaling schedule.

OffPeakLoadBalancingAlgorithm string | Pulumi.AzureNative.DesktopVirtualization.SessionHostLoadBalancingAlgorithm

Load balancing algorithm for off-peak period.

OffPeakStartTime string

Starting time for off-peak period.

PeakLoadBalancingAlgorithm string | Pulumi.AzureNative.DesktopVirtualization.SessionHostLoadBalancingAlgorithm

Load balancing algorithm for peak period.

PeakStartTime string

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 | Pulumi.AzureNative.DesktopVirtualization.SessionHostLoadBalancingAlgorithm

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 string

Starting time for ramp down period.

RampDownStopHostsWhen string | Pulumi.AzureNative.DesktopVirtualization.StopHostsWhen

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 | Pulumi.AzureNative.DesktopVirtualization.SessionHostLoadBalancingAlgorithm

Load balancing algorithm for ramp up period.

RampUpMinimumHostsPct int

Minimum host percentage for ramp up period.

RampUpStartTime string

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 scaling schedule.

OffPeakLoadBalancingAlgorithm string | SessionHostLoadBalancingAlgorithm

Load balancing algorithm for off-peak period.

OffPeakStartTime string

Starting time for off-peak period.

PeakLoadBalancingAlgorithm string | SessionHostLoadBalancingAlgorithm

Load balancing algorithm for peak period.

PeakStartTime string

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 | SessionHostLoadBalancingAlgorithm

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 string

Starting time for ramp down period.

RampDownStopHostsWhen string | StopHostsWhen

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 | SessionHostLoadBalancingAlgorithm

Load balancing algorithm for ramp up period.

RampUpMinimumHostsPct int

Minimum host percentage for ramp up period.

RampUpStartTime string

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 scaling schedule.

offPeakLoadBalancingAlgorithm String | SessionHostLoadBalancingAlgorithm

Load balancing algorithm for off-peak period.

offPeakStartTime String

Starting time for off-peak period.

peakLoadBalancingAlgorithm String | SessionHostLoadBalancingAlgorithm

Load balancing algorithm for peak period.

peakStartTime String

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 | SessionHostLoadBalancingAlgorithm

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 String

Starting time for ramp down period.

rampDownStopHostsWhen String | StopHostsWhen

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 | SessionHostLoadBalancingAlgorithm

Load balancing algorithm for ramp up period.

rampUpMinimumHostsPct Integer

Minimum host percentage for ramp up period.

rampUpStartTime String

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 scaling schedule.

offPeakLoadBalancingAlgorithm string | SessionHostLoadBalancingAlgorithm

Load balancing algorithm for off-peak period.

offPeakStartTime string

Starting time for off-peak period.

peakLoadBalancingAlgorithm string | SessionHostLoadBalancingAlgorithm

Load balancing algorithm for peak period.

peakStartTime string

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 | SessionHostLoadBalancingAlgorithm

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 string

Starting time for ramp down period.

rampDownStopHostsWhen string | StopHostsWhen

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 | SessionHostLoadBalancingAlgorithm

Load balancing algorithm for ramp up period.

rampUpMinimumHostsPct number

Minimum host percentage for ramp up period.

rampUpStartTime string

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 scaling schedule.

off_peak_load_balancing_algorithm str | SessionHostLoadBalancingAlgorithm

Load balancing algorithm for off-peak period.

off_peak_start_time str

Starting time for off-peak period.

peak_load_balancing_algorithm str | SessionHostLoadBalancingAlgorithm

Load balancing algorithm for peak period.

peak_start_time str

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 | SessionHostLoadBalancingAlgorithm

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 str

Starting time for ramp down period.

ramp_down_stop_hosts_when str | StopHostsWhen

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 | SessionHostLoadBalancingAlgorithm

Load balancing algorithm for ramp up period.

ramp_up_minimum_hosts_pct int

Minimum host percentage for ramp up period.

ramp_up_start_time str

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 scaling schedule.

offPeakLoadBalancingAlgorithm String | "BreadthFirst" | "DepthFirst"

Load balancing algorithm for off-peak period.

offPeakStartTime String

Starting time for off-peak period.

peakLoadBalancingAlgorithm String | "BreadthFirst" | "DepthFirst"

Load balancing algorithm for peak period.

peakStartTime String

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 | "BreadthFirst" | "DepthFirst"

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 String

Starting time for ramp down period.

rampDownStopHostsWhen String | "ZeroSessions" | "ZeroActiveSessions"

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 | "BreadthFirst" | "DepthFirst"

Load balancing algorithm for ramp up period.

rampUpMinimumHostsPct Number

Minimum host percentage for ramp up period.

rampUpStartTime String

Starting time for ramp up period.

ScalingScheduleResponse

DaysOfWeek List<string>

Set of days of the week on which this schedule is active.

Name string

Name of the scaling schedule.

OffPeakLoadBalancingAlgorithm string

Load balancing algorithm for off-peak period.

OffPeakStartTime string

Starting time for off-peak period.

PeakLoadBalancingAlgorithm string

Load balancing algorithm for peak period.

PeakStartTime string

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 string

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 string

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 scaling schedule.

OffPeakLoadBalancingAlgorithm string

Load balancing algorithm for off-peak period.

OffPeakStartTime string

Starting time for off-peak period.

PeakLoadBalancingAlgorithm string

Load balancing algorithm for peak period.

PeakStartTime string

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 string

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 string

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 scaling schedule.

offPeakLoadBalancingAlgorithm String

Load balancing algorithm for off-peak period.

offPeakStartTime String

Starting time for off-peak period.

peakLoadBalancingAlgorithm String

Load balancing algorithm for peak period.

peakStartTime String

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 String

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 String

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 scaling schedule.

offPeakLoadBalancingAlgorithm string

Load balancing algorithm for off-peak period.

offPeakStartTime string

Starting time for off-peak period.

peakLoadBalancingAlgorithm string

Load balancing algorithm for peak period.

peakStartTime string

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 string

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 string

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 scaling schedule.

off_peak_load_balancing_algorithm str

Load balancing algorithm for off-peak period.

off_peak_start_time str

Starting time for off-peak period.

peak_load_balancing_algorithm str

Load balancing algorithm for peak period.

peak_start_time str

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 str

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 str

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 scaling schedule.

offPeakLoadBalancingAlgorithm String

Load balancing algorithm for off-peak period.

offPeakStartTime String

Starting time for off-peak period.

peakLoadBalancingAlgorithm String

Load balancing algorithm for peak period.

peakStartTime String

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 String

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 String

Starting time for ramp up period.

SessionHostLoadBalancingAlgorithm

BreadthFirst
BreadthFirst
DepthFirst
DepthFirst
SessionHostLoadBalancingAlgorithmBreadthFirst
BreadthFirst
SessionHostLoadBalancingAlgorithmDepthFirst
DepthFirst
BreadthFirst
BreadthFirst
DepthFirst
DepthFirst
BreadthFirst
BreadthFirst
DepthFirst
DepthFirst
BREADTH_FIRST
BreadthFirst
DEPTH_FIRST
DepthFirst
"BreadthFirst"
BreadthFirst
"DepthFirst"
DepthFirst

SkuTier

Free
Free
Basic
Basic
Standard
Standard
Premium
Premium
SkuTierFree
Free
SkuTierBasic
Basic
SkuTierStandard
Standard
SkuTierPremium
Premium
Free
Free
Basic
Basic
Standard
Standard
Premium
Premium
Free
Free
Basic
Basic
Standard
Standard
Premium
Premium
FREE
Free
BASIC
Basic
STANDARD
Standard
PREMIUM
Premium
"Free"
Free
"Basic"
Basic
"Standard"
Standard
"Premium"
Premium

StopHostsWhen

ZeroSessions
ZeroSessions
ZeroActiveSessions
ZeroActiveSessions
StopHostsWhenZeroSessions
ZeroSessions
StopHostsWhenZeroActiveSessions
ZeroActiveSessions
ZeroSessions
ZeroSessions
ZeroActiveSessions
ZeroActiveSessions
ZeroSessions
ZeroSessions
ZeroActiveSessions
ZeroActiveSessions
ZERO_SESSIONS
ZeroSessions
ZERO_ACTIVE_SESSIONS
ZeroActiveSessions
"ZeroSessions"
ZeroSessions
"ZeroActiveSessions"
ZeroActiveSessions

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:desktopvirtualization:ScalingPlan scalingPlan1 /subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0