Represents a scaling plan definition.
Uses Azure REST API version 2024-04-03. In version 2.x of the Azure Native provider, it used API version 2022-09-09.
Other available API versions: 2022-09-09, 2022-10-14-preview, 2023-09-05, 2023-10-04-preview, 2023-11-01-preview, 2024-01-16-preview, 2024-03-06-preview, 2024-04-08-preview, 2024-08-08-preview, 2024-11-01-preview, 2025-03-01-preview, 2025-04-01-preview, 2025-08-01-preview, 2025-09-01-preview, 2025-10-10, 2025-11-01-preview, 2026-01-01-preview, 2026-03-01-preview, 2026-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native desktopvirtualization [ApiVersion]. See the version guide for details.
Example Usage
ScalingPlans_Create
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var scalingPlan = new AzureNative.DesktopVirtualization.ScalingPlan("scalingPlan", new()
{
Description = "Description of Scaling Plan",
ExclusionTag = "value",
FriendlyName = "Scaling Plan 1",
HostPoolReferences = new[]
{
new AzureNative.DesktopVirtualization.Inputs.ScalingHostPoolReferenceArgs
{
HostPoolArmPath = "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
ScalingPlanEnabled = true,
},
},
HostPoolType = AzureNative.DesktopVirtualization.ScalingHostPoolType.Pooled,
Location = "centralus",
ResourceGroupName = "resourceGroup1",
ScalingPlanName = "scalingPlan1",
Schedules = new[]
{
new AzureNative.DesktopVirtualization.Inputs.ScalingScheduleArgs
{
DaysOfWeek = new[]
{
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
},
Name = "schedule1",
OffPeakLoadBalancingAlgorithm = AzureNative.DesktopVirtualization.SessionHostLoadBalancingAlgorithm.DepthFirst,
OffPeakStartTime = new AzureNative.DesktopVirtualization.Inputs.TimeArgs
{
Hour = 20,
Minute = 0,
},
PeakLoadBalancingAlgorithm = AzureNative.DesktopVirtualization.SessionHostLoadBalancingAlgorithm.BreadthFirst,
PeakStartTime = new AzureNative.DesktopVirtualization.Inputs.TimeArgs
{
Hour = 8,
Minute = 0,
},
RampDownCapacityThresholdPct = 50,
RampDownForceLogoffUsers = true,
RampDownLoadBalancingAlgorithm = AzureNative.DesktopVirtualization.SessionHostLoadBalancingAlgorithm.DepthFirst,
RampDownMinimumHostsPct = 20,
RampDownNotificationMessage = "message",
RampDownStartTime = new AzureNative.DesktopVirtualization.Inputs.TimeArgs
{
Hour = 18,
Minute = 0,
},
RampDownWaitTimeMinutes = 30,
RampUpCapacityThresholdPct = 80,
RampUpLoadBalancingAlgorithm = AzureNative.DesktopVirtualization.SessionHostLoadBalancingAlgorithm.DepthFirst,
RampUpMinimumHostsPct = 20,
RampUpStartTime = new AzureNative.DesktopVirtualization.Inputs.TimeArgs
{
Hour = 6,
Minute = 0,
},
},
},
Tags =
{
{ "tag1", "value1" },
{ "tag2", "value2" },
},
TimeZone = "Central Standard Time",
});
});
package main
import (
desktopvirtualization "github.com/pulumi/pulumi-azure-native-sdk/desktopvirtualization/v3"
"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("Description of Scaling Plan"),
ExclusionTag: pulumi.String("value"),
FriendlyName: pulumi.String("Scaling Plan 1"),
HostPoolReferences: desktopvirtualization.ScalingHostPoolReferenceArray{
&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(desktopvirtualization.ScalingHostPoolTypePooled),
Location: pulumi.String("centralus"),
ResourceGroupName: pulumi.String("resourceGroup1"),
ScalingPlanName: pulumi.String("scalingPlan1"),
Schedules: desktopvirtualization.ScalingScheduleArray{
&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(desktopvirtualization.SessionHostLoadBalancingAlgorithmDepthFirst),
OffPeakStartTime: &desktopvirtualization.TimeArgs{
Hour: pulumi.Int(20),
Minute: pulumi.Int(0),
},
PeakLoadBalancingAlgorithm: pulumi.String(desktopvirtualization.SessionHostLoadBalancingAlgorithmBreadthFirst),
PeakStartTime: &desktopvirtualization.TimeArgs{
Hour: pulumi.Int(8),
Minute: pulumi.Int(0),
},
RampDownCapacityThresholdPct: pulumi.Int(50),
RampDownForceLogoffUsers: pulumi.Bool(true),
RampDownLoadBalancingAlgorithm: pulumi.String(desktopvirtualization.SessionHostLoadBalancingAlgorithmDepthFirst),
RampDownMinimumHostsPct: pulumi.Int(20),
RampDownNotificationMessage: pulumi.String("message"),
RampDownStartTime: &desktopvirtualization.TimeArgs{
Hour: pulumi.Int(18),
Minute: pulumi.Int(0),
},
RampDownWaitTimeMinutes: pulumi.Int(30),
RampUpCapacityThresholdPct: pulumi.Int(80),
RampUpLoadBalancingAlgorithm: pulumi.String(desktopvirtualization.SessionHostLoadBalancingAlgorithmDepthFirst),
RampUpMinimumHostsPct: pulumi.Int(20),
RampUpStartTime: &desktopvirtualization.TimeArgs{
Hour: pulumi.Int(6),
Minute: pulumi.Int(0),
},
},
},
Tags: pulumi.StringMap{
"tag1": pulumi.String("value1"),
"tag2": pulumi.String("value2"),
},
TimeZone: pulumi.String("Central Standard Time"),
})
if err != nil {
return err
}
return nil
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_desktopvirtualization_scaling_plan" "scalingPlan" {
lifecycle {
create_before_destroy = true
}
description = "Description of Scaling Plan"
exclusion_tag = "value"
friendly_name = "Scaling Plan 1"
host_pool_references {
host_pool_arm_path = "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1"
scaling_plan_enabled = true
}
host_pool_type = "Pooled"
location = "centralus"
resource_group_name = "resourceGroup1"
scaling_plan_name = "scalingPlan1"
schedules {
days_of_week = ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"]
name = "schedule1"
off_peak_load_balancing_algorithm = "DepthFirst"
off_peak_start_time = {
hour = 20
minute = 0
}
peak_load_balancing_algorithm = "BreadthFirst"
peak_start_time = {
hour = 8
minute = 0
}
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 = {
hour = 18
minute = 0
}
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 = {
hour = 6
minute = 0
}
}
tags = {
"tag1" = "value1"
"tag2" = "value2"
}
time_zone = "Central Standard Time"
}
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 com.pulumi.azurenative.desktopvirtualization.inputs.ScalingHostPoolReferenceArgs;
import com.pulumi.azurenative.desktopvirtualization.inputs.ScalingScheduleArgs;
import com.pulumi.azurenative.desktopvirtualization.inputs.TimeArgs;
import java.util.ArrayList;
import java.util.Arrays;
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("Description of Scaling Plan")
.exclusionTag("value")
.friendlyName("Scaling Plan 1")
.hostPoolReferences(ScalingHostPoolReferenceArgs.builder()
.hostPoolArmPath("/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1")
.scalingPlanEnabled(true)
.build())
.hostPoolType("Pooled")
.location("centralus")
.resourceGroupName("resourceGroup1")
.scalingPlanName("scalingPlan1")
.schedules(ScalingScheduleArgs.builder()
.daysOfWeek(
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday")
.name("schedule1")
.offPeakLoadBalancingAlgorithm("DepthFirst")
.offPeakStartTime(TimeArgs.builder()
.hour(20)
.minute(0)
.build())
.peakLoadBalancingAlgorithm("BreadthFirst")
.peakStartTime(TimeArgs.builder()
.hour(8)
.minute(0)
.build())
.rampDownCapacityThresholdPct(50)
.rampDownForceLogoffUsers(true)
.rampDownLoadBalancingAlgorithm("DepthFirst")
.rampDownMinimumHostsPct(20)
.rampDownNotificationMessage("message")
.rampDownStartTime(TimeArgs.builder()
.hour(18)
.minute(0)
.build())
.rampDownWaitTimeMinutes(30)
.rampUpCapacityThresholdPct(80)
.rampUpLoadBalancingAlgorithm("DepthFirst")
.rampUpMinimumHostsPct(20)
.rampUpStartTime(TimeArgs.builder()
.hour(6)
.minute(0)
.build())
.build())
.tags(Map.ofEntries(
Map.entry("tag1", "value1"),
Map.entry("tag2", "value2")
))
.timeZone("Central Standard Time")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const scalingPlan = new azure_native.desktopvirtualization.ScalingPlan("scalingPlan", {
description: "Description of Scaling Plan",
exclusionTag: "value",
friendlyName: "Scaling Plan 1",
hostPoolReferences: [{
hostPoolArmPath: "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
scalingPlanEnabled: true,
}],
hostPoolType: azure_native.desktopvirtualization.ScalingHostPoolType.Pooled,
location: "centralus",
resourceGroupName: "resourceGroup1",
scalingPlanName: "scalingPlan1",
schedules: [{
daysOfWeek: [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
],
name: "schedule1",
offPeakLoadBalancingAlgorithm: azure_native.desktopvirtualization.SessionHostLoadBalancingAlgorithm.DepthFirst,
offPeakStartTime: {
hour: 20,
minute: 0,
},
peakLoadBalancingAlgorithm: azure_native.desktopvirtualization.SessionHostLoadBalancingAlgorithm.BreadthFirst,
peakStartTime: {
hour: 8,
minute: 0,
},
rampDownCapacityThresholdPct: 50,
rampDownForceLogoffUsers: true,
rampDownLoadBalancingAlgorithm: azure_native.desktopvirtualization.SessionHostLoadBalancingAlgorithm.DepthFirst,
rampDownMinimumHostsPct: 20,
rampDownNotificationMessage: "message",
rampDownStartTime: {
hour: 18,
minute: 0,
},
rampDownWaitTimeMinutes: 30,
rampUpCapacityThresholdPct: 80,
rampUpLoadBalancingAlgorithm: azure_native.desktopvirtualization.SessionHostLoadBalancingAlgorithm.DepthFirst,
rampUpMinimumHostsPct: 20,
rampUpStartTime: {
hour: 6,
minute: 0,
},
}],
tags: {
tag1: "value1",
tag2: "value2",
},
timeZone: "Central Standard Time",
});
import pulumi
import pulumi_azure_native as azure_native
scaling_plan = azure_native.desktopvirtualization.ScalingPlan("scalingPlan",
description="Description of Scaling Plan",
exclusion_tag="value",
friendly_name="Scaling Plan 1",
host_pool_references=[{
"host_pool_arm_path": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
"scaling_plan_enabled": True,
}],
host_pool_type=azure_native.desktopvirtualization.ScalingHostPoolType.POOLED,
location="centralus",
resource_group_name="resourceGroup1",
scaling_plan_name="scalingPlan1",
schedules=[{
"days_of_week": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
],
"name": "schedule1",
"off_peak_load_balancing_algorithm": azure_native.desktopvirtualization.SessionHostLoadBalancingAlgorithm.DEPTH_FIRST,
"off_peak_start_time": {
"hour": 20,
"minute": 0,
},
"peak_load_balancing_algorithm": azure_native.desktopvirtualization.SessionHostLoadBalancingAlgorithm.BREADTH_FIRST,
"peak_start_time": {
"hour": 8,
"minute": 0,
},
"ramp_down_capacity_threshold_pct": 50,
"ramp_down_force_logoff_users": True,
"ramp_down_load_balancing_algorithm": azure_native.desktopvirtualization.SessionHostLoadBalancingAlgorithm.DEPTH_FIRST,
"ramp_down_minimum_hosts_pct": 20,
"ramp_down_notification_message": "message",
"ramp_down_start_time": {
"hour": 18,
"minute": 0,
},
"ramp_down_wait_time_minutes": 30,
"ramp_up_capacity_threshold_pct": 80,
"ramp_up_load_balancing_algorithm": azure_native.desktopvirtualization.SessionHostLoadBalancingAlgorithm.DEPTH_FIRST,
"ramp_up_minimum_hosts_pct": 20,
"ramp_up_start_time": {
"hour": 6,
"minute": 0,
},
}],
tags={
"tag1": "value1",
"tag2": "value2",
},
time_zone="Central Standard Time")
resources:
scalingPlan:
type: azure-native:desktopvirtualization:ScalingPlan
properties:
description: Description of Scaling Plan
exclusionTag: value
friendlyName: Scaling Plan 1
hostPoolReferences:
- hostPoolArmPath: /subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1
scalingPlanEnabled: true
hostPoolType: Pooled
location: centralus
resourceGroupName: resourceGroup1
scalingPlanName: scalingPlan1
schedules:
- daysOfWeek:
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
name: schedule1
offPeakLoadBalancingAlgorithm: DepthFirst
offPeakStartTime:
hour: 20
minute: 0
peakLoadBalancingAlgorithm: BreadthFirst
peakStartTime:
hour: 8
minute: 0
rampDownCapacityThresholdPct: 50
rampDownForceLogoffUsers: true
rampDownLoadBalancingAlgorithm: DepthFirst
rampDownMinimumHostsPct: 20
rampDownNotificationMessage: message
rampDownStartTime:
hour: 18
minute: 0
rampDownWaitTimeMinutes: 30
rampUpCapacityThresholdPct: 80
rampUpLoadBalancingAlgorithm: DepthFirst
rampUpMinimumHostsPct: 20
rampUpStartTime:
hour: 6
minute: 0
tags:
tag1: value1
tag2: value2
timeZone: Central Standard Time
Create ScalingPlan Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def ScalingPlan(resource_name: str,
args: ScalingPlanArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ScalingPlan(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
time_zone: Optional[str] = None,
managed_by: Optional[str] = None,
plan: Optional[ResourceModelWithAllowedPropertySetPlanArgs] = None,
host_pool_type: Optional[Union[str, ScalingHostPoolType]] = None,
identity: Optional[ResourceModelWithAllowedPropertySetIdentityArgs] = None,
kind: Optional[str] = None,
location: Optional[str] = None,
description: Optional[str] = None,
host_pool_references: Optional[Sequence[ScalingHostPoolReferenceArgs]] = None,
friendly_name: Optional[str] = None,
scaling_plan_name: Optional[str] = None,
schedules: Optional[Sequence[ScalingScheduleArgs]] = None,
sku: Optional[ResourceModelWithAllowedPropertySetSkuArgs] = None,
tags: Optional[Mapping[str, str]] = None,
exclusion_tag: Optional[str] = None)
type: azure-native:desktopvirtualization:ScalingPlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "azure-native_desktopvirtualization_scaling_plan" "name" {
# resource properties
}
Parameters
- 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.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var scalingPlanResource = new AzureNative.DesktopVirtualization.ScalingPlan("scalingPlanResource", new()
{
ResourceGroupName = "string",
TimeZone = "string",
ManagedBy = "string",
Plan = new AzureNative.DesktopVirtualization.Inputs.ResourceModelWithAllowedPropertySetPlanArgs
{
Name = "string",
Product = "string",
Publisher = "string",
PromotionCode = "string",
Version = "string",
},
HostPoolType = "string",
Identity = new AzureNative.DesktopVirtualization.Inputs.ResourceModelWithAllowedPropertySetIdentityArgs
{
Type = AzureNative.DesktopVirtualization.ResourceIdentityType.SystemAssigned,
},
Kind = "string",
Location = "string",
Description = "string",
HostPoolReferences = new[]
{
new AzureNative.DesktopVirtualization.Inputs.ScalingHostPoolReferenceArgs
{
HostPoolArmPath = "string",
ScalingPlanEnabled = false,
},
},
FriendlyName = "string",
ScalingPlanName = "string",
Schedules = new[]
{
new AzureNative.DesktopVirtualization.Inputs.ScalingScheduleArgs
{
DaysOfWeek = new[]
{
"string",
},
Name = "string",
OffPeakLoadBalancingAlgorithm = "string",
OffPeakStartTime = new AzureNative.DesktopVirtualization.Inputs.TimeArgs
{
Hour = 0,
Minute = 0,
},
PeakLoadBalancingAlgorithm = "string",
PeakStartTime = new AzureNative.DesktopVirtualization.Inputs.TimeArgs
{
Hour = 0,
Minute = 0,
},
RampDownCapacityThresholdPct = 0,
RampDownForceLogoffUsers = false,
RampDownLoadBalancingAlgorithm = "string",
RampDownMinimumHostsPct = 0,
RampDownNotificationMessage = "string",
RampDownStartTime = new AzureNative.DesktopVirtualization.Inputs.TimeArgs
{
Hour = 0,
Minute = 0,
},
RampDownStopHostsWhen = "string",
RampDownWaitTimeMinutes = 0,
RampUpCapacityThresholdPct = 0,
RampUpLoadBalancingAlgorithm = "string",
RampUpMinimumHostsPct = 0,
RampUpStartTime = new AzureNative.DesktopVirtualization.Inputs.TimeArgs
{
Hour = 0,
Minute = 0,
},
},
},
Sku = new AzureNative.DesktopVirtualization.Inputs.ResourceModelWithAllowedPropertySetSkuArgs
{
Name = "string",
Capacity = 0,
Family = "string",
Size = "string",
Tier = AzureNative.DesktopVirtualization.SkuTier.Free,
},
Tags =
{
{ "string", "string" },
},
ExclusionTag = "string",
});
example, err := desktopvirtualization.NewScalingPlan(ctx, "scalingPlanResource", &desktopvirtualization.ScalingPlanArgs{
ResourceGroupName: pulumi.String("string"),
TimeZone: pulumi.String("string"),
ManagedBy: pulumi.String("string"),
Plan: &desktopvirtualization.ResourceModelWithAllowedPropertySetPlanArgs{
Name: pulumi.String("string"),
Product: pulumi.String("string"),
Publisher: pulumi.String("string"),
PromotionCode: pulumi.String("string"),
Version: pulumi.String("string"),
},
HostPoolType: pulumi.String("string"),
Identity: &desktopvirtualization.ResourceModelWithAllowedPropertySetIdentityArgs{
Type: desktopvirtualization.ResourceIdentityTypeSystemAssigned,
},
Kind: pulumi.String("string"),
Location: pulumi.String("string"),
Description: pulumi.String("string"),
HostPoolReferences: desktopvirtualization.ScalingHostPoolReferenceArray{
&desktopvirtualization.ScalingHostPoolReferenceArgs{
HostPoolArmPath: pulumi.String("string"),
ScalingPlanEnabled: pulumi.Bool(false),
},
},
FriendlyName: pulumi.String("string"),
ScalingPlanName: pulumi.String("string"),
Schedules: desktopvirtualization.ScalingScheduleArray{
&desktopvirtualization.ScalingScheduleArgs{
DaysOfWeek: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
OffPeakLoadBalancingAlgorithm: pulumi.String("string"),
OffPeakStartTime: &desktopvirtualization.TimeArgs{
Hour: pulumi.Int(0),
Minute: pulumi.Int(0),
},
PeakLoadBalancingAlgorithm: pulumi.String("string"),
PeakStartTime: &desktopvirtualization.TimeArgs{
Hour: pulumi.Int(0),
Minute: pulumi.Int(0),
},
RampDownCapacityThresholdPct: pulumi.Int(0),
RampDownForceLogoffUsers: pulumi.Bool(false),
RampDownLoadBalancingAlgorithm: pulumi.String("string"),
RampDownMinimumHostsPct: pulumi.Int(0),
RampDownNotificationMessage: pulumi.String("string"),
RampDownStartTime: &desktopvirtualization.TimeArgs{
Hour: pulumi.Int(0),
Minute: pulumi.Int(0),
},
RampDownStopHostsWhen: pulumi.String("string"),
RampDownWaitTimeMinutes: pulumi.Int(0),
RampUpCapacityThresholdPct: pulumi.Int(0),
RampUpLoadBalancingAlgorithm: pulumi.String("string"),
RampUpMinimumHostsPct: pulumi.Int(0),
RampUpStartTime: &desktopvirtualization.TimeArgs{
Hour: pulumi.Int(0),
Minute: pulumi.Int(0),
},
},
},
Sku: &desktopvirtualization.ResourceModelWithAllowedPropertySetSkuArgs{
Name: pulumi.String("string"),
Capacity: pulumi.Int(0),
Family: pulumi.String("string"),
Size: pulumi.String("string"),
Tier: desktopvirtualization.SkuTierFree,
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
ExclusionTag: pulumi.String("string"),
})
resource "azure-native_desktopvirtualization_scaling_plan" "scalingPlanResource" {
lifecycle {
create_before_destroy = true
}
resource_group_name = "string"
time_zone = "string"
managed_by = "string"
plan = {
name = "string"
product = "string"
publisher = "string"
promotion_code = "string"
version = "string"
}
host_pool_type = "string"
identity = {
type = "SystemAssigned"
}
kind = "string"
location = "string"
description = "string"
host_pool_references {
host_pool_arm_path = "string"
scaling_plan_enabled = false
}
friendly_name = "string"
scaling_plan_name = "string"
schedules {
days_of_week = ["string"]
name = "string"
off_peak_load_balancing_algorithm = "string"
off_peak_start_time = {
hour = 0
minute = 0
}
peak_load_balancing_algorithm = "string"
peak_start_time = {
hour = 0
minute = 0
}
ramp_down_capacity_threshold_pct = 0
ramp_down_force_logoff_users = false
ramp_down_load_balancing_algorithm = "string"
ramp_down_minimum_hosts_pct = 0
ramp_down_notification_message = "string"
ramp_down_start_time = {
hour = 0
minute = 0
}
ramp_down_stop_hosts_when = "string"
ramp_down_wait_time_minutes = 0
ramp_up_capacity_threshold_pct = 0
ramp_up_load_balancing_algorithm = "string"
ramp_up_minimum_hosts_pct = 0
ramp_up_start_time = {
hour = 0
minute = 0
}
}
sku = {
name = "string"
capacity = 0
family = "string"
size = "string"
tier = "Free"
}
tags = {
"string" = "string"
}
exclusion_tag = "string"
}
var scalingPlanResource = new ScalingPlan("scalingPlanResource", ScalingPlanArgs.builder()
.resourceGroupName("string")
.timeZone("string")
.managedBy("string")
.plan(ResourceModelWithAllowedPropertySetPlanArgs.builder()
.name("string")
.product("string")
.publisher("string")
.promotionCode("string")
.version("string")
.build())
.hostPoolType("string")
.identity(ResourceModelWithAllowedPropertySetIdentityArgs.builder()
.type(com.pulumi.azurenative.desktopvirtualization.enums.ResourceIdentityType.SystemAssigned)
.build())
.kind("string")
.location("string")
.description("string")
.hostPoolReferences(ScalingHostPoolReferenceArgs.builder()
.hostPoolArmPath("string")
.scalingPlanEnabled(false)
.build())
.friendlyName("string")
.scalingPlanName("string")
.schedules(ScalingScheduleArgs.builder()
.daysOfWeek("string")
.name("string")
.offPeakLoadBalancingAlgorithm("string")
.offPeakStartTime(com.pulumi.azurenative.desktopvirtualization.inputs.TimeArgs.builder()
.hour(0)
.minute(0)
.build())
.peakLoadBalancingAlgorithm("string")
.peakStartTime(com.pulumi.azurenative.desktopvirtualization.inputs.TimeArgs.builder()
.hour(0)
.minute(0)
.build())
.rampDownCapacityThresholdPct(0)
.rampDownForceLogoffUsers(false)
.rampDownLoadBalancingAlgorithm("string")
.rampDownMinimumHostsPct(0)
.rampDownNotificationMessage("string")
.rampDownStartTime(com.pulumi.azurenative.desktopvirtualization.inputs.TimeArgs.builder()
.hour(0)
.minute(0)
.build())
.rampDownStopHostsWhen("string")
.rampDownWaitTimeMinutes(0)
.rampUpCapacityThresholdPct(0)
.rampUpLoadBalancingAlgorithm("string")
.rampUpMinimumHostsPct(0)
.rampUpStartTime(com.pulumi.azurenative.desktopvirtualization.inputs.TimeArgs.builder()
.hour(0)
.minute(0)
.build())
.build())
.sku(ResourceModelWithAllowedPropertySetSkuArgs.builder()
.name("string")
.capacity(0)
.family("string")
.size("string")
.tier(com.pulumi.azurenative.desktopvirtualization.enums.SkuTier.Free)
.build())
.tags(Map.of("string", "string"))
.exclusionTag("string")
.build());
scaling_plan_resource = azure_native.desktopvirtualization.ScalingPlan("scalingPlanResource",
resource_group_name="string",
time_zone="string",
managed_by="string",
plan={
"name": "string",
"product": "string",
"publisher": "string",
"promotion_code": "string",
"version": "string",
},
host_pool_type="string",
identity={
"type": azure_native.desktopvirtualization.ResourceIdentityType.SYSTEM_ASSIGNED,
},
kind="string",
location="string",
description="string",
host_pool_references=[{
"host_pool_arm_path": "string",
"scaling_plan_enabled": False,
}],
friendly_name="string",
scaling_plan_name="string",
schedules=[{
"days_of_week": ["string"],
"name": "string",
"off_peak_load_balancing_algorithm": "string",
"off_peak_start_time": {
"hour": 0,
"minute": 0,
},
"peak_load_balancing_algorithm": "string",
"peak_start_time": {
"hour": 0,
"minute": 0,
},
"ramp_down_capacity_threshold_pct": 0,
"ramp_down_force_logoff_users": False,
"ramp_down_load_balancing_algorithm": "string",
"ramp_down_minimum_hosts_pct": 0,
"ramp_down_notification_message": "string",
"ramp_down_start_time": {
"hour": 0,
"minute": 0,
},
"ramp_down_stop_hosts_when": "string",
"ramp_down_wait_time_minutes": 0,
"ramp_up_capacity_threshold_pct": 0,
"ramp_up_load_balancing_algorithm": "string",
"ramp_up_minimum_hosts_pct": 0,
"ramp_up_start_time": {
"hour": 0,
"minute": 0,
},
}],
sku={
"name": "string",
"capacity": 0,
"family": "string",
"size": "string",
"tier": azure_native.desktopvirtualization.SkuTier.FREE,
},
tags={
"string": "string",
},
exclusion_tag="string")
const scalingPlanResource = new azure_native.desktopvirtualization.ScalingPlan("scalingPlanResource", {
resourceGroupName: "string",
timeZone: "string",
managedBy: "string",
plan: {
name: "string",
product: "string",
publisher: "string",
promotionCode: "string",
version: "string",
},
hostPoolType: "string",
identity: {
type: azure_native.desktopvirtualization.ResourceIdentityType.SystemAssigned,
},
kind: "string",
location: "string",
description: "string",
hostPoolReferences: [{
hostPoolArmPath: "string",
scalingPlanEnabled: false,
}],
friendlyName: "string",
scalingPlanName: "string",
schedules: [{
daysOfWeek: ["string"],
name: "string",
offPeakLoadBalancingAlgorithm: "string",
offPeakStartTime: {
hour: 0,
minute: 0,
},
peakLoadBalancingAlgorithm: "string",
peakStartTime: {
hour: 0,
minute: 0,
},
rampDownCapacityThresholdPct: 0,
rampDownForceLogoffUsers: false,
rampDownLoadBalancingAlgorithm: "string",
rampDownMinimumHostsPct: 0,
rampDownNotificationMessage: "string",
rampDownStartTime: {
hour: 0,
minute: 0,
},
rampDownStopHostsWhen: "string",
rampDownWaitTimeMinutes: 0,
rampUpCapacityThresholdPct: 0,
rampUpLoadBalancingAlgorithm: "string",
rampUpMinimumHostsPct: 0,
rampUpStartTime: {
hour: 0,
minute: 0,
},
}],
sku: {
name: "string",
capacity: 0,
family: "string",
size: "string",
tier: azure_native.desktopvirtualization.SkuTier.Free,
},
tags: {
string: "string",
},
exclusionTag: "string",
});
type: azure-native:desktopvirtualization:ScalingPlan
properties:
description: string
exclusionTag: string
friendlyName: string
hostPoolReferences:
- hostPoolArmPath: string
scalingPlanEnabled: false
hostPoolType: string
identity:
type: SystemAssigned
kind: string
location: string
managedBy: string
plan:
name: string
product: string
promotionCode: string
publisher: string
version: string
resourceGroupName: string
scalingPlanName: string
schedules:
- daysOfWeek:
- string
name: string
offPeakLoadBalancingAlgorithm: string
offPeakStartTime:
hour: 0
minute: 0
peakLoadBalancingAlgorithm: string
peakStartTime:
hour: 0
minute: 0
rampDownCapacityThresholdPct: 0
rampDownForceLogoffUsers: false
rampDownLoadBalancingAlgorithm: string
rampDownMinimumHostsPct: 0
rampDownNotificationMessage: string
rampDownStartTime:
hour: 0
minute: 0
rampDownStopHostsWhen: string
rampDownWaitTimeMinutes: 0
rampUpCapacityThresholdPct: 0
rampUpLoadBalancingAlgorithm: string
rampUpMinimumHostsPct: 0
rampUpStartTime:
hour: 0
minute: 0
sku:
capacity: 0
family: string
name: string
size: string
tier: Free
tags:
string: string
timeZone: string
ScalingPlan Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ScalingPlan resource accepts the following input properties:
- resource_group_name
string
- The name of the resource group. The name is case insensitive.
- time_zone
string
- Timezone of the scaling plan.
- description
string
- Description of scaling plan.
- exclusion_tag
string
- Exclusion tag for scaling plan.
- friendly_name
string
- User friendly name of scaling plan.
- host_pool_references
list(object)
- List of ScalingHostPoolReference definitions.
- host_pool_type
string | "Pooled"
- HostPool type for desktop.
- identity
object
- 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
- managed_by
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
object
- scaling_plan_name
string
- The name of the scaling plan.
- schedules
list(object)
- List of ScalingPlanPooledSchedule definitions.
- sku
object
- tags
map(string)
- Resource tags.
- resourceGroupName
String
- The name of the resource group. The name is case insensitive.
- timeZone
String
- Timezone of the scaling plan.
- 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 | "Pooled"
- 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
- scalingPlanName
String
- The name of the scaling plan.
- schedules
List<Property Map>
- List of ScalingPlanPooledSchedule definitions.
- sku
Property Map
- tags
Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the ScalingPlan resource produces the following output properties:
- AzureApiVersion
string
- The Azure API version of the resource.
- 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)
- SystemData
Pulumi.AzureNative.DesktopVirtualization.Outputs.SystemDataResponse
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type
string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- AzureApiVersion
string
- The Azure API version of the resource.
- 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)
- SystemData
SystemDataResponse
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type
string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure_api_version
string
- The Azure API version of the resource.
- 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
- object_id
string
- ObjectId of scaling plan. (internal use)
- system_data
object
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type
string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azureApiVersion
String
- The Azure API version of the resource.
- 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)
- systemData
SystemDataResponse
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type
String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azureApiVersion
string
- The Azure API version of the resource.
- 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)
- systemData
SystemDataResponse
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type
string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure_api_version
str
- The Azure API version of the resource.
- 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)
- system_data
SystemDataResponse
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type
str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azureApiVersion
String
- The Azure API version of the resource.
- 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)
- systemData
Property Map
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type
String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Look up Existing ScalingPlan Resource
Get an existing ScalingPlan resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static ScalingPlan get(String name, Output<String> id, CustomResourceOptions options)
resources: existingScalingPlan: type: azure-native:desktopvirtualization:ScalingPlan get: id: ${id}
import {
to = azure-native_desktopvirtualization_scaling_plan.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
ScalingPlanState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
ResourceIdentityType
The identity type.
| Name | Value |
|---|
| SystemAssigned | SystemAssigned |
| Name | Value |
|---|
| ResourceIdentityTypeSystemAssigned | SystemAssigned |
| Name | Value |
|---|
| SystemAssigned | SystemAssigned |
| Name | Value |
|---|
| SystemAssigned | SystemAssigned |
| Name | Value |
|---|
| SYSTEM_ASSIGNED | SystemAssigned |
ResourceModelWithAllowedPropertySetIdentity, ResourceModelWithAllowedPropertySetIdentityArgs
ResourceModelWithAllowedPropertySetPlan, ResourceModelWithAllowedPropertySetPlanArgs
- 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
- promotion_code
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. The value must be an UUID.
- TenantId
string
- The tenant ID of resource. The value must be an UUID.
- Type
string
- The identity type.
- PrincipalId
string
- The principal ID of resource identity. The value must be an UUID.
- TenantId
string
- The tenant ID of resource. The value must be an UUID.
- Type
string
- The identity type.
- principal_id
string
- The principal ID of resource identity. The value must be an UUID.
- tenant_id
string
- The tenant ID of resource. The value must be an UUID.
- type
string
- The identity type.
- principalId
String
- The principal ID of resource identity. The value must be an UUID.
- tenantId
String
- The tenant ID of resource. The value must be an UUID.
- type
String
- The identity type.
- principalId
string
- The principal ID of resource identity. The value must be an UUID.
- tenantId
string
- The tenant ID of resource. The value must be an UUID.
- type
string
- The identity type.
- principal_id
str
- The principal ID of resource identity. The value must be an UUID.
- tenant_id
str
- The tenant ID of resource. The value must be an UUID.
- type
str
- The identity type.
- principalId
String
- The principal ID of resource identity. The value must be an UUID.
- tenantId
String
- The tenant ID of resource. The value must be an UUID.
- 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
- promotion_code
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. E.g. 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. E.g. 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. E.g. 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
String
- The name of the SKU. E.g. 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. E.g. 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. E.g. 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. E.g. 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, ResourceModelWithAllowedPropertySetSkuArgs
- Name
string
- The name of the SKU. E.g. 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. E.g. 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. E.g. 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.
- name
String
- The name of the SKU. E.g. 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. E.g. 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. E.g. 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. E.g. 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, ScalingHostPoolReferenceArgs
Scaling plan reference to hostpool.
ScalingHostPoolReferenceResponse
Scaling plan reference to hostpool.
ScalingHostPoolType
HostPool type for desktop.
| Name | Value | Description |
|---|
| Pooled | Pooled | Users get a new (random) SessionHost every time it connects to the HostPool. |
| Name | Value | Description |
|---|
| ScalingHostPoolTypePooled | Pooled | Users get a new (random) SessionHost every time it connects to the HostPool. |
| Value | Description |
|---|
Pooled | Users get a new (random) SessionHost every time it connects to the HostPool. |
| Name | Value | Description |
|---|
| Pooled | Pooled | Users get a new (random) SessionHost every time it connects to the HostPool. |
| Name | Value | Description |
|---|
| Pooled | Pooled | Users get a new (random) SessionHost every time it connects to the HostPool. |
| Name | Value | Description |
|---|
| POOLED | Pooled | Users get a new (random) SessionHost every time it connects to the HostPool. |
| Value | Description |
|---|
Pooled | Users get a new (random) SessionHost every time it connects to the HostPool. |
ScalingSchedule, ScalingScheduleArgs
A ScalingPlanPooledSchedule.
ScalingScheduleResponse
A ScalingPlanPooledSchedule.
SessionHostLoadBalancingAlgorithm
Load balancing algorithm for ramp up period.
| Name | Value |
|---|
| BreadthFirst | BreadthFirst |
| DepthFirst | DepthFirst |
| Name | Value |
|---|
| SessionHostLoadBalancingAlgorithmBreadthFirst | BreadthFirst |
| SessionHostLoadBalancingAlgorithmDepthFirst | DepthFirst |
| Value |
|---|
BreadthFirst |
DepthFirst |
| Name | Value |
|---|
| BreadthFirst | BreadthFirst |
| DepthFirst | DepthFirst |
| Name | Value |
|---|
| BreadthFirst | BreadthFirst |
| DepthFirst | DepthFirst |
| Name | Value |
|---|
| BREADTH_FIRST | BreadthFirst |
| DEPTH_FIRST | DepthFirst |
| Value |
|---|
BreadthFirst |
DepthFirst |
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 | Value |
|---|
| Free | Free |
| Basic | Basic |
| Standard | Standard |
| Premium | Premium |
| Name | Value |
|---|
| SkuTierFree | Free |
| SkuTierBasic | Basic |
| SkuTierStandard | Standard |
| SkuTierPremium | Premium |
| Value |
|---|
Free |
Basic |
Standard |
Premium |
| Name | Value |
|---|
| Free | Free |
| Basic | Basic |
| Standard | Standard |
| Premium | Premium |
| Name | Value |
|---|
| Free | Free |
| Basic | Basic |
| Standard | Standard |
| Premium | Premium |
| Name | Value |
|---|
| FREE | Free |
| BASIC | Basic |
| STANDARD | Standard |
| PREMIUM | Premium |
| Value |
|---|
Free |
Basic |
Standard |
Premium |
StopHostsWhen
Specifies when to stop hosts during ramp down period.
| Name | Value |
|---|
| ZeroSessions | ZeroSessions |
| ZeroActiveSessions | ZeroActiveSessions |
| Name | Value |
|---|
| StopHostsWhenZeroSessions | ZeroSessions |
| StopHostsWhenZeroActiveSessions | ZeroActiveSessions |
| Value |
|---|
ZeroSessions |
ZeroActiveSessions |
| Name | Value |
|---|
| ZeroSessions | ZeroSessions |
| ZeroActiveSessions | ZeroActiveSessions |
| Name | Value |
|---|
| ZeroSessions | ZeroSessions |
| ZeroActiveSessions | ZeroActiveSessions |
| Name | Value |
|---|
| ZERO_SESSIONS | ZeroSessions |
| ZERO_ACTIVE_SESSIONS | ZeroActiveSessions |
| Value |
|---|
ZeroSessions |
ZeroActiveSessions |
SystemDataResponse
Metadata pertaining to creation and last modification of 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.
- 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.
Time, TimeArgs
The time for a scaling action to occur.
TimeResponse
The time for a scaling action to occur.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:desktopvirtualization:ScalingPlan scalingPlan1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0