Scaling Plan Pooled Schedules - Create

Dienst:: Desktop Virtualization

API-Version:: 2025-10-10

Erstellen oder aktualisieren Sie einen ScalingPlanPooledSchedule.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
scalingPlanName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Der Name des Skalierungsplans.
scalingPlanScheduleName	path	True	string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Der Name des ScalingPlanSchedule
subscriptionId	path	True	string (uuid)	Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
properties.daysOfWeek	DayOfWeek[]	Satz von Tagen der Woche, an denen dieser Zeitplan aktiv ist.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Lastenausgleichsalgorithmus für off-peak period.
properties.offPeakStartTime	Time	Startzeit für den Zeitraum außerhalb des Höchstwerts.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Lastenausgleichsalgorithmus für Spitzenzeitpunkt.
properties.peakStartTime	Time	Startzeit für Spitzenzeit.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Kapazitätsschwellenwert für Den Rampdownzeitraum.
properties.rampDownForceLogoffUsers	boolean	Sollten Benutzer erzwungen von Hosts abgemeldet werden.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Lastenausgleichsalgorithmus für ramp down period.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minimaler Hostprozentsatz für ramp down period.
properties.rampDownNotificationMessage	string	Benachrichtigung für Benutzer während des Rampdownzeitraums.
properties.rampDownStartTime	Time	Startzeit für ramp down period.
properties.rampDownStopHostsWhen	StopHostsWhen	Gibt an, wann Hosts während des Rampdownzeitraums beendet werden sollen.
properties.rampDownWaitTimeMinutes	integer (int32)	Die Anzahl der Minuten, um zu warten, bis Hosts während des Ramp down-Zeitraums beendet werden.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Kapazitätsschwellenwert für den Hochlaufzeitraum.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Lastenausgleichsalgorithmus für den Hochlaufzeitraum.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minimaler Hostprozentsatz für den Hochlaufzeitraum.
properties.rampUpStartTime	Time	Startzeit für den Hochstartzeitraum.

Antworten

Name	Typ	Beschreibung
200 OK	ScalingPlanPooledSchedule	ScalingPlanPooledSchedule erfolgreich aktualisiert.
201 Created	ScalingPlanPooledSchedule	Erfolgreich erstellte ScalingPlanPlanPooledSchedule.
Other Status Codes	CloudError	Automatisierungsfehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

ScalingPlanPooledSchedules_Create

Beispielanforderung

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

Beispiel für eine Antwort

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

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

Definitionen

Name	Beschreibung
CloudError	Cloud-Fehlerobjekt.
CloudErrorProperties	Eigenschaften des Cloud-Fehlerobjekts.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DayOfWeek	Wochentag.
ScalingPlanPooledSchedule	Stellt eine ScalingPlanPooledSchedule-Definition dar.
SessionHostLoadBalancingAlgorithm	Lastenausgleichsalgorithmus für den Hochlaufzeitraum.
StopHostsWhen	Gibt an, wann Hosts während des Rampdownzeitraums beendet werden sollen.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
Time	Die Zeit, zu der eine Skalierungsaktion ausgeführt werden soll.

CloudError

Objekt

Cloud-Fehlerobjekt.

Name	Typ	Beschreibung
error	CloudErrorProperties	Eigenschaften des Cloud-Fehlerobjekts.

CloudErrorProperties

Objekt

Eigenschaften des Cloud-Fehlerobjekts.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DayOfWeek

Enumeration

Wochentag.

Wert	Beschreibung
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

ScalingPlanPooledSchedule

Objekt

Stellt eine ScalingPlanPooledSchedule-Definition dar.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.daysOfWeek	DayOfWeek[]	Satz von Tagen der Woche, an denen dieser Zeitplan aktiv ist.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Lastenausgleichsalgorithmus für off-peak period.
properties.offPeakStartTime	Time	Startzeit für den Zeitraum außerhalb des Höchstwerts.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Lastenausgleichsalgorithmus für Spitzenzeitpunkt.
properties.peakStartTime	Time	Startzeit für Spitzenzeit.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Kapazitätsschwellenwert für Den Rampdownzeitraum.
properties.rampDownForceLogoffUsers	boolean	Sollten Benutzer erzwungen von Hosts abgemeldet werden.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Lastenausgleichsalgorithmus für ramp down period.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minimaler Hostprozentsatz für ramp down period.
properties.rampDownNotificationMessage	string	Benachrichtigung für Benutzer während des Rampdownzeitraums.
properties.rampDownStartTime	Time	Startzeit für ramp down period.
properties.rampDownStopHostsWhen	StopHostsWhen	Gibt an, wann Hosts während des Rampdownzeitraums beendet werden sollen.
properties.rampDownWaitTimeMinutes	integer (int32)	Die Anzahl der Minuten, um zu warten, bis Hosts während des Ramp down-Zeitraums beendet werden.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Kapazitätsschwellenwert für den Hochlaufzeitraum.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Lastenausgleichsalgorithmus für den Hochlaufzeitraum.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minimaler Hostprozentsatz für den Hochlaufzeitraum.
properties.rampUpStartTime	Time	Startzeit für den Hochstartzeitraum.
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SessionHostLoadBalancingAlgorithm

Enumeration

Lastenausgleichsalgorithmus für den Hochlaufzeitraum.

Wert	Beschreibung
BreadthFirst
DepthFirst

StopHostsWhen

Enumeration

Gibt an, wann Hosts während des Rampdownzeitraums beendet werden sollen.

Wert	Beschreibung
ZeroSessions
ZeroActiveSessions

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Time

Objekt

Die Zeit, zu der eine Skalierungsaktion ausgeführt werden soll.

Name	Typ	Beschreibung
hour	integer (int32) minimum: 0 maximum: 23	Die Stunde.
minute	integer (int32) minimum: 0 maximum: 59	Die Minute.

Freigeben über

Scaling Plan Pooled Schedules - Create

URI-Parameter

Anforderungstext

Antworten

Beispiele

ScalingPlanPooledSchedules_Create

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CloudError

CloudErrorProperties

createdByType

DayOfWeek

ScalingPlanPooledSchedule

SessionHostLoadBalancingAlgorithm

StopHostsWhen

systemData

Time