Scaling Plan Pooled Schedules - Create

Servicio:: Desktop Virtualization

Versión de la API:: 2025-10-10

Cree o actualice un ScalingPlanPooledSchedule.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}?api-version=2025-10-10

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
scalingPlanName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	El nombre del plan de escalado.
scalingPlanScheduleName	path	True	string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	El nombre de ScalingPlanSchedule
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.daysOfWeek	DayOfWeek[]	Conjunto de días de la semana en los que esta programación está activa.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de equilibrio de carga para el período de menor actividad.
properties.offPeakStartTime	Time	Hora de inicio del período fuera del pico.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de equilibrio de carga para el período pico.
properties.peakStartTime	Time	Hora de inicio del período máximo.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Umbral de capacidad para el período de rampa descendente.
properties.rampDownForceLogoffUsers	boolean	¿Se debe cerrar la sesión de los usuarios a la fuerza desde los hosts?
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de equilibrio de carga para el período de rampa down.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Porcentaje mínimo de host para el período de reducción de la producción.
properties.rampDownNotificationMessage	string	Mensaje de notificación para los usuarios durante el período de rampa down.
properties.rampDownStartTime	Time	Hora de inicio para el período de reducción.
properties.rampDownStopHostsWhen	StopHostsWhen	Especifica cuándo detener los hosts durante el período de rampa descendente.
properties.rampDownWaitTimeMinutes	integer (int32)	Número de minutos que se deben esperar para detener a los anfitriones durante el período de reducción.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Umbral de capacidad para el período de aceleración.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de equilibrio de carga para el período de aceleración.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Porcentaje mínimo de anfitriones para el período de aceleración.
properties.rampUpStartTime	Time	Hora de inicio del período de aumento.

Respuestas

Nombre	Tipo	Description
200 OK	ScalingPlanPooledSchedule	Actualizado con éxito ScalingPlanPooledSchedule.
201 Created	ScalingPlanPooledSchedule	Creado con éxito ScalingPlanPooledSchedule.
Other Status Codes	CloudError	Respuesta de error de automatización que describe por qué falló la operación.

Ejemplos

ScalingPlanPooledSchedules_Create

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1?api-version=2025-10-10

{
  "properties": {
    "daysOfWeek": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "rampUpStartTime": {
      "hour": 6,
      "minute": 0
    },
    "rampUpLoadBalancingAlgorithm": "DepthFirst",
    "rampUpMinimumHostsPct": 20,
    "rampUpCapacityThresholdPct": 80,
    "peakStartTime": {
      "hour": 8,
      "minute": 0
    },
    "peakLoadBalancingAlgorithm": "BreadthFirst",
    "rampDownStartTime": {
      "hour": 18,
      "minute": 0
    },
    "rampDownLoadBalancingAlgorithm": "DepthFirst",
    "rampDownMinimumHostsPct": 20,
    "rampDownCapacityThresholdPct": 50,
    "rampDownForceLogoffUsers": true,
    "rampDownWaitTimeMinutes": 30,
    "rampDownNotificationMessage": "message",
    "offPeakStartTime": {
      "hour": 20,
      "minute": 0
    },
    "offPeakLoadBalancingAlgorithm": "DepthFirst"
  }
}

Respuesta de muestra

status code:: 200

{
  "name": "scalingPlanScheduleWeekdays1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1",
  "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "daysOfWeek": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "rampUpStartTime": {
      "hour": 6,
      "minute": 0
    },
    "rampUpLoadBalancingAlgorithm": "DepthFirst",
    "rampUpMinimumHostsPct": 20,
    "rampUpCapacityThresholdPct": 80,
    "peakStartTime": {
      "hour": 8,
      "minute": 0
    },
    "peakLoadBalancingAlgorithm": "BreadthFirst",
    "rampDownStartTime": {
      "hour": 18,
      "minute": 0
    },
    "rampDownLoadBalancingAlgorithm": "DepthFirst",
    "rampDownMinimumHostsPct": 20,
    "rampDownCapacityThresholdPct": 50,
    "rampDownForceLogoffUsers": true,
    "rampDownWaitTimeMinutes": 30,
    "rampDownNotificationMessage": "message",
    "offPeakStartTime": {
      "hour": 20,
      "minute": 0
    },
    "offPeakLoadBalancingAlgorithm": "DepthFirst"
  }
}

status code:: 201

{
  "name": "scalingPlanScheduleWeekdays1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1",
  "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "daysOfWeek": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "rampUpStartTime": {
      "hour": 6,
      "minute": 0
    },
    "rampUpLoadBalancingAlgorithm": "DepthFirst",
    "rampUpMinimumHostsPct": 20,
    "rampUpCapacityThresholdPct": 80,
    "peakStartTime": {
      "hour": 8,
      "minute": 0
    },
    "peakLoadBalancingAlgorithm": "BreadthFirst",
    "rampDownStartTime": {
      "hour": 18,
      "minute": 0
    },
    "rampDownLoadBalancingAlgorithm": "DepthFirst",
    "rampDownMinimumHostsPct": 20,
    "rampDownCapacityThresholdPct": 50,
    "rampDownForceLogoffUsers": true,
    "rampDownWaitTimeMinutes": 30,
    "rampDownNotificationMessage": "message",
    "offPeakStartTime": {
      "hour": 20,
      "minute": 0
    },
    "offPeakLoadBalancingAlgorithm": "DepthFirst"
  }
}

Definiciones

Nombre	Description
CloudError	Objeto de error en la nube.
CloudErrorProperties	Propiedades del objeto de error en la nube.
createdByType	Tipo de identidad que creó el recurso.
DayOfWeek	Día de la semana.
ScalingPlanPooledSchedule	Representa una definición de ScalingPlanPooledSchedule.
SessionHostLoadBalancingAlgorithm	Algoritmo de equilibrio de carga para el período de aceleración.
StopHostsWhen	Especifica cuándo detener los hosts durante el período de rampa descendente.
systemData	Metadatos relativos a la creación y última modificación del recurso.
Time	El tiempo para que ocurra una acción de escalado.

CloudError

Objeto

Objeto de error en la nube.

Nombre	Tipo	Description
error	CloudErrorProperties	Propiedades del objeto de error en la nube.

CloudErrorProperties

Objeto

Propiedades del objeto de error en la nube.

Nombre	Tipo	Description
code	string	Código de error
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DayOfWeek

Enumeración

Día de la semana.

Valor	Description
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

ScalingPlanPooledSchedule

Objeto

Representa una definición de ScalingPlanPooledSchedule.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties.daysOfWeek	DayOfWeek[]	Conjunto de días de la semana en los que esta programación está activa.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de equilibrio de carga para el período de menor actividad.
properties.offPeakStartTime	Time	Hora de inicio del período fuera del pico.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de equilibrio de carga para el período pico.
properties.peakStartTime	Time	Hora de inicio del período máximo.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Umbral de capacidad para el período de rampa descendente.
properties.rampDownForceLogoffUsers	boolean	¿Se debe cerrar la sesión de los usuarios a la fuerza desde los hosts?
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de equilibrio de carga para el período de rampa down.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Porcentaje mínimo de host para el período de reducción de la producción.
properties.rampDownNotificationMessage	string	Mensaje de notificación para los usuarios durante el período de rampa down.
properties.rampDownStartTime	Time	Hora de inicio para el período de reducción.
properties.rampDownStopHostsWhen	StopHostsWhen	Especifica cuándo detener los hosts durante el período de rampa descendente.
properties.rampDownWaitTimeMinutes	integer (int32)	Número de minutos que se deben esperar para detener a los anfitriones durante el período de reducción.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Umbral de capacidad para el período de aceleración.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de equilibrio de carga para el período de aceleración.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Porcentaje mínimo de anfitriones para el período de aceleración.
properties.rampUpStartTime	Time	Hora de inicio del período de aumento.
systemData	systemData	Metadatos relativos a la creación y última modificación del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SessionHostLoadBalancingAlgorithm

Enumeración

Algoritmo de equilibrio de carga para el período de aceleración.

Valor	Description
BreadthFirst
DepthFirst

StopHostsWhen

Enumeración

Especifica cuándo detener los hosts durante el período de rampa descendente.

Valor	Description
ZeroSessions
ZeroActiveSessions

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Time

Objeto

El tiempo para que ocurra una acción de escalado.

Nombre	Tipo	Description
hour	integer (int32) minimum: 0 maximum: 23	Hora.
minute	integer (int32) minimum: 0 maximum: 59	El minuto.

Compartir a través de

Scaling Plan Pooled Schedules - Create

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

ScalingPlanPooledSchedules_Create

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CloudError

CloudErrorProperties

createdByType

DayOfWeek

ScalingPlanPooledSchedule

SessionHostLoadBalancingAlgorithm

StopHostsWhen

systemData

Time