Scaling Plan Pooled Schedules - Create

Serviço:

Desktop Virtualization

Versão da API:

2024-04-03

Crie ou atualize um ScalingPlanPooledSchedule.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
scalingPlanName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	O nome do plano de dimensionamento.
scalingPlanScheduleName	path	True	string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	O nome do ScalingPlanSchedule
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties.daysOfWeek	DayOfWeek[]	Conjunto de dias da semana em que essa agenda está ativa.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para um período fora do pico.
properties.offPeakStartTime	Time	Tempo de início para o período fora do pico.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de pico.
properties.peakStartTime	Time	Hora de início do período de pico.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Limite de capacidade para o período de rampa para baixo.
properties.rampDownForceLogoffUsers	boolean	Caso os usuários sejam retirados com força dos hosts.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de rampa para baixo.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Percentual mínimo de host para o período de rampa para baixo.
properties.rampDownNotificationMessage	string	Mensagem de notificação para usuários durante o período de ramp down.
properties.rampDownStartTime	Time	Tempo de partida para o período de rampa para baixo.
properties.rampDownStopHostsWhen	StopHostsWhen	Especifica quando parar os hosts durante o período de rampa para baixo.
properties.rampDownWaitTimeMinutes	integer (int32)	Número de minutos para aguardar para interromper os hosts durante o período de rampa para baixo.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Limite de capacidade para aumentar o período.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para aumentar o período.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Percentual mínimo de host para aumentar o período.
properties.rampUpStartTime	Time	Tempo de início para o período de aumento.

Respostas

Nome	Tipo	Description
200 OK	ScalingPlanPooledSchedule	ScalingPlanPooledSchedule atualizado com êxito.
201 Created	ScalingPlanPooledSchedule	Criado com êxito ScalingPlanPooledSchedule.
Other Status Codes	CloudError	Resposta de erro de automação descrevendo por que a operação falhou.

Exemplos

ScalingPlanPooledSchedules_Create

Solicitação de exemplo

HTTP

PUT https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1?api-version=2024-04-03

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

Java

import com.azure.resourcemanager.desktopvirtualization.models.DayOfWeek;
import com.azure.resourcemanager.desktopvirtualization.models.SessionHostLoadBalancingAlgorithm;
import com.azure.resourcemanager.desktopvirtualization.models.Time;
import java.util.Arrays;

/**
 * Samples for ScalingPlanPooledSchedules Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/
     * ScalingPlanPooledSchedule_Create.json
     */
    /**
     * Sample code: ScalingPlanPooledSchedules_Create.
     * 
     * @param manager Entry point to DesktopVirtualizationManager.
     */
    public static void scalingPlanPooledSchedulesCreate(
        com.azure.resourcemanager.desktopvirtualization.DesktopVirtualizationManager manager) {
        manager.scalingPlanPooledSchedules().define("scalingPlanScheduleWeekdays1")
            .withExistingScalingPlan("resourceGroup1", "scalingPlan1")
            .withDaysOfWeek(Arrays.asList(DayOfWeek.MONDAY, DayOfWeek.TUESDAY, DayOfWeek.WEDNESDAY, DayOfWeek.THURSDAY,
                DayOfWeek.FRIDAY))
            .withRampUpStartTime(new Time().withHour(6).withMinute(0))
            .withRampUpLoadBalancingAlgorithm(SessionHostLoadBalancingAlgorithm.DEPTH_FIRST)
            .withRampUpMinimumHostsPct(20).withRampUpCapacityThresholdPct(80)
            .withPeakStartTime(new Time().withHour(8).withMinute(0))
            .withPeakLoadBalancingAlgorithm(SessionHostLoadBalancingAlgorithm.BREADTH_FIRST)
            .withRampDownStartTime(new Time().withHour(18).withMinute(0))
            .withRampDownLoadBalancingAlgorithm(SessionHostLoadBalancingAlgorithm.DEPTH_FIRST)
            .withRampDownMinimumHostsPct(20).withRampDownCapacityThresholdPct(50).withRampDownForceLogoffUsers(true)
            .withRampDownWaitTimeMinutes(30).withRampDownNotificationMessage("message")
            .withOffPeakStartTime(new Time().withHour(20).withMinute(0))
            .withOffPeakLoadBalancingAlgorithm(SessionHostLoadBalancingAlgorithm.DEPTH_FIRST).create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.desktopvirtualization import DesktopVirtualizationMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-desktopvirtualization
# USAGE
    python scaling_plan_pooled_schedule_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DesktopVirtualizationMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="daefabc0-95b4-48b3-b645-8a753a63c4fa",
    )

    response = client.scaling_plan_pooled_schedules.create(
        resource_group_name="resourceGroup1",
        scaling_plan_name="scalingPlan1",
        scaling_plan_schedule_name="scalingPlanScheduleWeekdays1",
        scaling_plan_schedule={
            "properties": {
                "daysOfWeek": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"],
                "offPeakLoadBalancingAlgorithm": "DepthFirst",
                "offPeakStartTime": {"hour": 20, "minute": 0},
                "peakLoadBalancingAlgorithm": "BreadthFirst",
                "peakStartTime": {"hour": 8, "minute": 0},
                "rampDownCapacityThresholdPct": 50,
                "rampDownForceLogoffUsers": True,
                "rampDownLoadBalancingAlgorithm": "DepthFirst",
                "rampDownMinimumHostsPct": 20,
                "rampDownNotificationMessage": "message",
                "rampDownStartTime": {"hour": 18, "minute": 0},
                "rampDownWaitTimeMinutes": 30,
                "rampUpCapacityThresholdPct": 80,
                "rampUpLoadBalancingAlgorithm": "DepthFirst",
                "rampUpMinimumHostsPct": 20,
                "rampUpStartTime": {"hour": 6, "minute": 0},
            }
        },
    )
    print(response)


# x-ms-original-file: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/ScalingPlanPooledSchedule_Create.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdesktopvirtualization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/desktopvirtualization/armdesktopvirtualization/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4883fa5dbf6f2c9093fac8ce334547e9dfac68fa/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/ScalingPlanPooledSchedule_Create.json
func ExampleScalingPlanPooledSchedulesClient_Create() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdesktopvirtualization.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewScalingPlanPooledSchedulesClient().Create(ctx, "resourceGroup1", "scalingPlan1", "scalingPlanScheduleWeekdays1", armdesktopvirtualization.ScalingPlanPooledSchedule{
		Properties: &armdesktopvirtualization.ScalingPlanPooledScheduleProperties{
			DaysOfWeek: []*armdesktopvirtualization.DayOfWeek{
				to.Ptr(armdesktopvirtualization.DayOfWeekMonday),
				to.Ptr(armdesktopvirtualization.DayOfWeekTuesday),
				to.Ptr(armdesktopvirtualization.DayOfWeekWednesday),
				to.Ptr(armdesktopvirtualization.DayOfWeekThursday),
				to.Ptr(armdesktopvirtualization.DayOfWeekFriday)},
			OffPeakLoadBalancingAlgorithm: to.Ptr(armdesktopvirtualization.SessionHostLoadBalancingAlgorithmDepthFirst),
			OffPeakStartTime: &armdesktopvirtualization.Time{
				Hour:   to.Ptr[int32](20),
				Minute: to.Ptr[int32](0),
			},
			PeakLoadBalancingAlgorithm: to.Ptr(armdesktopvirtualization.SessionHostLoadBalancingAlgorithmBreadthFirst),
			PeakStartTime: &armdesktopvirtualization.Time{
				Hour:   to.Ptr[int32](8),
				Minute: to.Ptr[int32](0),
			},
			RampDownCapacityThresholdPct:   to.Ptr[int32](50),
			RampDownForceLogoffUsers:       to.Ptr(true),
			RampDownLoadBalancingAlgorithm: to.Ptr(armdesktopvirtualization.SessionHostLoadBalancingAlgorithmDepthFirst),
			RampDownMinimumHostsPct:        to.Ptr[int32](20),
			RampDownNotificationMessage:    to.Ptr("message"),
			RampDownStartTime: &armdesktopvirtualization.Time{
				Hour:   to.Ptr[int32](18),
				Minute: to.Ptr[int32](0),
			},
			RampDownWaitTimeMinutes:      to.Ptr[int32](30),
			RampUpCapacityThresholdPct:   to.Ptr[int32](80),
			RampUpLoadBalancingAlgorithm: to.Ptr(armdesktopvirtualization.SessionHostLoadBalancingAlgorithmDepthFirst),
			RampUpMinimumHostsPct:        to.Ptr[int32](20),
			RampUpStartTime: &armdesktopvirtualization.Time{
				Hour:   to.Ptr[int32](6),
				Minute: to.Ptr[int32](0),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ScalingPlanPooledSchedule = armdesktopvirtualization.ScalingPlanPooledSchedule{
	// 	Name: to.Ptr("scalingPlanScheduleWeekdays1"),
	// 	Type: to.Ptr("Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules"),
	// 	ID: to.Ptr("/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1"),
	// 	SystemData: &armdesktopvirtualization.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
	// 		CreatedBy: to.Ptr("user1"),
	// 		CreatedByType: to.Ptr(armdesktopvirtualization.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("user2"),
	// 		LastModifiedByType: to.Ptr(armdesktopvirtualization.CreatedByTypeUser),
	// 	},
	// 	Properties: &armdesktopvirtualization.ScalingPlanPooledScheduleProperties{
	// 		DaysOfWeek: []*armdesktopvirtualization.DayOfWeek{
	// 			to.Ptr(armdesktopvirtualization.DayOfWeekMonday),
	// 			to.Ptr(armdesktopvirtualization.DayOfWeekTuesday),
	// 			to.Ptr(armdesktopvirtualization.DayOfWeekWednesday),
	// 			to.Ptr(armdesktopvirtualization.DayOfWeekThursday),
	// 			to.Ptr(armdesktopvirtualization.DayOfWeekFriday)},
	// 			OffPeakLoadBalancingAlgorithm: to.Ptr(armdesktopvirtualization.SessionHostLoadBalancingAlgorithmDepthFirst),
	// 			OffPeakStartTime: &armdesktopvirtualization.Time{
	// 				Hour: to.Ptr[int32](20),
	// 				Minute: to.Ptr[int32](0),
	// 			},
	// 			PeakLoadBalancingAlgorithm: to.Ptr(armdesktopvirtualization.SessionHostLoadBalancingAlgorithmBreadthFirst),
	// 			PeakStartTime: &armdesktopvirtualization.Time{
	// 				Hour: to.Ptr[int32](8),
	// 				Minute: to.Ptr[int32](0),
	// 			},
	// 			RampDownCapacityThresholdPct: to.Ptr[int32](50),
	// 			RampDownForceLogoffUsers: to.Ptr(true),
	// 			RampDownLoadBalancingAlgorithm: to.Ptr(armdesktopvirtualization.SessionHostLoadBalancingAlgorithmDepthFirst),
	// 			RampDownMinimumHostsPct: to.Ptr[int32](20),
	// 			RampDownNotificationMessage: to.Ptr("message"),
	// 			RampDownStartTime: &armdesktopvirtualization.Time{
	// 				Hour: to.Ptr[int32](18),
	// 				Minute: to.Ptr[int32](0),
	// 			},
	// 			RampDownWaitTimeMinutes: to.Ptr[int32](30),
	// 			RampUpCapacityThresholdPct: to.Ptr[int32](80),
	// 			RampUpLoadBalancingAlgorithm: to.Ptr(armdesktopvirtualization.SessionHostLoadBalancingAlgorithmDepthFirst),
	// 			RampUpMinimumHostsPct: to.Ptr[int32](20),
	// 			RampUpStartTime: &armdesktopvirtualization.Time{
	// 				Hour: to.Ptr[int32](6),
	// 				Minute: to.Ptr[int32](0),
	// 			},
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DesktopVirtualizationAPIClient } = require("@azure/arm-desktopvirtualization");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or update a ScalingPlanPooledSchedule.
 *
 * @summary Create or update a ScalingPlanPooledSchedule.
 * x-ms-original-file: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/ScalingPlanPooledSchedule_Create.json
 */
async function scalingPlanPooledSchedulesCreate() {
  const subscriptionId =
    process.env["DESKTOPVIRTUALIZATION_SUBSCRIPTION_ID"] || "daefabc0-95b4-48b3-b645-8a753a63c4fa";
  const resourceGroupName = process.env["DESKTOPVIRTUALIZATION_RESOURCE_GROUP"] || "resourceGroup1";
  const scalingPlanName = "scalingPlan1";
  const scalingPlanScheduleName = "scalingPlanScheduleWeekdays1";
  const scalingPlanSchedule = {
    daysOfWeek: ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"],
    offPeakLoadBalancingAlgorithm: "DepthFirst",
    offPeakStartTime: { hour: 20, minute: 0 },
    peakLoadBalancingAlgorithm: "BreadthFirst",
    peakStartTime: { hour: 8, minute: 0 },
    rampDownCapacityThresholdPct: 50,
    rampDownForceLogoffUsers: true,
    rampDownLoadBalancingAlgorithm: "DepthFirst",
    rampDownMinimumHostsPct: 20,
    rampDownNotificationMessage: "message",
    rampDownStartTime: { hour: 18, minute: 0 },
    rampDownWaitTimeMinutes: 30,
    rampUpCapacityThresholdPct: 80,
    rampUpLoadBalancingAlgorithm: "DepthFirst",
    rampUpMinimumHostsPct: 20,
    rampUpStartTime: { hour: 6, minute: 0 },
  };
  const credential = new DefaultAzureCredential();
  const client = new DesktopVirtualizationAPIClient(credential, subscriptionId);
  const result = await client.scalingPlanPooledSchedules.create(
    resourceGroupName,
    scalingPlanName,
    scalingPlanScheduleName,
    scalingPlanSchedule,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DesktopVirtualization.Models;
using Azure.ResourceManager.DesktopVirtualization;

// Generated from example definition: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/ScalingPlanPooledSchedule_Create.json
// this example is just showing the usage of "ScalingPlanPooledSchedules_Create" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ScalingPlanResource created on azure
// for more information of creating ScalingPlanResource, please refer to the document of ScalingPlanResource
string subscriptionId = "daefabc0-95b4-48b3-b645-8a753a63c4fa";
string resourceGroupName = "resourceGroup1";
string scalingPlanName = "scalingPlan1";
ResourceIdentifier scalingPlanResourceId = ScalingPlanResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, scalingPlanName);
ScalingPlanResource scalingPlan = client.GetScalingPlanResource(scalingPlanResourceId);

// get the collection of this ScalingPlanPooledScheduleResource
ScalingPlanPooledScheduleCollection collection = scalingPlan.GetScalingPlanPooledSchedules();

// invoke the operation
string scalingPlanScheduleName = "scalingPlanScheduleWeekdays1";
ScalingPlanPooledScheduleData data = new ScalingPlanPooledScheduleData
{
    DaysOfWeek = { DesktopVirtualizationDayOfWeek.Monday, DesktopVirtualizationDayOfWeek.Tuesday, DesktopVirtualizationDayOfWeek.Wednesday, DesktopVirtualizationDayOfWeek.Thursday, DesktopVirtualizationDayOfWeek.Friday },
    RampUpStartTime = new ScalingActionTime(6, 0),
    RampUpLoadBalancingAlgorithm = SessionHostLoadBalancingAlgorithm.DepthFirst,
    RampUpMinimumHostsPct = 20,
    RampUpCapacityThresholdPct = 80,
    PeakStartTime = new ScalingActionTime(8, 0),
    PeakLoadBalancingAlgorithm = SessionHostLoadBalancingAlgorithm.BreadthFirst,
    RampDownStartTime = new ScalingActionTime(18, 0),
    RampDownLoadBalancingAlgorithm = SessionHostLoadBalancingAlgorithm.DepthFirst,
    RampDownMinimumHostsPct = 20,
    RampDownCapacityThresholdPct = 50,
    RampDownForceLogoffUsers = true,
    RampDownWaitTimeMinutes = 30,
    RampDownNotificationMessage = "message",
    OffPeakStartTime = new ScalingActionTime(20, 0),
    OffPeakLoadBalancingAlgorithm = SessionHostLoadBalancingAlgorithm.DepthFirst,
};
ArmOperation<ScalingPlanPooledScheduleResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, scalingPlanScheduleName, data);
ScalingPlanPooledScheduleResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ScalingPlanPooledScheduleData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

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

Código de status:

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

Definições

Nome	Description
CloudError	Objeto de erro de nuvem.
CloudErrorProperties	Propriedades do objeto de erro de nuvem.
createdByType	O tipo de identidade que criou o recurso.
DayOfWeek	Dia da semana.
ScalingPlanPooledSchedule	Representa uma definição scalingPlanPooledSchedule.
SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para aumentar o período.
StopHostsWhen	Especifica quando parar os hosts durante o período de rampa para baixo.
systemData	Metadados relativos à criação e última modificação do recurso.
Time	O tempo para que uma ação de dimensionamento ocorra.

CloudError

Objeto

Objeto de erro de nuvem.

Nome	Tipo	Description
error	CloudErrorProperties	Propriedades do objeto de erro de nuvem.

CloudErrorProperties

Objeto

Propriedades do objeto de erro de nuvem.

Nome	Tipo	Description
code	string	Código de erro
message	string	Mensagem de erro indicando por que a operação falhou.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DayOfWeek

Enumeração

Dia da semana.

Valor	Description
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

ScalingPlanPooledSchedule

Objeto

Representa uma definição scalingPlanPooledSchedule.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.daysOfWeek	DayOfWeek[]	Conjunto de dias da semana em que essa agenda está ativa.
properties.offPeakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para um período fora do pico.
properties.offPeakStartTime	Time	Tempo de início para o período fora do pico.
properties.peakLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de pico.
properties.peakStartTime	Time	Hora de início do período de pico.
properties.rampDownCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Limite de capacidade para o período de rampa para baixo.
properties.rampDownForceLogoffUsers	boolean	Caso os usuários sejam retirados com força dos hosts.
properties.rampDownLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para o período de rampa para baixo.
properties.rampDownMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Percentual mínimo de host para o período de rampa para baixo.
properties.rampDownNotificationMessage	string	Mensagem de notificação para usuários durante o período de ramp down.
properties.rampDownStartTime	Time	Tempo de partida para o período de rampa para baixo.
properties.rampDownStopHostsWhen	StopHostsWhen	Especifica quando parar os hosts durante o período de rampa para baixo.
properties.rampDownWaitTimeMinutes	integer (int32)	Número de minutos para aguardar para interromper os hosts durante o período de rampa para baixo.
properties.rampUpCapacityThresholdPct	integer (int32) minimum: 1 maximum: 100	Limite de capacidade para aumentar o período.
properties.rampUpLoadBalancingAlgorithm	SessionHostLoadBalancingAlgorithm	Algoritmo de balanceamento de carga para aumentar o período.
properties.rampUpMinimumHostsPct	integer (int32) minimum: 0 maximum: 100	Percentual mínimo de host para aumentar o período.
properties.rampUpStartTime	Time	Tempo de início para o período de aumento.
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SessionHostLoadBalancingAlgorithm

Enumeração

Algoritmo de balanceamento de carga para aumentar o período.

Valor	Description
BreadthFirst
DepthFirst

StopHostsWhen

Enumeração

Especifica quando parar os hosts durante o período de rampa para baixo.

Valor	Description
ZeroActiveSessions
ZeroSessions

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Time

Objeto

O tempo para que uma ação de dimensionamento ocorra.

Nome	Tipo	Description
hour	integer (int32) minimum: 0 maximum: 23	A hora.
minute	integer (int32) minimum: 0 maximum: 59	O minuto.