Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. desktopvirtualization
  5. getScalingPlanPooledSchedule
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.desktopvirtualization.getScalingPlanPooledSchedule

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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get a ScalingPlanPooledSchedule. Azure REST API version: 2022-09-09.

    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, 2024-08-08-preview.

    Using getScalingPlanPooledSchedule

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

    function getScalingPlanPooledSchedule(args: GetScalingPlanPooledScheduleArgs, opts?: InvokeOptions): Promise<GetScalingPlanPooledScheduleResult>
function getScalingPlanPooledScheduleOutput(args: GetScalingPlanPooledScheduleOutputArgs, opts?: InvokeOptions): Output<GetScalingPlanPooledScheduleResult>
    def get_scaling_plan_pooled_schedule(resource_group_name: Optional[str] = None,
                                     scaling_plan_name: Optional[str] = None,
                                     scaling_plan_schedule_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetScalingPlanPooledScheduleResult
def get_scaling_plan_pooled_schedule_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                     scaling_plan_name: Optional[pulumi.Input[str]] = None,
                                     scaling_plan_schedule_name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetScalingPlanPooledScheduleResult]
    func LookupScalingPlanPooledSchedule(ctx *Context, args *LookupScalingPlanPooledScheduleArgs, opts ...InvokeOption) (*LookupScalingPlanPooledScheduleResult, error)
func LookupScalingPlanPooledScheduleOutput(ctx *Context, args *LookupScalingPlanPooledScheduleOutputArgs, opts ...InvokeOption) LookupScalingPlanPooledScheduleResultOutput

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

    public static class GetScalingPlanPooledSchedule 
{
    public static Task<GetScalingPlanPooledScheduleResult> InvokeAsync(GetScalingPlanPooledScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetScalingPlanPooledScheduleResult> Invoke(GetScalingPlanPooledScheduleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetScalingPlanPooledScheduleResult> getScalingPlanPooledSchedule(GetScalingPlanPooledScheduleArgs args, InvokeOptions options)
public static Output<GetScalingPlanPooledScheduleResult> getScalingPlanPooledSchedule(GetScalingPlanPooledScheduleArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ScalingPlanName string
    The name of the scaling plan.
    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.
    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.
    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.
    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.
    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.
    scalingPlanScheduleName String
    The name of the ScalingPlanSchedule

    getScalingPlanPooledSchedule Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    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"
    DaysOfWeek List<string>
    Set of days of the week on which this schedule is active.
    OffPeakLoadBalancingAlgorithm string
    Load balancing algorithm for off-peak period.
    OffPeakStartTime Pulumi.AzureNative.DesktopVirtualization.Outputs.TimeResponse
    Starting time for off-peak period.
    PeakLoadBalancingAlgorithm string
    Load balancing algorithm for peak period.
    PeakStartTime Pulumi.AzureNative.DesktopVirtualization.Outputs.TimeResponse
    Starting time for peak period.
    RampDownCapacityThresholdPct int
    Capacity threshold for ramp down period.
    RampDownForceLogoffUsers bool
    Should users be logged off forcefully from hosts.
    RampDownLoadBalancingAlgorithm string
    Load balancing algorithm for ramp down period.
    RampDownMinimumHostsPct int
    Minimum host percentage for ramp down period.
    RampDownNotificationMessage string
    Notification message for users during ramp down period.
    RampDownStartTime Pulumi.AzureNative.DesktopVirtualization.Outputs.TimeResponse
    Starting time for ramp down period.
    RampDownStopHostsWhen string
    Specifies when to stop hosts during ramp down period.
    RampDownWaitTimeMinutes int
    Number of minutes to wait to stop hosts during ramp down period.
    RampUpCapacityThresholdPct int
    Capacity threshold for ramp up period.
    RampUpLoadBalancingAlgorithm string
    Load balancing algorithm for ramp up period.
    RampUpMinimumHostsPct int
    Minimum host percentage for ramp up period.
    RampUpStartTime Pulumi.AzureNative.DesktopVirtualization.Outputs.TimeResponse
    Starting time for ramp up period.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    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"
    DaysOfWeek []string
    Set of days of the week on which this schedule is active.
    OffPeakLoadBalancingAlgorithm string
    Load balancing algorithm for off-peak period.
    OffPeakStartTime TimeResponse
    Starting time for off-peak period.
    PeakLoadBalancingAlgorithm string
    Load balancing algorithm for peak period.
    PeakStartTime TimeResponse
    Starting time for peak period.
    RampDownCapacityThresholdPct int
    Capacity threshold for ramp down period.
    RampDownForceLogoffUsers bool
    Should users be logged off forcefully from hosts.
    RampDownLoadBalancingAlgorithm string
    Load balancing algorithm for ramp down period.
    RampDownMinimumHostsPct int
    Minimum host percentage for ramp down period.
    RampDownNotificationMessage string
    Notification message for users during ramp down period.
    RampDownStartTime TimeResponse
    Starting time for ramp down period.
    RampDownStopHostsWhen string
    Specifies when to stop hosts during ramp down period.
    RampDownWaitTimeMinutes int
    Number of minutes to wait to stop hosts during ramp down period.
    RampUpCapacityThresholdPct int
    Capacity threshold for ramp up period.
    RampUpLoadBalancingAlgorithm string
    Load balancing algorithm for ramp up period.
    RampUpMinimumHostsPct int
    Minimum host percentage for ramp up period.
    RampUpStartTime TimeResponse
    Starting time for ramp up period.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    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"
    daysOfWeek List<String>
    Set of days of the week on which this schedule is active.
    offPeakLoadBalancingAlgorithm String
    Load balancing algorithm for off-peak period.
    offPeakStartTime TimeResponse
    Starting time for off-peak period.
    peakLoadBalancingAlgorithm String
    Load balancing algorithm for peak period.
    peakStartTime TimeResponse
    Starting time for peak period.
    rampDownCapacityThresholdPct Integer
    Capacity threshold for ramp down period.
    rampDownForceLogoffUsers Boolean
    Should users be logged off forcefully from hosts.
    rampDownLoadBalancingAlgorithm String
    Load balancing algorithm for ramp down period.
    rampDownMinimumHostsPct Integer
    Minimum host percentage for ramp down period.
    rampDownNotificationMessage String
    Notification message for users during ramp down period.
    rampDownStartTime TimeResponse
    Starting time for ramp down period.
    rampDownStopHostsWhen String
    Specifies when to stop hosts during ramp down period.
    rampDownWaitTimeMinutes Integer
    Number of minutes to wait to stop hosts during ramp down period.
    rampUpCapacityThresholdPct Integer
    Capacity threshold for ramp up period.
    rampUpLoadBalancingAlgorithm String
    Load balancing algorithm for ramp up period.
    rampUpMinimumHostsPct Integer
    Minimum host percentage for ramp up period.
    rampUpStartTime TimeResponse
    Starting time for ramp up period.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    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"
    daysOfWeek string[]
    Set of days of the week on which this schedule is active.
    offPeakLoadBalancingAlgorithm string
    Load balancing algorithm for off-peak period.
    offPeakStartTime TimeResponse
    Starting time for off-peak period.
    peakLoadBalancingAlgorithm string
    Load balancing algorithm for peak period.
    peakStartTime TimeResponse
    Starting time for peak period.
    rampDownCapacityThresholdPct number
    Capacity threshold for ramp down period.
    rampDownForceLogoffUsers boolean
    Should users be logged off forcefully from hosts.
    rampDownLoadBalancingAlgorithm string
    Load balancing algorithm for ramp down period.
    rampDownMinimumHostsPct number
    Minimum host percentage for ramp down period.
    rampDownNotificationMessage string
    Notification message for users during ramp down period.
    rampDownStartTime TimeResponse
    Starting time for ramp down period.
    rampDownStopHostsWhen string
    Specifies when to stop hosts during ramp down period.
    rampDownWaitTimeMinutes number
    Number of minutes to wait to stop hosts during ramp down period.
    rampUpCapacityThresholdPct number
    Capacity threshold for ramp up period.
    rampUpLoadBalancingAlgorithm string
    Load balancing algorithm for ramp up period.
    rampUpMinimumHostsPct number
    Minimum host percentage for ramp up period.
    rampUpStartTime TimeResponse
    Starting time for ramp up period.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    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"
    days_of_week Sequence[str]
    Set of days of the week on which this schedule is active.
    off_peak_load_balancing_algorithm str
    Load balancing algorithm for off-peak period.
    off_peak_start_time TimeResponse
    Starting time for off-peak period.
    peak_load_balancing_algorithm str
    Load balancing algorithm for peak period.
    peak_start_time TimeResponse
    Starting time for peak period.
    ramp_down_capacity_threshold_pct int
    Capacity threshold for ramp down period.
    ramp_down_force_logoff_users bool
    Should users be logged off forcefully from hosts.
    ramp_down_load_balancing_algorithm str
    Load balancing algorithm for ramp down period.
    ramp_down_minimum_hosts_pct int
    Minimum host percentage for ramp down period.
    ramp_down_notification_message str
    Notification message for users during ramp down period.
    ramp_down_start_time TimeResponse
    Starting time for ramp down period.
    ramp_down_stop_hosts_when str
    Specifies when to stop hosts during ramp down period.
    ramp_down_wait_time_minutes int
    Number of minutes to wait to stop hosts during ramp down period.
    ramp_up_capacity_threshold_pct int
    Capacity threshold for ramp up period.
    ramp_up_load_balancing_algorithm str
    Load balancing algorithm for ramp up period.
    ramp_up_minimum_hosts_pct int
    Minimum host percentage for ramp up period.
    ramp_up_start_time TimeResponse
    Starting time for ramp up period.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    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"
    daysOfWeek List<String>
    Set of days of the week on which this schedule is active.
    offPeakLoadBalancingAlgorithm String
    Load balancing algorithm for off-peak period.
    offPeakStartTime Property Map
    Starting time for off-peak period.
    peakLoadBalancingAlgorithm String
    Load balancing algorithm for peak period.
    peakStartTime Property Map
    Starting time for peak period.
    rampDownCapacityThresholdPct Number
    Capacity threshold for ramp down period.
    rampDownForceLogoffUsers Boolean
    Should users be logged off forcefully from hosts.
    rampDownLoadBalancingAlgorithm String
    Load balancing algorithm for ramp down period.
    rampDownMinimumHostsPct Number
    Minimum host percentage for ramp down period.
    rampDownNotificationMessage String
    Notification message for users during ramp down period.
    rampDownStartTime Property Map
    Starting time for ramp down period.
    rampDownStopHostsWhen String
    Specifies when to stop hosts during ramp down period.
    rampDownWaitTimeMinutes Number
    Number of minutes to wait to stop hosts during ramp down period.
    rampUpCapacityThresholdPct Number
    Capacity threshold for ramp up period.
    rampUpLoadBalancingAlgorithm String
    Load balancing algorithm for ramp up period.
    rampUpMinimumHostsPct Number
    Minimum host percentage for ramp up period.
    rampUpStartTime Property Map
    Starting time for ramp up period.

    Supporting Types

    SystemDataResponse

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

    TimeResponse

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

    Package Details

    Repository
    Azure Native 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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native