Scaling Plan Pooled Schedules - Create

Usługa:: Desktop Virtualization

Wersja interfejsu API:: 2025-10-10

Tworzenie lub aktualizowanie elementu ScalingPlanPooledSchedule.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
scalingPlanName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Nazwa planu skalowania.
scalingPlanScheduleName	path	True	string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Nazwa elementu ScalingPlanSchedule
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
properties.daysOfWeek	DayOfWeek[]	Zestaw dni tygodnia, w którym ten harmonogram jest aktywny.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorytm równoważenia obciążenia dla okresu poza szczytem.
properties.offPeakStartTime	Time	Czas rozpoczęcia okresu poza szczytem.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorytm równoważenia obciążenia dla okresu szczytowego.
properties.peakStartTime	Time	Czas rozpoczęcia dla szczytowego okresu.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Próg pojemności dla okresu spadku.
properties.rampDownForceLogoffUsers	boolean	Jeśli użytkownicy zostaną wylogowani siłowo z hostów.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorytm równoważenia obciążenia na potrzeby zwiększania okresu.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minimalna wartość procentowa hosta dla okresu spadku.
properties.rampDownNotificationMessage	string	Komunikat powiadomienia dla użytkowników w okresie zwiększania w dół.
properties.rampDownStartTime	Time	Czas rozpoczęcia okresu w dół.
properties.rampDownStopHostsWhen	StopHostsWhen	Określa, kiedy należy zatrzymać hosty w okresie zwiększania w dół.
properties.rampDownWaitTimeMinutes	integer (int32)	Liczba minut oczekiwania na zatrzymanie hostów w okresie przechodzenia w dół.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Próg pojemności w okresie zwiększania się.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorytm równoważenia obciążenia na potrzeby zwiększania okresu.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minimalna wartość procentowa hosta w okresie zwiększania.
properties.rampUpStartTime	Time	Czas rozpoczęcia okresu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ScalingPlanPooledSchedule	Pomyślnie zaktualizowano ScalingPlanPooledSchedule.
201 Created	ScalingPlanPooledSchedule	Pomyślnie utworzono ScalingPlanPooledSchedule.
Other Status Codes	CloudError	Odpowiedź na błąd automatyzacji opisująca, dlaczego operacja nie powiodła się.

Przykłady

ScalingPlanPooledSchedules_Create

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Kod stanu:: 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"
  }
}

Definicje

Nazwa	Opis
CloudError	Błąd w chmurze.
CloudErrorProperties	Właściwości obiektu błędu chmury.
createdByType	Typ tożsamości, która utworzyła zasób.
DayOfWeek	Dzień tygodnia.
ScalingPlanPooledSchedule	Reprezentuje definicję ScalingPlanPooledSchedule.
SessionHostLoadBalancingAlgorithm	Algorytm równoważenia obciążenia na potrzeby zwiększania okresu.
StopHostsWhen	Określa, kiedy należy zatrzymać hosty w okresie zwiększania w dół.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
Time	Czas wykonania akcji skalowania.

CloudError

Objekt

Błąd w chmurze.

Nazwa	Typ	Opis
error	CloudErrorProperties	Właściwości obiektu błędu chmury.

CloudErrorProperties

Objekt

Właściwości obiektu błędu chmury.

Nazwa	Typ	Opis
code	string	Kod błędu
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

DayOfWeek

Wyliczenie

Dzień tygodnia.

Wartość	Opis
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

ScalingPlanPooledSchedule

Objekt

Reprezentuje definicję ScalingPlanPooledSchedule.

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.daysOfWeek	DayOfWeek[]	Zestaw dni tygodnia, w którym ten harmonogram jest aktywny.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorytm równoważenia obciążenia dla okresu poza szczytem.
properties.offPeakStartTime	Time	Czas rozpoczęcia okresu poza szczytem.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorytm równoważenia obciążenia dla okresu szczytowego.
properties.peakStartTime	Time	Czas rozpoczęcia dla szczytowego okresu.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Próg pojemności dla okresu spadku.
properties.rampDownForceLogoffUsers	boolean	Jeśli użytkownicy zostaną wylogowani siłowo z hostów.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorytm równoważenia obciążenia na potrzeby zwiększania okresu.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minimalna wartość procentowa hosta dla okresu spadku.
properties.rampDownNotificationMessage	string	Komunikat powiadomienia dla użytkowników w okresie zwiększania w dół.
properties.rampDownStartTime	Time	Czas rozpoczęcia okresu w dół.
properties.rampDownStopHostsWhen	StopHostsWhen	Określa, kiedy należy zatrzymać hosty w okresie zwiększania w dół.
properties.rampDownWaitTimeMinutes	integer (int32)	Liczba minut oczekiwania na zatrzymanie hostów w okresie przechodzenia w dół.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Próg pojemności w okresie zwiększania się.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algorytm równoważenia obciążenia na potrzeby zwiększania okresu.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minimalna wartość procentowa hosta w okresie zwiększania.
properties.rampUpStartTime	Time	Czas rozpoczęcia okresu.
systemData	systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

SessionHostLoadBalancingAlgorithm

Wyliczenie

Algorytm równoważenia obciążenia na potrzeby zwiększania okresu.

Wartość	Opis
BreadthFirst
DepthFirst

StopHostsWhen

Wyliczenie

Określa, kiedy należy zatrzymać hosty w okresie zwiększania w dół.

Wartość	Opis
ZeroSessions
ZeroActiveSessions

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Time

Objekt

Czas wykonania akcji skalowania.

Nazwa	Typ	Opis
hour	integer (int32) minimum: 0 maximum: 23	Godzina.
minute	integer (int32) minimum: 0 maximum: 59	Minuta.

Udostępnij za pośrednictwem

Scaling Plan Pooled Schedules - Create

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Przykłady

ScalingPlanPooledSchedules_Create

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CloudError

CloudErrorProperties

createdByType

DayOfWeek

ScalingPlanPooledSchedule

SessionHostLoadBalancingAlgorithm

StopHostsWhen

systemData

Time