Scaling Plan Personal Schedules - Create

Dienst:

Desktop Virtualization

API-Version:

2024-04-03

Erstellen oder Aktualisieren eines ScalingPlanPersonalSchedule.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem 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)	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.offPeakActionOnDisconnect	SessionHandlingOperation	Aktion, die ausgeführt werden soll, nachdem ein Benutzer während des Zeitraums außerhalb des Spitzenzeitpunkts getrennt wurde.
properties.offPeakActionOnLogoff	SessionHandlingOperation	Maßnahmen, die nach einer Abmeldung während des Abmeldungszeitraums ausgeführt werden sollen.
properties.offPeakMinutesToWaitOnDisconnect	integer (int32) minimum: 0	Die Zeit in Minuten, bis die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn ein Benutzer während des Zeitraums außerhalb des Spitzenzeitpunkts getrennt wird.
properties.offPeakMinutesToWaitOnLogoff	integer (int32) minimum: 0	Die Zeit in Minuten, bis die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn sich ein Benutzer während des Zeitraums außerhalb des Spitzenzeitpunkts abmeldet.
properties.offPeakStartTime	Time	Startzeit für den Zeitraum außerhalb des Höchstwerts.
properties.offPeakStartVMOnConnect	SetStartVMOnConnect	Die gewünschte Konfiguration von "VM on Connect starten" für den Hostpool während der Spitzenphase.
properties.peakActionOnDisconnect	SessionHandlingOperation	Aktion, die nach dem Trennen eines Benutzers während des Spitzenzeitraums ausgeführt werden soll.
properties.peakActionOnLogoff	SessionHandlingOperation	Aktion, die nach einer Abmeldung während der Spitzenzeit ausgeführt werden soll.
properties.peakMinutesToWaitOnDisconnect	integer (int32) minimum: 0	Die Zeit in Minuten, bis die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn ein Benutzer während des Spitzenzeitraums getrennt wird.
properties.peakMinutesToWaitOnLogoff	integer (int32) minimum: 0	Die Zeit in Minuten, bis die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn sich ein Benutzer während des Spitzenzeitraums abmeldet.
properties.peakStartTime	Time	Startzeit für Spitzenzeit.
properties.peakStartVMOnConnect	SetStartVMOnConnect	Die gewünschte Konfiguration von Start VM On Connect für den Hostpool während der Spitzenphase.
properties.rampDownActionOnDisconnect	SessionHandlingOperation	Aktion, die ausgeführt werden soll, nachdem ein Benutzer während des Rampdownzeitraums die Verbindung getrennt hat.
properties.rampDownActionOnLogoff	SessionHandlingOperation	Aktion, die nach einer Abmeldung während des Rampdown-Zeitraums ausgeführt werden soll.
properties.rampDownMinutesToWaitOnDisconnect	integer (int32) minimum: 0	Die Zeit in Minuten, bis die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn ein Benutzer während des Rampdownzeitraums getrennt wird.
properties.rampDownMinutesToWaitOnLogoff	integer (int32) minimum: 0	Die Zeit in Minuten, bis die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn sich ein Benutzer während des Rampdownzeitraums abmeldet.
properties.rampDownStartTime	Time	Startzeit für ramp down period.
properties.rampDownStartVMOnConnect	SetStartVMOnConnect	Die gewünschte Konfiguration von Start VM On Connect für den Hostpool während der Rampdownphase.
properties.rampUpActionOnDisconnect	SessionHandlingOperation	Aktion, die ausgeführt werden soll, nachdem ein Benutzer die Verbindung während des Anlaufzeitraums getrennt hat.
properties.rampUpActionOnLogoff	SessionHandlingOperation	Aktion, die nach einer Abmeldung während des Anlaufzeitraums ausgeführt werden soll.
properties.rampUpAutoStartHosts	StartupBehavior	Das gewünschte Startverhalten während des Ramp up-Zeitraums für persönliche VMs im Hostpool.
properties.rampUpMinutesToWaitOnDisconnect	integer (int32) minimum: 0	Die Zeit in Minuten, die gewartet werden soll, bevor die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn ein Benutzer während des Ramp up-Zeitraums getrennt wird.
properties.rampUpMinutesToWaitOnLogoff	integer (int32) minimum: 0	Die Zeit in Minuten, bis die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn sich ein Benutzer während des Rampupzeitraums abmeldet.
properties.rampUpStartTime	Time	Startzeit für den Hochstartzeitraum.
properties.rampUpStartVMOnConnect	SetStartVMOnConnect	Die gewünschte Konfiguration von Start VM On Connect für den Hostpool während der Ramp up-Phase. Wenn dies deaktiviert ist, müssen Sitzungshosts mithilfe von rampUpAutoStartHosts aktiviert oder manuell aktiviert werden.

Antworten

Name	Typ	Beschreibung
200 OK	ScalingPlanPersonalSchedule	ScalingPlanPersonalSchedule wurde erfolgreich aktualisiert.
201 Created	ScalingPlanPersonalSchedule	ScalingPlanPersonalSchedule wurde erfolgreich erstellt.
Other Status Codes	CloudError	Automatisierungsfehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

ScalingPlanPersonalSchedules_Create

Beispielanforderung

HTTP

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

{
  "properties": {
    "daysOfWeek": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "rampUpStartTime": {
      "hour": 6,
      "minute": 0
    },
    "rampUpAutoStartHosts": "All",
    "rampUpStartVMOnConnect": "Enable",
    "rampUpActionOnDisconnect": "None",
    "rampUpMinutesToWaitOnDisconnect": 10,
    "rampUpActionOnLogoff": "None",
    "rampUpMinutesToWaitOnLogoff": 10,
    "peakStartTime": {
      "hour": 8,
      "minute": 0
    },
    "peakStartVMOnConnect": "Enable",
    "peakActionOnDisconnect": "None",
    "peakMinutesToWaitOnDisconnect": 10,
    "peakActionOnLogoff": "Deallocate",
    "peakMinutesToWaitOnLogoff": 10,
    "rampDownStartTime": {
      "hour": 18,
      "minute": 0
    },
    "rampDownStartVMOnConnect": "Enable",
    "rampDownActionOnDisconnect": "None",
    "rampDownMinutesToWaitOnDisconnect": 10,
    "rampDownActionOnLogoff": "Deallocate",
    "rampDownMinutesToWaitOnLogoff": 10,
    "offPeakStartTime": {
      "hour": 20,
      "minute": 0
    },
    "offPeakStartVMOnConnect": "Enable",
    "offPeakActionOnDisconnect": "None",
    "offPeakMinutesToWaitOnDisconnect": 10,
    "offPeakActionOnLogoff": "Deallocate",
    "offPeakMinutesToWaitOnLogoff": 10
  }
}

Java

import com.azure.resourcemanager.desktopvirtualization.models.DayOfWeek;
import com.azure.resourcemanager.desktopvirtualization.models.SessionHandlingOperation;
import com.azure.resourcemanager.desktopvirtualization.models.SetStartVMOnConnect;
import com.azure.resourcemanager.desktopvirtualization.models.StartupBehavior;
import com.azure.resourcemanager.desktopvirtualization.models.Time;
import java.util.Arrays;

/**
 * Samples for ScalingPlanPersonalSchedules Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/
     * ScalingPlanPersonalSchedule_Create.json
     */
    /**
     * Sample code: ScalingPlanPersonalSchedules_Create.
     * 
     * @param manager Entry point to DesktopVirtualizationManager.
     */
    public static void scalingPlanPersonalSchedulesCreate(
        com.azure.resourcemanager.desktopvirtualization.DesktopVirtualizationManager manager) {
        manager.scalingPlanPersonalSchedules().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)).withRampUpAutoStartHosts(StartupBehavior.ALL)
            .withRampUpStartVMOnConnect(SetStartVMOnConnect.ENABLE)
            .withRampUpActionOnDisconnect(SessionHandlingOperation.NONE).withRampUpMinutesToWaitOnDisconnect(10)
            .withRampUpActionOnLogoff(SessionHandlingOperation.NONE).withRampUpMinutesToWaitOnLogoff(10)
            .withPeakStartTime(new Time().withHour(8).withMinute(0))
            .withPeakStartVMOnConnect(SetStartVMOnConnect.ENABLE)
            .withPeakActionOnDisconnect(SessionHandlingOperation.NONE).withPeakMinutesToWaitOnDisconnect(10)
            .withPeakActionOnLogoff(SessionHandlingOperation.DEALLOCATE).withPeakMinutesToWaitOnLogoff(10)
            .withRampDownStartTime(new Time().withHour(18).withMinute(0))
            .withRampDownStartVMOnConnect(SetStartVMOnConnect.ENABLE)
            .withRampDownActionOnDisconnect(SessionHandlingOperation.NONE).withRampDownMinutesToWaitOnDisconnect(10)
            .withRampDownActionOnLogoff(SessionHandlingOperation.DEALLOCATE).withRampDownMinutesToWaitOnLogoff(10)
            .withOffPeakStartTime(new Time().withHour(20).withMinute(0))
            .withOffPeakStartVMOnConnect(SetStartVMOnConnect.ENABLE)
            .withOffPeakActionOnDisconnect(SessionHandlingOperation.NONE).withOffPeakMinutesToWaitOnDisconnect(10)
            .withOffPeakActionOnLogoff(SessionHandlingOperation.DEALLOCATE).withOffPeakMinutesToWaitOnLogoff(10)
            .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_personal_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_personal_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"],
                "offPeakActionOnDisconnect": "None",
                "offPeakActionOnLogoff": "Deallocate",
                "offPeakMinutesToWaitOnDisconnect": 10,
                "offPeakMinutesToWaitOnLogoff": 10,
                "offPeakStartTime": {"hour": 20, "minute": 0},
                "offPeakStartVMOnConnect": "Enable",
                "peakActionOnDisconnect": "None",
                "peakActionOnLogoff": "Deallocate",
                "peakMinutesToWaitOnDisconnect": 10,
                "peakMinutesToWaitOnLogoff": 10,
                "peakStartTime": {"hour": 8, "minute": 0},
                "peakStartVMOnConnect": "Enable",
                "rampDownActionOnDisconnect": "None",
                "rampDownActionOnLogoff": "Deallocate",
                "rampDownMinutesToWaitOnDisconnect": 10,
                "rampDownMinutesToWaitOnLogoff": 10,
                "rampDownStartTime": {"hour": 18, "minute": 0},
                "rampDownStartVMOnConnect": "Enable",
                "rampUpActionOnDisconnect": "None",
                "rampUpActionOnLogoff": "None",
                "rampUpAutoStartHosts": "All",
                "rampUpMinutesToWaitOnDisconnect": 10,
                "rampUpMinutesToWaitOnLogoff": 10,
                "rampUpStartTime": {"hour": 6, "minute": 0},
                "rampUpStartVMOnConnect": "Enable",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/ScalingPlanPersonalSchedule_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/ScalingPlanPersonalSchedule_Create.json
func ExampleScalingPlanPersonalSchedulesClient_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.NewScalingPlanPersonalSchedulesClient().Create(ctx, "resourceGroup1", "scalingPlan1", "scalingPlanScheduleWeekdays1", armdesktopvirtualization.ScalingPlanPersonalSchedule{
		Properties: &armdesktopvirtualization.ScalingPlanPersonalScheduleProperties{
			DaysOfWeek: []*armdesktopvirtualization.DayOfWeek{
				to.Ptr(armdesktopvirtualization.DayOfWeekMonday),
				to.Ptr(armdesktopvirtualization.DayOfWeekTuesday),
				to.Ptr(armdesktopvirtualization.DayOfWeekWednesday),
				to.Ptr(armdesktopvirtualization.DayOfWeekThursday),
				to.Ptr(armdesktopvirtualization.DayOfWeekFriday)},
			OffPeakActionOnDisconnect:        to.Ptr(armdesktopvirtualization.SessionHandlingOperationNone),
			OffPeakActionOnLogoff:            to.Ptr(armdesktopvirtualization.SessionHandlingOperationDeallocate),
			OffPeakMinutesToWaitOnDisconnect: to.Ptr[int32](10),
			OffPeakMinutesToWaitOnLogoff:     to.Ptr[int32](10),
			OffPeakStartTime: &armdesktopvirtualization.Time{
				Hour:   to.Ptr[int32](20),
				Minute: to.Ptr[int32](0),
			},
			OffPeakStartVMOnConnect:       to.Ptr(armdesktopvirtualization.SetStartVMOnConnectEnable),
			PeakActionOnDisconnect:        to.Ptr(armdesktopvirtualization.SessionHandlingOperationNone),
			PeakActionOnLogoff:            to.Ptr(armdesktopvirtualization.SessionHandlingOperationDeallocate),
			PeakMinutesToWaitOnDisconnect: to.Ptr[int32](10),
			PeakMinutesToWaitOnLogoff:     to.Ptr[int32](10),
			PeakStartTime: &armdesktopvirtualization.Time{
				Hour:   to.Ptr[int32](8),
				Minute: to.Ptr[int32](0),
			},
			PeakStartVMOnConnect:              to.Ptr(armdesktopvirtualization.SetStartVMOnConnectEnable),
			RampDownActionOnDisconnect:        to.Ptr(armdesktopvirtualization.SessionHandlingOperationNone),
			RampDownActionOnLogoff:            to.Ptr(armdesktopvirtualization.SessionHandlingOperationDeallocate),
			RampDownMinutesToWaitOnDisconnect: to.Ptr[int32](10),
			RampDownMinutesToWaitOnLogoff:     to.Ptr[int32](10),
			RampDownStartTime: &armdesktopvirtualization.Time{
				Hour:   to.Ptr[int32](18),
				Minute: to.Ptr[int32](0),
			},
			RampDownStartVMOnConnect:        to.Ptr(armdesktopvirtualization.SetStartVMOnConnectEnable),
			RampUpActionOnDisconnect:        to.Ptr(armdesktopvirtualization.SessionHandlingOperationNone),
			RampUpActionOnLogoff:            to.Ptr(armdesktopvirtualization.SessionHandlingOperationNone),
			RampUpAutoStartHosts:            to.Ptr(armdesktopvirtualization.StartupBehaviorAll),
			RampUpMinutesToWaitOnDisconnect: to.Ptr[int32](10),
			RampUpMinutesToWaitOnLogoff:     to.Ptr[int32](10),
			RampUpStartTime: &armdesktopvirtualization.Time{
				Hour:   to.Ptr[int32](6),
				Minute: to.Ptr[int32](0),
			},
			RampUpStartVMOnConnect: to.Ptr(armdesktopvirtualization.SetStartVMOnConnectEnable),
		},
	}, 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.ScalingPlanPersonalSchedule = armdesktopvirtualization.ScalingPlanPersonalSchedule{
	// 	Name: to.Ptr("scalingPlanScheduleWeekdays1"),
	// 	Type: to.Ptr("Microsoft.DesktopVirtualization/scalingPlans/personalSchedules"),
	// 	ID: to.Ptr("/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/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.ScalingPlanPersonalScheduleProperties{
	// 		DaysOfWeek: []*armdesktopvirtualization.DayOfWeek{
	// 			to.Ptr(armdesktopvirtualization.DayOfWeekMonday),
	// 			to.Ptr(armdesktopvirtualization.DayOfWeekTuesday),
	// 			to.Ptr(armdesktopvirtualization.DayOfWeekWednesday),
	// 			to.Ptr(armdesktopvirtualization.DayOfWeekThursday),
	// 			to.Ptr(armdesktopvirtualization.DayOfWeekFriday)},
	// 			OffPeakActionOnDisconnect: to.Ptr(armdesktopvirtualization.SessionHandlingOperationNone),
	// 			OffPeakActionOnLogoff: to.Ptr(armdesktopvirtualization.SessionHandlingOperationDeallocate),
	// 			OffPeakMinutesToWaitOnDisconnect: to.Ptr[int32](10),
	// 			OffPeakMinutesToWaitOnLogoff: to.Ptr[int32](10),
	// 			OffPeakStartTime: &armdesktopvirtualization.Time{
	// 				Hour: to.Ptr[int32](20),
	// 				Minute: to.Ptr[int32](0),
	// 			},
	// 			OffPeakStartVMOnConnect: to.Ptr(armdesktopvirtualization.SetStartVMOnConnectEnable),
	// 			PeakActionOnDisconnect: to.Ptr(armdesktopvirtualization.SessionHandlingOperationNone),
	// 			PeakActionOnLogoff: to.Ptr(armdesktopvirtualization.SessionHandlingOperationDeallocate),
	// 			PeakMinutesToWaitOnDisconnect: to.Ptr[int32](10),
	// 			PeakMinutesToWaitOnLogoff: to.Ptr[int32](10),
	// 			PeakStartTime: &armdesktopvirtualization.Time{
	// 				Hour: to.Ptr[int32](8),
	// 				Minute: to.Ptr[int32](0),
	// 			},
	// 			PeakStartVMOnConnect: to.Ptr(armdesktopvirtualization.SetStartVMOnConnectEnable),
	// 			RampDownActionOnDisconnect: to.Ptr(armdesktopvirtualization.SessionHandlingOperationNone),
	// 			RampDownActionOnLogoff: to.Ptr(armdesktopvirtualization.SessionHandlingOperationDeallocate),
	// 			RampDownMinutesToWaitOnDisconnect: to.Ptr[int32](10),
	// 			RampDownMinutesToWaitOnLogoff: to.Ptr[int32](10),
	// 			RampDownStartTime: &armdesktopvirtualization.Time{
	// 				Hour: to.Ptr[int32](18),
	// 				Minute: to.Ptr[int32](0),
	// 			},
	// 			RampDownStartVMOnConnect: to.Ptr(armdesktopvirtualization.SetStartVMOnConnectEnable),
	// 			RampUpActionOnDisconnect: to.Ptr(armdesktopvirtualization.SessionHandlingOperationNone),
	// 			RampUpActionOnLogoff: to.Ptr(armdesktopvirtualization.SessionHandlingOperationNone),
	// 			RampUpAutoStartHosts: to.Ptr(armdesktopvirtualization.StartupBehaviorAll),
	// 			RampUpMinutesToWaitOnDisconnect: to.Ptr[int32](10),
	// 			RampUpMinutesToWaitOnLogoff: to.Ptr[int32](10),
	// 			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 ScalingPlanPersonalSchedule.
 *
 * @summary Create or update a ScalingPlanPersonalSchedule.
 * x-ms-original-file: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/ScalingPlanPersonalSchedule_Create.json
 */
async function scalingPlanPersonalSchedulesCreate() {
  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"],
    offPeakActionOnDisconnect: "None",
    offPeakActionOnLogoff: "Deallocate",
    offPeakMinutesToWaitOnDisconnect: 10,
    offPeakMinutesToWaitOnLogoff: 10,
    offPeakStartTime: { hour: 20, minute: 0 },
    offPeakStartVMOnConnect: "Enable",
    peakActionOnDisconnect: "None",
    peakActionOnLogoff: "Deallocate",
    peakMinutesToWaitOnDisconnect: 10,
    peakMinutesToWaitOnLogoff: 10,
    peakStartTime: { hour: 8, minute: 0 },
    peakStartVMOnConnect: "Enable",
    rampDownActionOnDisconnect: "None",
    rampDownActionOnLogoff: "Deallocate",
    rampDownMinutesToWaitOnDisconnect: 10,
    rampDownMinutesToWaitOnLogoff: 10,
    rampDownStartTime: { hour: 18, minute: 0 },
    rampDownStartVMOnConnect: "Enable",
    rampUpActionOnDisconnect: "None",
    rampUpActionOnLogoff: "None",
    rampUpAutoStartHosts: "All",
    rampUpMinutesToWaitOnDisconnect: 10,
    rampUpMinutesToWaitOnLogoff: 10,
    rampUpStartTime: { hour: 6, minute: 0 },
    rampUpStartVMOnConnect: "Enable",
  };
  const credential = new DefaultAzureCredential();
  const client = new DesktopVirtualizationAPIClient(credential, subscriptionId);
  const result = await client.scalingPlanPersonalSchedules.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/ScalingPlanPersonalSchedule_Create.json
// this example is just showing the usage of "ScalingPlanPersonalSchedules_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 ScalingPlanPersonalScheduleResource
ScalingPlanPersonalScheduleCollection collection = scalingPlan.GetScalingPlanPersonalSchedules();

// invoke the operation
string scalingPlanScheduleName = "scalingPlanScheduleWeekdays1";
ScalingPlanPersonalScheduleData data = new ScalingPlanPersonalScheduleData
{
    DaysOfWeek = { DesktopVirtualizationDayOfWeek.Monday, DesktopVirtualizationDayOfWeek.Tuesday, DesktopVirtualizationDayOfWeek.Wednesday, DesktopVirtualizationDayOfWeek.Thursday, DesktopVirtualizationDayOfWeek.Friday },
    RampUpStartTime = new ScalingActionTime(6, 0),
    RampUpAutoStartHosts = StartupBehavior.All,
    RampUpStartVmOnConnect = SetStartVmOnConnect.Enable,
    RampUpActionOnDisconnect = SessionHandlingOperation.None,
    RampUpMinutesToWaitOnDisconnect = 10,
    RampUpActionOnLogoff = SessionHandlingOperation.None,
    RampUpMinutesToWaitOnLogoff = 10,
    PeakStartTime = new ScalingActionTime(8, 0),
    PeakStartVmOnConnect = SetStartVmOnConnect.Enable,
    PeakActionOnDisconnect = SessionHandlingOperation.None,
    PeakMinutesToWaitOnDisconnect = 10,
    PeakActionOnLogoff = SessionHandlingOperation.Deallocate,
    PeakMinutesToWaitOnLogoff = 10,
    RampDownStartTime = new ScalingActionTime(18, 0),
    RampDownStartVmOnConnect = SetStartVmOnConnect.Enable,
    RampDownActionOnDisconnect = SessionHandlingOperation.None,
    RampDownMinutesToWaitOnDisconnect = 10,
    RampDownActionOnLogoff = SessionHandlingOperation.Deallocate,
    RampDownMinutesToWaitOnLogoff = 10,
    OffPeakStartTime = new ScalingActionTime(20, 0),
    OffPeakStartVmOnConnect = SetStartVmOnConnect.Enable,
    OffPeakActionOnDisconnect = SessionHandlingOperation.None,
    OffPeakMinutesToWaitOnDisconnect = 10,
    OffPeakActionOnLogoff = SessionHandlingOperation.Deallocate,
    OffPeakMinutesToWaitOnLogoff = 10,
};
ArmOperation<ScalingPlanPersonalScheduleResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, scalingPlanScheduleName, data);
ScalingPlanPersonalScheduleResource 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
ScalingPlanPersonalScheduleData 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

Beispiel für eine Antwort

Statuscode:

200

{
  "name": "scalingPlanScheduleWeekdays1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1",
  "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules",
  "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
    },
    "rampUpAutoStartHosts": "All",
    "rampUpActionOnDisconnect": "None",
    "rampUpMinutesToWaitOnDisconnect": 10,
    "rampUpActionOnLogoff": "None",
    "rampUpMinutesToWaitOnLogoff": 10,
    "peakStartTime": {
      "hour": 8,
      "minute": 0
    },
    "peakStartVMOnConnect": "Enable",
    "peakActionOnDisconnect": "None",
    "peakMinutesToWaitOnDisconnect": 10,
    "peakActionOnLogoff": "Deallocate",
    "peakMinutesToWaitOnLogoff": 10,
    "rampDownStartTime": {
      "hour": 18,
      "minute": 0
    },
    "rampDownStartVMOnConnect": "Enable",
    "rampDownActionOnDisconnect": "None",
    "rampDownMinutesToWaitOnDisconnect": 10,
    "rampDownActionOnLogoff": "Deallocate",
    "rampDownMinutesToWaitOnLogoff": 10,
    "offPeakStartTime": {
      "hour": 20,
      "minute": 0
    },
    "offPeakStartVMOnConnect": "Enable",
    "offPeakActionOnDisconnect": "None",
    "offPeakMinutesToWaitOnDisconnect": 10,
    "offPeakActionOnLogoff": "Deallocate",
    "offPeakMinutesToWaitOnLogoff": 10
  }
}

Statuscode:

201

{
  "name": "scalingPlanScheduleWeekdays1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1",
  "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules",
  "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
    },
    "rampUpAutoStartHosts": "All",
    "rampUpStartVMOnConnect": "Enable",
    "rampUpActionOnDisconnect": "None",
    "rampUpMinutesToWaitOnDisconnect": 10,
    "rampUpActionOnLogoff": "None",
    "rampUpMinutesToWaitOnLogoff": 10,
    "peakStartTime": {
      "hour": 8,
      "minute": 0
    },
    "peakStartVMOnConnect": "Enable",
    "peakActionOnDisconnect": "Deallocate",
    "peakMinutesToWaitOnDisconnect": 10,
    "peakActionOnLogoff": "Deallocate",
    "peakMinutesToWaitOnLogoff": 10,
    "rampDownStartTime": {
      "hour": 18,
      "minute": 0
    },
    "rampDownStartVMOnConnect": "Enable",
    "rampDownActionOnDisconnect": "None",
    "rampDownMinutesToWaitOnDisconnect": 10,
    "rampDownActionOnLogoff": "Deallocate",
    "rampDownMinutesToWaitOnLogoff": 10,
    "offPeakStartTime": {
      "hour": 20,
      "minute": 0
    },
    "offPeakStartVMOnConnect": "Enable",
    "offPeakActionOnDisconnect": "None",
    "offPeakMinutesToWaitOnDisconnect": 10,
    "offPeakActionOnLogoff": "Deallocate",
    "offPeakMinutesToWaitOnLogoff": 10
  }
}

Definitionen

Name	Beschreibung
CloudError	Cloudfehlerobjekt.
CloudErrorProperties	Eigenschaften des Cloudfehlerobjekts.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DayOfWeek	Wochentag.
ScalingPlanPersonalSchedule	Stellt eine ScalingPlanPersonalSchedule-Definition dar.
SessionHandlingOperation	Aktion, die ausgeführt werden soll, nachdem ein Benutzer die Verbindung während des Anlaufzeitraums getrennt hat.
SetStartVMOnConnect	Die gewünschte Konfiguration von Start VM On Connect für den Hostpool während der Ramp up-Phase. Wenn dies deaktiviert ist, müssen Sitzungshosts mithilfe von rampUpAutoStartHosts aktiviert oder manuell aktiviert werden.
StartupBehavior	Das gewünschte Startverhalten während des Ramp up-Zeitraums für persönliche VMs im Hostpool.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
Time	Die Zeit für die Eintreten einer Skalierungsaktion.

CloudError

Objekt

Cloudfehlerobjekt.

Name	Typ	Beschreibung
error	CloudErrorProperties	Eigenschaften des Cloudfehlerobjekts.

CloudErrorProperties

Objekt

Eigenschaften des Cloudfehlerobjekts.

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
Application
Key
ManagedIdentity
User

DayOfWeek

Enumeration

Wochentag.

Wert	Beschreibung
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

ScalingPlanPersonalSchedule

Objekt

Stellt eine ScalingPlanPersonalSchedule-Definition dar.

Name	Typ	Standardwert	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.offPeakActionOnDisconnect	SessionHandlingOperation		Aktion, die ausgeführt werden soll, nachdem ein Benutzer während des Zeitraums außerhalb des Spitzenzeitpunkts getrennt wurde.
properties.offPeakActionOnLogoff	SessionHandlingOperation		Maßnahmen, die nach einer Abmeldung während des Abmeldungszeitraums ausgeführt werden sollen.
properties.offPeakMinutesToWaitOnDisconnect	integer (int32) minimum: 0		Die Zeit in Minuten, bis die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn ein Benutzer während des Zeitraums außerhalb des Spitzenzeitpunkts getrennt wird.
properties.offPeakMinutesToWaitOnLogoff	integer (int32) minimum: 0		Die Zeit in Minuten, bis die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn sich ein Benutzer während des Zeitraums außerhalb des Spitzenzeitpunkts abmeldet.
properties.offPeakStartTime	Time		Startzeit für den Zeitraum außerhalb des Höchstwerts.
properties.offPeakStartVMOnConnect	SetStartVMOnConnect	Enable	Die gewünschte Konfiguration von "VM on Connect starten" für den Hostpool während der Spitzenphase.
properties.peakActionOnDisconnect	SessionHandlingOperation		Aktion, die nach dem Trennen eines Benutzers während des Spitzenzeitraums ausgeführt werden soll.
properties.peakActionOnLogoff	SessionHandlingOperation		Aktion, die nach einer Abmeldung während der Spitzenzeit ausgeführt werden soll.
properties.peakMinutesToWaitOnDisconnect	integer (int32) minimum: 0		Die Zeit in Minuten, bis die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn ein Benutzer während des Spitzenzeitraums getrennt wird.
properties.peakMinutesToWaitOnLogoff	integer (int32) minimum: 0		Die Zeit in Minuten, bis die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn sich ein Benutzer während des Spitzenzeitraums abmeldet.
properties.peakStartTime	Time		Startzeit für Spitzenzeit.
properties.peakStartVMOnConnect	SetStartVMOnConnect	Enable	Die gewünschte Konfiguration von Start VM On Connect für den Hostpool während der Spitzenphase.
properties.rampDownActionOnDisconnect	SessionHandlingOperation		Aktion, die ausgeführt werden soll, nachdem ein Benutzer während des Rampdownzeitraums die Verbindung getrennt hat.
properties.rampDownActionOnLogoff	SessionHandlingOperation		Aktion, die nach einer Abmeldung während des Rampdown-Zeitraums ausgeführt werden soll.
properties.rampDownMinutesToWaitOnDisconnect	integer (int32) minimum: 0		Die Zeit in Minuten, bis die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn ein Benutzer während des Rampdownzeitraums getrennt wird.
properties.rampDownMinutesToWaitOnLogoff	integer (int32) minimum: 0		Die Zeit in Minuten, bis die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn sich ein Benutzer während des Rampdownzeitraums abmeldet.
properties.rampDownStartTime	Time		Startzeit für ramp down period.
properties.rampDownStartVMOnConnect	SetStartVMOnConnect	Enable	Die gewünschte Konfiguration von Start VM On Connect für den Hostpool während der Rampdownphase.
properties.rampUpActionOnDisconnect	SessionHandlingOperation		Aktion, die ausgeführt werden soll, nachdem ein Benutzer die Verbindung während des Anlaufzeitraums getrennt hat.
properties.rampUpActionOnLogoff	SessionHandlingOperation		Aktion, die nach einer Abmeldung während des Anlaufzeitraums ausgeführt werden soll.
properties.rampUpAutoStartHosts	StartupBehavior		Das gewünschte Startverhalten während des Ramp up-Zeitraums für persönliche VMs im Hostpool.
properties.rampUpMinutesToWaitOnDisconnect	integer (int32) minimum: 0		Die Zeit in Minuten, die gewartet werden soll, bevor die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn ein Benutzer während des Ramp up-Zeitraums getrennt wird.
properties.rampUpMinutesToWaitOnLogoff	integer (int32) minimum: 0		Die Zeit in Minuten, bis die gewünschte Sitzungsbehandlungsaktion ausgeführt wird, wenn sich ein Benutzer während des Rampupzeitraums abmeldet.
properties.rampUpStartTime	Time		Startzeit für den Hochstartzeitraum.
properties.rampUpStartVMOnConnect	SetStartVMOnConnect	Enable	Die gewünschte Konfiguration von Start VM On Connect für den Hostpool während der Ramp up-Phase. Wenn dies deaktiviert ist, müssen Sitzungshosts mithilfe von rampUpAutoStartHosts aktiviert oder manuell aktiviert werden.
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"

SessionHandlingOperation

Enumeration

Aktion, die ausgeführt werden soll, nachdem ein Benutzer die Verbindung während des Anlaufzeitraums getrennt hat.

Wert	Beschreibung
Deallocate
None

SetStartVMOnConnect

Enumeration

Die gewünschte Konfiguration von Start VM On Connect für den Hostpool während der Ramp up-Phase. Wenn dies deaktiviert ist, müssen Sitzungshosts mithilfe von rampUpAutoStartHosts aktiviert oder manuell aktiviert werden.

Wert	Beschreibung
Disable
Enable

StartupBehavior

Enumeration

Das gewünschte Startverhalten während des Ramp up-Zeitraums für persönliche VMs im Hostpool.

Wert	Beschreibung
All	Alle persönlichen Sitzungshosts im Hostpool werden während des Hochfahrens gestartet.
None	Sitzungshosts werden vom Dienst nicht gestartet. Diese Einstellung hängt davon ab, dass der virtuelle Computer unter "Verbinden starten" aktiviert ist, um die Sitzungshosts zu starten.
WithAssignedUser	Sitzungshosts mit einem zugewiesenen Benutzer werden während der Ramp Up gestartet

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 für die Eintreten einer Skalierungsaktion.

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