@pulumi/azure-native/desktopvirtualization/getScalingPlanPooledSchedule.d.ts

[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Get a ScalingPlanPooledSchedule.
 *
 * Uses Azure REST API version 2024-04-03.
 *
 * 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. 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
 */
export declare function getScalingPlanPooledSchedule(args: GetScalingPlanPooledScheduleArgs, opts?: pulumi.InvokeOptions): Promise<GetScalingPlanPooledScheduleResult>;
export interface GetScalingPlanPooledScheduleArgs {
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: string;
    /**
     * The name of the scaling plan.
     */
    scalingPlanName: string;
    /**
     * The name of the ScalingPlanSchedule
     */
    scalingPlanScheduleName: string;
}
/**
 * Represents a ScalingPlanPooledSchedule definition.
 */
export interface GetScalingPlanPooledScheduleResult {
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: string;
    /**
     * Set of days of the week on which this schedule is active.
     */
    readonly daysOfWeek?: string[];
    /**
     * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
     */
    readonly id: string;
    /**
     * The name of the resource
     */
    readonly name: string;
    /**
     * Load balancing algorithm for off-peak period.
     */
    readonly offPeakLoadBalancingAlgorithm?: string;
    /**
     * Starting time for off-peak period.
     */
    readonly offPeakStartTime?: outputs.desktopvirtualization.TimeResponse;
    /**
     * Load balancing algorithm for peak period.
     */
    readonly peakLoadBalancingAlgorithm?: string;
    /**
     * Starting time for peak period.
     */
    readonly peakStartTime?: outputs.desktopvirtualization.TimeResponse;
    /**
     * Capacity threshold for ramp down period.
     */
    readonly rampDownCapacityThresholdPct?: number;
    /**
     * Should users be logged off forcefully from hosts.
     */
    readonly rampDownForceLogoffUsers?: boolean;
    /**
     * Load balancing algorithm for ramp down period.
     */
    readonly rampDownLoadBalancingAlgorithm?: string;
    /**
     * Minimum host percentage for ramp down period.
     */
    readonly rampDownMinimumHostsPct?: number;
    /**
     * Notification message for users during ramp down period.
     */
    readonly rampDownNotificationMessage?: string;
    /**
     * Starting time for ramp down period.
     */
    readonly rampDownStartTime?: outputs.desktopvirtualization.TimeResponse;
    /**
     * Specifies when to stop hosts during ramp down period.
     */
    readonly rampDownStopHostsWhen?: string;
    /**
     * Number of minutes to wait to stop hosts during ramp down period.
     */
    readonly rampDownWaitTimeMinutes?: number;
    /**
     * Capacity threshold for ramp up period.
     */
    readonly rampUpCapacityThresholdPct?: number;
    /**
     * Load balancing algorithm for ramp up period.
     */
    readonly rampUpLoadBalancingAlgorithm?: string;
    /**
     * Minimum host percentage for ramp up period.
     */
    readonly rampUpMinimumHostsPct?: number;
    /**
     * Starting time for ramp up period.
     */
    readonly rampUpStartTime?: outputs.desktopvirtualization.TimeResponse;
    /**
     * Azure Resource Manager metadata containing createdBy and modifiedBy information.
     */
    readonly systemData: outputs.desktopvirtualization.SystemDataResponse;
    /**
     * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
     */
    readonly type: string;
}
/**
 * Get a ScalingPlanPooledSchedule.
 *
 * Uses Azure REST API version 2024-04-03.
 *
 * 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. 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
 */
export declare function getScalingPlanPooledScheduleOutput(args: GetScalingPlanPooledScheduleOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetScalingPlanPooledScheduleResult>;
export interface GetScalingPlanPooledScheduleOutputArgs {
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: pulumi.Input<string>;
    /**
     * The name of the scaling plan.
     */
    scalingPlanName: pulumi.Input<string>;
    /**
     * The name of the ScalingPlanSchedule
     */
    scalingPlanScheduleName: pulumi.Input<string>;
}