Scaling Plan Pooled Schedules - Create

Service:: Desktop Virtualization

Version d'API:: 2025-10-10

Créez ou mettez à jour un ScalingPlanPooledSchedule.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
scalingPlanName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Nom du plan de mise à l’échelle.
scalingPlanScheduleName	path	True	string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Le nom du ScalingPlanSchedule
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties.daysOfWeek	DayOfWeek[]	Ensemble de jours de la semaine sur lesquels cette planification est active.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorithme d’équilibrage de charge pour la période creuse.
properties.offPeakStartTime	Time	Heure de début de la période creuse.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorithme d’équilibrage de charge pour la période de pointe.
properties.peakStartTime	Time	Heure de début de la période de pointe.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Seuil de capacité pour la période d’accélération.
properties.rampDownForceLogoffUsers	boolean	Les utilisateurs doivent être déconnectés avec force des hôtes.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorithme d’équilibrage de charge pour la période de descente en puissance.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Pourcentage d’hôte minimal pour la période de descente en puissance.
properties.rampDownNotificationMessage	string	Message de notification pour les utilisateurs pendant la période d’arrêt.
properties.rampDownStartTime	Time	Heure de début de la période de descente en puissance.
properties.rampDownStopHostsWhen	StopHostsWhen	Spécifie quand arrêter les hôtes pendant la période de descente en puissance.
properties.rampDownWaitTimeMinutes	integer (int32)	Nombre de minutes à attendre pour arrêter les hôtes pendant la période de descente en puissance.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Seuil de capacité pour la période d’accélération.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorithme d’équilibrage de charge pour une période d’accélération.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Pourcentage d’hôte minimal pour la période d’accélération.
properties.rampUpStartTime	Time	Heure de début de la période d’accélération.

Réponses

Nom	Type	Description
200 OK	ScalingPlanPooledSchedule	Mise à jour réussie de ScalingPlanPooledSchedule.
201 Created	ScalingPlanPooledSchedule	Création réussie de ScalingPlanPooledSchedule.
Other Status Codes	CloudError	Réponse d’erreur d’automatisation décrivant la raison de l’échec de l’opération.

Exemples

ScalingPlanPooledSchedules_Create

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 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"
  }
}

Définitions

Nom	Description
CloudError	Objet d’erreur cloud.
CloudErrorProperties	Propriétés de l’objet d’erreur cloud.
createdByType	Type d’identité qui a créé la ressource.
DayOfWeek	Jour de la semaine.
ScalingPlanPooledSchedule	Représente une définition ScalingPlanPooledSchedule.
SessionHostLoadBalancingAlgorithm	Algorithme d’équilibrage de charge pour une période d’accélération.
StopHostsWhen	Spécifie quand arrêter les hôtes pendant la période de descente en puissance.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
Time	Temps nécessaire à l’exécution d’une action de mise à l’échelle.

CloudError

Objet

Objet d’erreur cloud.

Nom	Type	Description
error	CloudErrorProperties	Propriétés de l’objet d’erreur cloud.

CloudErrorProperties

Objet

Propriétés de l’objet d’erreur cloud.

Nom	Type	Description
code	string	Code d’erreur
message	string	Message d’erreur indiquant pourquoi l’opération a échoué.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

DayOfWeek

Énumération

Jour de la semaine.

Valeur	Description
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

ScalingPlanPooledSchedule

Objet

Représente une définition ScalingPlanPooledSchedule.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.daysOfWeek	DayOfWeek[]	Ensemble de jours de la semaine sur lesquels cette planification est active.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorithme d’équilibrage de charge pour la période creuse.
properties.offPeakStartTime	Time	Heure de début de la période creuse.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorithme d’équilibrage de charge pour la période de pointe.
properties.peakStartTime	Time	Heure de début de la période de pointe.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Seuil de capacité pour la période d’accélération.
properties.rampDownForceLogoffUsers	boolean	Les utilisateurs doivent être déconnectés avec force des hôtes.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorithme d’équilibrage de charge pour la période de descente en puissance.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Pourcentage d’hôte minimal pour la période de descente en puissance.
properties.rampDownNotificationMessage	string	Message de notification pour les utilisateurs pendant la période d’arrêt.
properties.rampDownStartTime	Time	Heure de début de la période de descente en puissance.
properties.rampDownStopHostsWhen	StopHostsWhen	Spécifie quand arrêter les hôtes pendant la période de descente en puissance.
properties.rampDownWaitTimeMinutes	integer (int32)	Nombre de minutes à attendre pour arrêter les hôtes pendant la période de descente en puissance.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Seuil de capacité pour la période d’accélération.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorithme d’équilibrage de charge pour une période d’accélération.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Pourcentage d’hôte minimal pour la période d’accélération.
properties.rampUpStartTime	Time	Heure de début de la période d’accélération.
systemData	systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SessionHostLoadBalancingAlgorithm

Énumération

Algorithme d’équilibrage de charge pour une période d’accélération.

Valeur	Description
BreadthFirst
DepthFirst

StopHostsWhen

Énumération

Spécifie quand arrêter les hôtes pendant la période de descente en puissance.

Valeur	Description
ZeroSessions
ZeroActiveSessions

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Time

Objet

Temps nécessaire à l’exécution d’une action de mise à l’échelle.

Nom	Type	Description
hour	integer (int32) minimum: 0 maximum: 23	L’heure.
minute	integer (int32) minimum: 0 maximum: 59	La minute.

Partager via

Scaling Plan Pooled Schedules - Create

Paramètres URI

Corps de la demande

Réponses

Exemples

ScalingPlanPooledSchedules_Create

Exemple de requête

Exemple de réponse

Définitions

CloudError

CloudErrorProperties

createdByType

DayOfWeek

ScalingPlanPooledSchedule

SessionHostLoadBalancingAlgorithm

StopHostsWhen

systemData

Time