Scaling Plan Pooled Schedules - Create

Služba:: Desktop Virtualization

Verze rozhraní API:: 2025-10-10

Vytvořte nebo aktualizujte ScalingPlanPooledSchedule.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
scalingPlanName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Název plánu škálování.
scalingPlanScheduleName	path	True	string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Název objektu ScalingPlanSchedule
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
properties.daysOfWeek	DayOfWeek[]	Sada dnů v týdnu, ve kterých je tento plán aktivní.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmus vyrovnávání zatížení pro období mimo špičku
properties.offPeakStartTime	Time	Počáteční doba pro období mimo špičku
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmus vyrovnávání zatížení pro období špičky
properties.peakStartTime	Time	Počáteční čas pro období špičky.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Prahová hodnota kapacity pro období snížení kapacity
properties.rampDownForceLogoffUsers	boolean	Pokud by se uživatelé odhlásili vynuceně od hostitelů.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmus vyrovnávání zatížení pro období snižování zatížení
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minimální procento hostitele pro období snížení nájezdu
properties.rampDownNotificationMessage	string	Zpráva s oznámením pro uživatele během období výpadku.
properties.rampDownStartTime	Time	Počáteční čas pro období odsud.
properties.rampDownStopHostsWhen	StopHostsWhen	Určuje, kdy se mají hostitelé zastavit během období výpadku.
properties.rampDownWaitTimeMinutes	integer (int32)	Počet minut čekánínach
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Prahová hodnota kapacity pro období zvýšení kapacity.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmus vyrovnávání zatížení pro období zvýraznění
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minimální procento hostitele pro období zvýšení.
properties.rampUpStartTime	Time	Počáteční čas pro počáteční období.

Odpovědi

Name	Typ	Description
200 OK	ScalingPlanPooledSchedule	Úspěšně aktualizováno ScalingPlanPooledSchedule.
201 Created	ScalingPlanPooledSchedule	Úspěšně vytvořen ScalingPlanPooledSchedule.
Other Status Codes	CloudError	Chybová odpověď automatizace popisující, proč se operace nezdařila.

Příklady

ScalingPlanPooledSchedules_Create

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Stavový kód:: 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"
  }
}

Definice

Name	Description
CloudError	Cloud error object.
CloudErrorProperties	Vlastnosti objektu cloud error.
createdByType	Typ identity, která prostředek vytvořila.
DayOfWeek	Den v týdnu.
ScalingPlanPooledSchedule	Představuje definici ScalingPlanPooledSchedule.
SessionHostLoadBalancingAlgorithm	Algoritmus vyrovnávání zatížení pro období zvýraznění
StopHostsWhen	Určuje, kdy se mají hostitelé zastavit během období výpadku.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
Time	Doba, po kterou dojde k akci změny velikosti.

CloudError

Objekt

Cloud error object.

Name	Typ	Description
error	CloudErrorProperties	Vlastnosti objektu cloud error.

CloudErrorProperties

Objekt

Vlastnosti objektu cloud error.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

DayOfWeek

Výčet

Den v týdnu.

Hodnota	Description
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

ScalingPlanPooledSchedule

Objekt

Představuje definici ScalingPlanPooledSchedule.

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties.daysOfWeek	DayOfWeek[]	Sada dnů v týdnu, ve kterých je tento plán aktivní.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmus vyrovnávání zatížení pro období mimo špičku
properties.offPeakStartTime	Time	Počáteční doba pro období mimo špičku
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmus vyrovnávání zatížení pro období špičky
properties.peakStartTime	Time	Počáteční čas pro období špičky.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Prahová hodnota kapacity pro období snížení kapacity
properties.rampDownForceLogoffUsers	boolean	Pokud by se uživatelé odhlásili vynuceně od hostitelů.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmus vyrovnávání zatížení pro období snižování zatížení
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minimální procento hostitele pro období snížení nájezdu
properties.rampDownNotificationMessage	string	Zpráva s oznámením pro uživatele během období výpadku.
properties.rampDownStartTime	Time	Počáteční čas pro období odsud.
properties.rampDownStopHostsWhen	StopHostsWhen	Určuje, kdy se mají hostitelé zastavit během období výpadku.
properties.rampDownWaitTimeMinutes	integer (int32)	Počet minut čekánínach
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Prahová hodnota kapacity pro období zvýšení kapacity.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmus vyrovnávání zatížení pro období zvýraznění
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minimální procento hostitele pro období zvýšení.
properties.rampUpStartTime	Time	Počáteční čas pro počáteční období.
systemData	systemData	Metadata týkající se vytvoření a poslední změny prostředku.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SessionHostLoadBalancingAlgorithm

Výčet

Algoritmus vyrovnávání zatížení pro období zvýraznění

Hodnota	Description
BreadthFirst
DepthFirst

StopHostsWhen

Výčet

Určuje, kdy se mají hostitelé zastavit během období výpadku.

Hodnota	Description
ZeroSessions
ZeroActiveSessions

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Time

Objekt

Doba, po kterou dojde k akci změny velikosti.

Name	Typ	Description
hour	integer (int32) minimum: 0 maximum: 23	Hodina.
minute	integer (int32) minimum: 0 maximum: 59	Minuta.

Sdílet prostřednictvím

Scaling Plan Pooled Schedules - Create

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

ScalingPlanPooledSchedules_Create

Ukázkový požadavek

Ukázková odpověď

Definice

CloudError

CloudErrorProperties

createdByType

DayOfWeek

ScalingPlanPooledSchedule

SessionHostLoadBalancingAlgorithm

StopHostsWhen

systemData

Time