1. Packages
  2. Azure Native
  3. API Docs
  4. desktopvirtualization
  5. ScalingPlanPooledSchedule
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi

azure-native.desktopvirtualization.ScalingPlanPooledSchedule

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi

    Represents a ScalingPlanPooledSchedule definition. Azure REST API version: 2022-09-09. Prior API version in Azure Native 1.x: 2022-04-01-preview.

    Other available API versions: 2022-10-14-preview, 2023-07-07-preview, 2023-09-05, 2023-10-04-preview, 2023-11-01-preview, 2024-01-16-preview, 2024-03-06-preview, 2024-04-03, 2024-04-08-preview.

    Example Usage

    ScalingPlanPooledSchedules_Create

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var scalingPlanPooledSchedule = new AzureNative.DesktopVirtualization.ScalingPlanPooledSchedule("scalingPlanPooledSchedule", new()
        {
            DaysOfWeek = new[]
            {
                AzureNative.DesktopVirtualization.DayOfWeek.Monday,
                AzureNative.DesktopVirtualization.DayOfWeek.Tuesday,
                AzureNative.DesktopVirtualization.DayOfWeek.Wednesday,
                AzureNative.DesktopVirtualization.DayOfWeek.Thursday,
                AzureNative.DesktopVirtualization.DayOfWeek.Friday,
            },
            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,
            },
            ResourceGroupName = "resourceGroup1",
            ScalingPlanName = "scalingPlan1",
            ScalingPlanScheduleName = "scalingPlanScheduleWeekdays1",
        });
    
    });
    
    package main
    
    import (
    	desktopvirtualization "github.com/pulumi/pulumi-azure-native-sdk/desktopvirtualization/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := desktopvirtualization.NewScalingPlanPooledSchedule(ctx, "scalingPlanPooledSchedule", &desktopvirtualization.ScalingPlanPooledScheduleArgs{
    			DaysOfWeek: pulumi.StringArray{
    				pulumi.String(desktopvirtualization.DayOfWeekMonday),
    				pulumi.String(desktopvirtualization.DayOfWeekTuesday),
    				pulumi.String(desktopvirtualization.DayOfWeekWednesday),
    				pulumi.String(desktopvirtualization.DayOfWeekThursday),
    				pulumi.String(desktopvirtualization.DayOfWeekFriday),
    			},
    			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),
    			},
    			ResourceGroupName:       pulumi.String("resourceGroup1"),
    			ScalingPlanName:         pulumi.String("scalingPlan1"),
    			ScalingPlanScheduleName: pulumi.String("scalingPlanScheduleWeekdays1"),
    		})
    		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.ScalingPlanPooledSchedule;
    import com.pulumi.azurenative.desktopvirtualization.ScalingPlanPooledScheduleArgs;
    import com.pulumi.azurenative.desktopvirtualization.inputs.TimeArgs;
    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 scalingPlanPooledSchedule = new ScalingPlanPooledSchedule("scalingPlanPooledSchedule", ScalingPlanPooledScheduleArgs.builder()
                .daysOfWeek(            
                    "Monday",
                    "Tuesday",
                    "Wednesday",
                    "Thursday",
                    "Friday")
                .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())
                .resourceGroupName("resourceGroup1")
                .scalingPlanName("scalingPlan1")
                .scalingPlanScheduleName("scalingPlanScheduleWeekdays1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    scaling_plan_pooled_schedule = azure_native.desktopvirtualization.ScalingPlanPooledSchedule("scalingPlanPooledSchedule",
        days_of_week=[
            azure_native.desktopvirtualization.DayOfWeek.MONDAY,
            azure_native.desktopvirtualization.DayOfWeek.TUESDAY,
            azure_native.desktopvirtualization.DayOfWeek.WEDNESDAY,
            azure_native.desktopvirtualization.DayOfWeek.THURSDAY,
            azure_native.desktopvirtualization.DayOfWeek.FRIDAY,
        ],
        off_peak_load_balancing_algorithm=azure_native.desktopvirtualization.SessionHostLoadBalancingAlgorithm.DEPTH_FIRST,
        off_peak_start_time=azure_native.desktopvirtualization.TimeArgs(
            hour=20,
            minute=0,
        ),
        peak_load_balancing_algorithm=azure_native.desktopvirtualization.SessionHostLoadBalancingAlgorithm.BREADTH_FIRST,
        peak_start_time=azure_native.desktopvirtualization.TimeArgs(
            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=azure_native.desktopvirtualization.TimeArgs(
            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=azure_native.desktopvirtualization.TimeArgs(
            hour=6,
            minute=0,
        ),
        resource_group_name="resourceGroup1",
        scaling_plan_name="scalingPlan1",
        scaling_plan_schedule_name="scalingPlanScheduleWeekdays1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const scalingPlanPooledSchedule = new azure_native.desktopvirtualization.ScalingPlanPooledSchedule("scalingPlanPooledSchedule", {
        daysOfWeek: [
            azure_native.desktopvirtualization.DayOfWeek.Monday,
            azure_native.desktopvirtualization.DayOfWeek.Tuesday,
            azure_native.desktopvirtualization.DayOfWeek.Wednesday,
            azure_native.desktopvirtualization.DayOfWeek.Thursday,
            azure_native.desktopvirtualization.DayOfWeek.Friday,
        ],
        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,
        },
        resourceGroupName: "resourceGroup1",
        scalingPlanName: "scalingPlan1",
        scalingPlanScheduleName: "scalingPlanScheduleWeekdays1",
    });
    
    resources:
      scalingPlanPooledSchedule:
        type: azure-native:desktopvirtualization:ScalingPlanPooledSchedule
        properties:
          daysOfWeek:
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
          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
          resourceGroupName: resourceGroup1
          scalingPlanName: scalingPlan1
          scalingPlanScheduleName: scalingPlanScheduleWeekdays1
    

    Create ScalingPlanPooledSchedule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ScalingPlanPooledSchedule(name: string, args: ScalingPlanPooledScheduleArgs, opts?: CustomResourceOptions);
    @overload
    def ScalingPlanPooledSchedule(resource_name: str,
                                  args: ScalingPlanPooledScheduleArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def ScalingPlanPooledSchedule(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  resource_group_name: Optional[str] = None,
                                  scaling_plan_name: Optional[str] = None,
                                  ramp_down_start_time: Optional[TimeArgs] = None,
                                  ramp_down_stop_hosts_when: Optional[Union[str, StopHostsWhen]] = None,
                                  peak_start_time: Optional[TimeArgs] = None,
                                  ramp_down_capacity_threshold_pct: Optional[int] = None,
                                  ramp_down_force_logoff_users: Optional[bool] = None,
                                  ramp_down_load_balancing_algorithm: Optional[Union[str, SessionHostLoadBalancingAlgorithm]] = None,
                                  ramp_down_minimum_hosts_pct: Optional[int] = None,
                                  ramp_down_notification_message: Optional[str] = None,
                                  days_of_week: Optional[Sequence[Union[str, DayOfWeek]]] = None,
                                  peak_load_balancing_algorithm: Optional[Union[str, SessionHostLoadBalancingAlgorithm]] = None,
                                  ramp_down_wait_time_minutes: Optional[int] = None,
                                  ramp_up_capacity_threshold_pct: Optional[int] = None,
                                  ramp_up_load_balancing_algorithm: Optional[Union[str, SessionHostLoadBalancingAlgorithm]] = None,
                                  ramp_up_minimum_hosts_pct: Optional[int] = None,
                                  ramp_up_start_time: Optional[TimeArgs] = None,
                                  off_peak_start_time: Optional[TimeArgs] = None,
                                  off_peak_load_balancing_algorithm: Optional[Union[str, SessionHostLoadBalancingAlgorithm]] = None,
                                  scaling_plan_schedule_name: Optional[str] = None)
    func NewScalingPlanPooledSchedule(ctx *Context, name string, args ScalingPlanPooledScheduleArgs, opts ...ResourceOption) (*ScalingPlanPooledSchedule, error)
    public ScalingPlanPooledSchedule(string name, ScalingPlanPooledScheduleArgs args, CustomResourceOptions? opts = null)
    public ScalingPlanPooledSchedule(String name, ScalingPlanPooledScheduleArgs args)
    public ScalingPlanPooledSchedule(String name, ScalingPlanPooledScheduleArgs args, CustomResourceOptions options)
    
    type: azure-native:desktopvirtualization:ScalingPlanPooledSchedule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ScalingPlanPooledScheduleArgs
    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 ScalingPlanPooledScheduleArgs
    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 ScalingPlanPooledScheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScalingPlanPooledScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScalingPlanPooledScheduleArgs
    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 scalingPlanPooledScheduleResource = new AzureNative.DesktopVirtualization.ScalingPlanPooledSchedule("scalingPlanPooledScheduleResource", new()
    {
        ResourceGroupName = "string",
        ScalingPlanName = "string",
        RampDownStartTime = new AzureNative.DesktopVirtualization.Inputs.TimeArgs
        {
            Hour = 0,
            Minute = 0,
        },
        RampDownStopHostsWhen = "string",
        PeakStartTime = new AzureNative.DesktopVirtualization.Inputs.TimeArgs
        {
            Hour = 0,
            Minute = 0,
        },
        RampDownCapacityThresholdPct = 0,
        RampDownForceLogoffUsers = false,
        RampDownLoadBalancingAlgorithm = "string",
        RampDownMinimumHostsPct = 0,
        RampDownNotificationMessage = "string",
        DaysOfWeek = new[]
        {
            "string",
        },
        PeakLoadBalancingAlgorithm = "string",
        RampDownWaitTimeMinutes = 0,
        RampUpCapacityThresholdPct = 0,
        RampUpLoadBalancingAlgorithm = "string",
        RampUpMinimumHostsPct = 0,
        RampUpStartTime = new AzureNative.DesktopVirtualization.Inputs.TimeArgs
        {
            Hour = 0,
            Minute = 0,
        },
        OffPeakStartTime = new AzureNative.DesktopVirtualization.Inputs.TimeArgs
        {
            Hour = 0,
            Minute = 0,
        },
        OffPeakLoadBalancingAlgorithm = "string",
        ScalingPlanScheduleName = "string",
    });
    
    example, err := desktopvirtualization.NewScalingPlanPooledSchedule(ctx, "scalingPlanPooledScheduleResource", &desktopvirtualization.ScalingPlanPooledScheduleArgs{
    ResourceGroupName: pulumi.String("string"),
    ScalingPlanName: pulumi.String("string"),
    RampDownStartTime: &desktopvirtualization.TimeArgs{
    Hour: pulumi.Int(0),
    Minute: pulumi.Int(0),
    },
    RampDownStopHostsWhen: 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"),
    DaysOfWeek: pulumi.StringArray{
    pulumi.String("string"),
    },
    PeakLoadBalancingAlgorithm: 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),
    },
    OffPeakStartTime: &desktopvirtualization.TimeArgs{
    Hour: pulumi.Int(0),
    Minute: pulumi.Int(0),
    },
    OffPeakLoadBalancingAlgorithm: pulumi.String("string"),
    ScalingPlanScheduleName: pulumi.String("string"),
    })
    
    var scalingPlanPooledScheduleResource = new ScalingPlanPooledSchedule("scalingPlanPooledScheduleResource", ScalingPlanPooledScheduleArgs.builder()
        .resourceGroupName("string")
        .scalingPlanName("string")
        .rampDownStartTime(TimeArgs.builder()
            .hour(0)
            .minute(0)
            .build())
        .rampDownStopHostsWhen("string")
        .peakStartTime(TimeArgs.builder()
            .hour(0)
            .minute(0)
            .build())
        .rampDownCapacityThresholdPct(0)
        .rampDownForceLogoffUsers(false)
        .rampDownLoadBalancingAlgorithm("string")
        .rampDownMinimumHostsPct(0)
        .rampDownNotificationMessage("string")
        .daysOfWeek("string")
        .peakLoadBalancingAlgorithm("string")
        .rampDownWaitTimeMinutes(0)
        .rampUpCapacityThresholdPct(0)
        .rampUpLoadBalancingAlgorithm("string")
        .rampUpMinimumHostsPct(0)
        .rampUpStartTime(TimeArgs.builder()
            .hour(0)
            .minute(0)
            .build())
        .offPeakStartTime(TimeArgs.builder()
            .hour(0)
            .minute(0)
            .build())
        .offPeakLoadBalancingAlgorithm("string")
        .scalingPlanScheduleName("string")
        .build());
    
    scaling_plan_pooled_schedule_resource = azure_native.desktopvirtualization.ScalingPlanPooledSchedule("scalingPlanPooledScheduleResource",
        resource_group_name="string",
        scaling_plan_name="string",
        ramp_down_start_time=azure_native.desktopvirtualization.TimeArgs(
            hour=0,
            minute=0,
        ),
        ramp_down_stop_hosts_when="string",
        peak_start_time=azure_native.desktopvirtualization.TimeArgs(
            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",
        days_of_week=["string"],
        peak_load_balancing_algorithm="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=azure_native.desktopvirtualization.TimeArgs(
            hour=0,
            minute=0,
        ),
        off_peak_start_time=azure_native.desktopvirtualization.TimeArgs(
            hour=0,
            minute=0,
        ),
        off_peak_load_balancing_algorithm="string",
        scaling_plan_schedule_name="string")
    
    const scalingPlanPooledScheduleResource = new azure_native.desktopvirtualization.ScalingPlanPooledSchedule("scalingPlanPooledScheduleResource", {
        resourceGroupName: "string",
        scalingPlanName: "string",
        rampDownStartTime: {
            hour: 0,
            minute: 0,
        },
        rampDownStopHostsWhen: "string",
        peakStartTime: {
            hour: 0,
            minute: 0,
        },
        rampDownCapacityThresholdPct: 0,
        rampDownForceLogoffUsers: false,
        rampDownLoadBalancingAlgorithm: "string",
        rampDownMinimumHostsPct: 0,
        rampDownNotificationMessage: "string",
        daysOfWeek: ["string"],
        peakLoadBalancingAlgorithm: "string",
        rampDownWaitTimeMinutes: 0,
        rampUpCapacityThresholdPct: 0,
        rampUpLoadBalancingAlgorithm: "string",
        rampUpMinimumHostsPct: 0,
        rampUpStartTime: {
            hour: 0,
            minute: 0,
        },
        offPeakStartTime: {
            hour: 0,
            minute: 0,
        },
        offPeakLoadBalancingAlgorithm: "string",
        scalingPlanScheduleName: "string",
    });
    
    type: azure-native:desktopvirtualization:ScalingPlanPooledSchedule
    properties:
        daysOfWeek:
            - 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
        resourceGroupName: string
        scalingPlanName: string
        scalingPlanScheduleName: string
    

    ScalingPlanPooledSchedule 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 ScalingPlanPooledSchedule resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ScalingPlanName string
    The name of the scaling plan.
    DaysOfWeek List<Union<string, Pulumi.AzureNative.DesktopVirtualization.DayOfWeek>>
    Set of days of the week on which this schedule is active.
    OffPeakLoadBalancingAlgorithm string | Pulumi.AzureNative.DesktopVirtualization.SessionHostLoadBalancingAlgorithm
    Load balancing algorithm for off-peak period.
    OffPeakStartTime Pulumi.AzureNative.DesktopVirtualization.Inputs.Time
    Starting time for off-peak period.
    PeakLoadBalancingAlgorithm string | Pulumi.AzureNative.DesktopVirtualization.SessionHostLoadBalancingAlgorithm
    Load balancing algorithm for peak period.
    PeakStartTime Pulumi.AzureNative.DesktopVirtualization.Inputs.Time
    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 Pulumi.AzureNative.DesktopVirtualization.Inputs.Time
    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 Pulumi.AzureNative.DesktopVirtualization.Inputs.Time
    Starting time for ramp up period.
    ScalingPlanScheduleName string
    The name of the ScalingPlanSchedule
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ScalingPlanName string
    The name of the scaling plan.
    DaysOfWeek []string
    Set of days of the week on which this schedule is active.
    OffPeakLoadBalancingAlgorithm string | SessionHostLoadBalancingAlgorithm
    Load balancing algorithm for off-peak period.
    OffPeakStartTime TimeArgs
    Starting time for off-peak period.
    PeakLoadBalancingAlgorithm string | SessionHostLoadBalancingAlgorithm
    Load balancing algorithm for peak period.
    PeakStartTime TimeArgs
    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 TimeArgs
    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 TimeArgs
    Starting time for ramp up period.
    ScalingPlanScheduleName string
    The name of the ScalingPlanSchedule
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    scalingPlanName String
    The name of the scaling plan.
    daysOfWeek List<Either<String,DayOfWeek>>
    Set of days of the week on which this schedule is active.
    offPeakLoadBalancingAlgorithm String | SessionHostLoadBalancingAlgorithm
    Load balancing algorithm for off-peak period.
    offPeakStartTime Time
    Starting time for off-peak period.
    peakLoadBalancingAlgorithm String | SessionHostLoadBalancingAlgorithm
    Load balancing algorithm for peak period.
    peakStartTime Time
    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 Time
    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 Time
    Starting time for ramp up period.
    scalingPlanScheduleName String
    The name of the ScalingPlanSchedule
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    scalingPlanName string
    The name of the scaling plan.
    daysOfWeek (string | DayOfWeek)[]
    Set of days of the week on which this schedule is active.
    offPeakLoadBalancingAlgorithm string | SessionHostLoadBalancingAlgorithm
    Load balancing algorithm for off-peak period.
    offPeakStartTime Time
    Starting time for off-peak period.
    peakLoadBalancingAlgorithm string | SessionHostLoadBalancingAlgorithm
    Load balancing algorithm for peak period.
    peakStartTime Time
    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 Time
    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 Time
    Starting time for ramp up period.
    scalingPlanScheduleName string
    The name of the ScalingPlanSchedule
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    scaling_plan_name str
    The name of the scaling plan.
    days_of_week Sequence[Union[str, DayOfWeek]]
    Set of days of the week on which this schedule is active.
    off_peak_load_balancing_algorithm str | SessionHostLoadBalancingAlgorithm
    Load balancing algorithm for off-peak period.
    off_peak_start_time TimeArgs
    Starting time for off-peak period.
    peak_load_balancing_algorithm str | SessionHostLoadBalancingAlgorithm
    Load balancing algorithm for peak period.
    peak_start_time TimeArgs
    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 TimeArgs
    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 TimeArgs
    Starting time for ramp up period.
    scaling_plan_schedule_name str
    The name of the ScalingPlanSchedule
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    scalingPlanName String
    The name of the scaling plan.
    daysOfWeek List<String | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday">
    Set of days of the week on which this schedule is active.
    offPeakLoadBalancingAlgorithm String | "BreadthFirst" | "DepthFirst"
    Load balancing algorithm for off-peak period.
    offPeakStartTime Property Map
    Starting time for off-peak period.
    peakLoadBalancingAlgorithm String | "BreadthFirst" | "DepthFirst"
    Load balancing algorithm for peak period.
    peakStartTime Property Map
    Starting time for peak period.
    rampDownCapacityThresholdPct Number
    Capacity threshold for ramp down period.
    rampDownForceLogoffUsers Boolean
    Should users be logged off forcefully from hosts.
    rampDownLoadBalancingAlgorithm String | "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 Property Map
    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 Property Map
    Starting time for ramp up period.
    scalingPlanScheduleName String
    The name of the ScalingPlanSchedule

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.DesktopVirtualization.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    DayOfWeek, DayOfWeekArgs

    Monday
    Monday
    Tuesday
    Tuesday
    Wednesday
    Wednesday
    Thursday
    Thursday
    Friday
    Friday
    Saturday
    Saturday
    Sunday
    Sunday
    DayOfWeekMonday
    Monday
    DayOfWeekTuesday
    Tuesday
    DayOfWeekWednesday
    Wednesday
    DayOfWeekThursday
    Thursday
    DayOfWeekFriday
    Friday
    DayOfWeekSaturday
    Saturday
    DayOfWeekSunday
    Sunday
    Monday
    Monday
    Tuesday
    Tuesday
    Wednesday
    Wednesday
    Thursday
    Thursday
    Friday
    Friday
    Saturday
    Saturday
    Sunday
    Sunday
    Monday
    Monday
    Tuesday
    Tuesday
    Wednesday
    Wednesday
    Thursday
    Thursday
    Friday
    Friday
    Saturday
    Saturday
    Sunday
    Sunday
    MONDAY
    Monday
    TUESDAY
    Tuesday
    WEDNESDAY
    Wednesday
    THURSDAY
    Thursday
    FRIDAY
    Friday
    SATURDAY
    Saturday
    SUNDAY
    Sunday
    "Monday"
    Monday
    "Tuesday"
    Tuesday
    "Wednesday"
    Wednesday
    "Thursday"
    Thursday
    "Friday"
    Friday
    "Saturday"
    Saturday
    "Sunday"
    Sunday

    SessionHostLoadBalancingAlgorithm, SessionHostLoadBalancingAlgorithmArgs

    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

    StopHostsWhen, StopHostsWhenArgs

    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

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Time, TimeArgs

    Hour int
    The hour.
    Minute int
    The minute.
    Hour int
    The hour.
    Minute int
    The minute.
    hour Integer
    The hour.
    minute Integer
    The minute.
    hour number
    The hour.
    minute number
    The minute.
    hour int
    The hour.
    minute int
    The minute.
    hour Number
    The hour.
    minute Number
    The minute.

    TimeResponse, TimeResponseArgs

    Hour int
    The hour.
    Minute int
    The minute.
    Hour int
    The hour.
    Minute int
    The minute.
    hour Integer
    The hour.
    minute Integer
    The minute.
    hour number
    The hour.
    minute number
    The minute.
    hour int
    The hour.
    minute int
    The minute.
    hour Number
    The hour.
    minute Number
    The minute.

    Import

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

    $ pulumi import azure-native:desktopvirtualization:ScalingPlanPooledSchedule scalingPlanScheduleWeekdays1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi