Scaling Plan Pooled Schedules - Create

Serviço:: Desktop Virtualization

Versão da API:: 2025-10-10

Crie ou atualize um ScalingPlanPooledSchedule.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
scalingPlanName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	O nome do plano de dimensionamento.
scalingPlanScheduleName	path	True	string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	O nome do ScalingPlanSchedule
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties.daysOfWeek	DayOfWeek[]	Conjunto de dias da semana em que este horário está ativo.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para período fora de pico.
properties.offPeakStartTime	Time	Hora de início para o período fora de pico.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de pico.
properties.peakStartTime	Time	Hora de início para o período de pico.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Limite de capacidade para o período de rampa descendente.
properties.rampDownForceLogoffUsers	boolean	Os usuários devem ser desconectados com força dos hosts.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de rampa down.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Percentagem mínima de anfitrião para o período de rampa down.
properties.rampDownNotificationMessage	string	Mensagem de notificação para usuários durante o período de ramp down.
properties.rampDownStartTime	Time	Hora de início para o período de rampa down.
properties.rampDownStopHostsWhen	StopHostsWhen	Especifica quando parar hosts durante o período de rampa down.
properties.rampDownWaitTimeMinutes	integer (int32)	Número de minutos de espera para parar os anfitriões durante o período de rampa down.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Limite de capacidade para o período de ramp up.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de ramp up.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Porcentagem mínima de host para o período de ramp up.
properties.rampUpStartTime	Time	Hora de início para o período de ramp up.

Respostas

Name	Tipo	Description
200 OK	ScalingPlanPooledSchedule	Atualizado com sucesso o ScalingPlanPooledSchedule.
201 Created	ScalingPlanPooledSchedule	Criei com sucesso o ScalingPlanPooledSchedule.
Other Status Codes	CloudError	Resposta de erro de automação descrevendo por que a operação falhou.

Exemplos

ScalingPlanPooledSchedules_Create

Pedido de amostra

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"
  }
}

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 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"
  }
}

Definições

Name	Description
CloudError	Objeto de erro na nuvem.
CloudErrorProperties	Propriedades do objeto de erro na nuvem.
createdByType	O tipo de identidade que criou o recurso.
DayOfWeek	Dia da semana.
ScalingPlanPooledSchedule	Representa uma definição ScalingPlanPooledSchedule.
SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de ramp up.
StopHostsWhen	Especifica quando parar hosts durante o período de rampa down.
systemData	Metadados referentes à criação e última modificação do recurso.
Time	O tempo para uma ação de dimensionamento ocorrer.

CloudError

Object

Objeto de erro na nuvem.

Name	Tipo	Description
error	CloudErrorProperties	Propriedades do objeto de erro na nuvem.

CloudErrorProperties

Object

Propriedades do objeto de erro na nuvem.

Name	Tipo	Description
code	string	Código de erro
message	string	Mensagem de erro indicando por que a operação falhou.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DayOfWeek

Enumeração

Dia da semana.

Valor	Description
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

ScalingPlanPooledSchedule

Object

Representa uma definição ScalingPlanPooledSchedule.

Name	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.daysOfWeek	DayOfWeek[]	Conjunto de dias da semana em que este horário está ativo.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para período fora de pico.
properties.offPeakStartTime	Time	Hora de início para o período fora de pico.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de pico.
properties.peakStartTime	Time	Hora de início para o período de pico.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Limite de capacidade para o período de rampa descendente.
properties.rampDownForceLogoffUsers	boolean	Os usuários devem ser desconectados com força dos hosts.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de rampa down.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Percentagem mínima de anfitrião para o período de rampa down.
properties.rampDownNotificationMessage	string	Mensagem de notificação para usuários durante o período de ramp down.
properties.rampDownStartTime	Time	Hora de início para o período de rampa down.
properties.rampDownStopHostsWhen	StopHostsWhen	Especifica quando parar hosts durante o período de rampa down.
properties.rampDownWaitTimeMinutes	integer (int32)	Número de minutos de espera para parar os anfitriões durante o período de rampa down.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Limite de capacidade para o período de ramp up.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de ramp up.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Porcentagem mínima de host para o período de ramp up.
properties.rampUpStartTime	Time	Hora de início para o período de ramp up.
systemData	systemData	Metadados referentes à criação e última modificação do recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SessionHostLoadBalancingAlgorithm

Enumeração

Algoritmo de balanceamento de carga para o período de ramp up.

Valor	Description
BreadthFirst
DepthFirst

StopHostsWhen

Enumeração

Especifica quando parar hosts durante o período de rampa down.

Valor	Description
ZeroSessions
ZeroActiveSessions

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Time

Object

O tempo para uma ação de dimensionamento ocorrer.

Name	Tipo	Description
hour	integer (int32) minimum: 0 maximum: 23	A hora.
minute	integer (int32) minimum: 0 maximum: 59	O minuto.

Partilhar via

Scaling Plan Pooled Schedules - Create

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

ScalingPlanPooledSchedules_Create

Pedido de amostra

Resposta da amostra

Definições

CloudError

CloudErrorProperties

createdByType

DayOfWeek

ScalingPlanPooledSchedule

SessionHostLoadBalancingAlgorithm

StopHostsWhen

systemData

Time