Scaling Plan Pooled Schedules - Create

Tjänst:: Desktop Virtualization

API-version:: 2025-10-10

Skapa eller uppdatera en ScalingPlanPooledSchedule.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
scalingPlanName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Namnet på skalningsplanen.
scalingPlanScheduleName	path	True	string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Namnet på ScalingPlanSchedule
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
properties.daysOfWeek	DayOfWeek[]	Uppsättning dagar i veckan där det här schemat är aktivt.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Belastningsutjämningsalgoritm för låg belastningsperiod.
properties.offPeakStartTime	Time	Starttid för låg belastningsperiod.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Belastningsutjämningsalgoritm för hög belastningsperiod.
properties.peakStartTime	Time	Starttid för hög belastningsperiod.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Kapacitetströskel för nedfartsperiod.
properties.rampDownForceLogoffUsers	boolean	Ska användare loggas ut med kraft från värdar.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Belastningsutjämningsalgoritm för rampens nedtid.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minsta värdprocent för rampens nedtid.
properties.rampDownNotificationMessage	string	Meddelande för användare under nedfartsperioden.
properties.rampDownStartTime	Time	Starttid för rampens nedtid.
properties.rampDownStopHostsWhen	StopHostsWhen	Anger när värdar ska stoppas under nedfartsperioden.
properties.rampDownWaitTimeMinutes	integer (int32)	Antal minuter att vänta för att stoppa värdar under nedfartsperioden.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Kapacitetströskel för upptrappad period.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Belastningsutjämningsalgoritm för uppfartsperiod.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minsta värdprocent för uppfartsperiod.
properties.rampUpStartTime	Time	Starttid för upptrappad period.

Svar

Name	Typ	Description
200 OK	ScalingPlanPooledSchedule	Uppdaterade ScalingPlanPooledSchedule.
201 Created	ScalingPlanPooledSchedule	Skapade framgångsrikt ScalingPlanPlanPooledSchedule.
Other Status Codes	CloudError	Svar på automationsfel som beskriver varför åtgärden misslyckades.

Exempel

ScalingPlanPooledSchedules_Create

Exempelbegäran

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

Exempelsvar

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

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

Definitioner

Name	Description
CloudError	Molnfelobjekt.
CloudErrorProperties	Egenskaper för molnfelobjekt.
createdByType	Den typ av identitet som skapade resursen.
DayOfWeek	Dag i veckan.
ScalingPlanPooledSchedule	Representerar en ScalingPlanPooledSchedule definition.
SessionHostLoadBalancingAlgorithm	Belastningsutjämningsalgoritm för uppfartsperiod.
StopHostsWhen	Anger när värdar ska stoppas under nedfartsperioden.
systemData	Metadata som rör skapande och senaste ändring av resursen.
Time	Tiden för en skalningsåtgärd att utföras.

CloudError

Objekt

Molnfelobjekt.

Name	Typ	Description
error	CloudErrorProperties	Egenskaper för molnfelobjekt.

CloudErrorProperties

Objekt

Egenskaper för molnfelobjekt.

Name	Typ	Description
code	string	Felkod
message	string	Felmeddelande som anger varför åtgärden misslyckades.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

DayOfWeek

Uppräkning

Dag i veckan.

Värde	Description
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

ScalingPlanPooledSchedule

Objekt

Representerar en ScalingPlanPooledSchedule definition.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties.daysOfWeek	DayOfWeek[]	Uppsättning dagar i veckan där det här schemat är aktivt.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Belastningsutjämningsalgoritm för låg belastningsperiod.
properties.offPeakStartTime	Time	Starttid för låg belastningsperiod.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Belastningsutjämningsalgoritm för hög belastningsperiod.
properties.peakStartTime	Time	Starttid för hög belastningsperiod.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Kapacitetströskel för nedfartsperiod.
properties.rampDownForceLogoffUsers	boolean	Ska användare loggas ut med kraft från värdar.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Belastningsutjämningsalgoritm för rampens nedtid.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minsta värdprocent för rampens nedtid.
properties.rampDownNotificationMessage	string	Meddelande för användare under nedfartsperioden.
properties.rampDownStartTime	Time	Starttid för rampens nedtid.
properties.rampDownStopHostsWhen	StopHostsWhen	Anger när värdar ska stoppas under nedfartsperioden.
properties.rampDownWaitTimeMinutes	integer (int32)	Antal minuter att vänta för att stoppa värdar under nedfartsperioden.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Kapacitetströskel för upptrappad period.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Belastningsutjämningsalgoritm för uppfartsperiod.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Minsta värdprocent för uppfartsperiod.
properties.rampUpStartTime	Time	Starttid för upptrappad period.
systemData	systemData	Metadata som rör skapande och senaste ändring av resursen.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SessionHostLoadBalancingAlgorithm

Uppräkning

Belastningsutjämningsalgoritm för uppfartsperiod.

Värde	Description
BreadthFirst
DepthFirst

StopHostsWhen

Uppräkning

Anger när värdar ska stoppas under nedfartsperioden.

Värde	Description
ZeroSessions
ZeroActiveSessions

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Time

Objekt

Tiden för en skalningsåtgärd att utföras.

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

Dela via

Scaling Plan Pooled Schedules - Create

URI-parametrar

Begärandetext

Svar

Exempel

ScalingPlanPooledSchedules_Create

Exempelbegäran

Exempelsvar

Definitioner

CloudError

CloudErrorProperties

createdByType

DayOfWeek

ScalingPlanPooledSchedule

SessionHostLoadBalancingAlgorithm

StopHostsWhen

systemData

Time