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 de URI

Nome	Em	Obrigató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 escalabilidade.
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 uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	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	Tempo de início para o período fora do pico.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de pico.
properties.peakStartTime	Time	Hora de início do período de pico.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Limite de capacidade para o período de redução de rampa.
properties.rampDownForceLogoffUsers	boolean	Os usuários devem ser desconectados à força dos hosts.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de redução de rampa.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Porcentagem mínima de host para o período de redução de rampa.
properties.rampDownNotificationMessage	string	Mensagem de notificação para usuários durante o período de redução.
properties.rampDownStartTime	Time	Tempo de partida para o período de rampa para baixo.
properties.rampDownStopHostsWhen	StopHostsWhen	Especifica quando parar os hosts durante o período de redução.
properties.rampDownWaitTimeMinutes	integer (int32)	Número de minutos de espera para interromper os hosts durante o período de desativação.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Limite de capacidade para o período de aceleração.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de aceleração.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Porcentagem mínima de host para o período de aceleração.
properties.rampUpStartTime	Time	Tempo de início para o período de aumento.

Respostas

Nome	Tipo	Description
200 OK	ScalingPlanPooledSchedule	Atualizei 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

Solicitação de exemplo

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 de exemplo

Código de status:: 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 status:: 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

Nome	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 de ScalingPlanPooledSchedule.
SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de aceleração.
StopHostsWhen	Especifica quando parar os hosts durante o período de redução.
systemData	Metadados relativos à criação e última modificação do recurso.
Time	O tempo para que uma ação de escalabilidade ocorra.

CloudError

Objeto

Objeto de erro na nuvem.

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

CloudErrorProperties

Objeto

Propriedades do objeto de erro na nuvem.

Nome	Tipo	Description
code	string	Código do 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

Objeto

Representa uma definição de ScalingPlanPooledSchedule.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada 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	Tempo de início para o período fora do pico.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de pico.
properties.peakStartTime	Time	Hora de início do período de pico.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Limite de capacidade para o período de redução de rampa.
properties.rampDownForceLogoffUsers	boolean	Os usuários devem ser desconectados à força dos hosts.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de redução de rampa.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Porcentagem mínima de host para o período de redução de rampa.
properties.rampDownNotificationMessage	string	Mensagem de notificação para usuários durante o período de redução.
properties.rampDownStartTime	Time	Tempo de partida para o período de rampa para baixo.
properties.rampDownStopHostsWhen	StopHostsWhen	Especifica quando parar os hosts durante o período de redução.
properties.rampDownWaitTimeMinutes	integer (int32)	Número de minutos de espera para interromper os hosts durante o período de desativação.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Limite de capacidade para o período de aceleração.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de aceleração.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Porcentagem mínima de host para o período de aceleração.
properties.rampUpStartTime	Time	Tempo de início para o período de aumento.
systemData	systemData	Metadados relativos à 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 aceleração.

Valor	Description
BreadthFirst
DepthFirst

StopHostsWhen

Enumeração

Especifica quando parar os hosts durante o período de redução.

Valor	Description
ZeroSessions
ZeroActiveSessions

systemData

Objeto

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

Nome	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

Objeto

O tempo para que uma ação de escalabilidade ocorra.

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

Compartilhar via

Scaling Plan Pooled Schedules - Create

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

ScalingPlanPooledSchedules_Create

Solicitação de exemplo

Resposta de exemplo

Definições

CloudError

CloudErrorProperties

createdByType

DayOfWeek

ScalingPlanPooledSchedule

SessionHostLoadBalancingAlgorithm

StopHostsWhen

systemData

Time