Scaling Plan Personal Schedules - Create

服务:

Desktop Virtualization

API 版本:

2024-04-03

创建或更新 ScalingPlanPersonalSchedule。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 名称不区分大小写。
scalingPlanName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	缩放计划的名称。
scalingPlanScheduleName	path	True	string minLength: 1 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	ScalingPlanSchedule 的名称
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	类型	说明
properties.daysOfWeek	DayOfWeek[]	此计划处于活动状态的一周中的天数集。
properties.offPeakActionOnDisconnect	SessionHandlingOperation	在非高峰期用户断开连接后要执行的操作。
properties.offPeakActionOnLogoff	SessionHandlingOperation	在非高峰期注销后要执行的操作。
properties.offPeakMinutesToWaitOnDisconnect	integer (int32) minimum: 0	当用户在非高峰期断开连接时，在执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.offPeakMinutesToWaitOnLogoff	integer (int32) minimum: 0	当用户在非高峰期注销时，在执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.offPeakStartTime	Time	非高峰期的开始时间。
properties.offPeakStartVMOnConnect	SetStartVMOnConnect	在非高峰阶段，主机池的“启动 VM On Connect”的所需配置。
properties.peakActionOnDisconnect	SessionHandlingOperation	在高峰期用户断开连接后要执行的操作。
properties.peakActionOnLogoff	SessionHandlingOperation	在高峰期注销后要执行的操作。
properties.peakMinutesToWaitOnDisconnect	integer (int32) minimum: 0	当用户在高峰期断开连接时执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.peakMinutesToWaitOnLogoff	integer (int32) minimum: 0	当用户在高峰期注销时，在执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.peakStartTime	Time	高峰期的开始时间。
properties.peakStartVMOnConnect	SetStartVMOnConnect	在高峰阶段，主机池的 Start VM On Connect 所需配置。
properties.rampDownActionOnDisconnect	SessionHandlingOperation	用户在斜坡下降期间断开连接后要执行的操作。
properties.rampDownActionOnLogoff	SessionHandlingOperation	在斜坡下降期间注销后要执行的操作。
properties.rampDownMinutesToWaitOnDisconnect	integer (int32) minimum: 0	当用户在斜坡下降期间断开连接时，在执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.rampDownMinutesToWaitOnLogoff	integer (int32) minimum: 0	当用户在斜坡下降期间注销时，在执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.rampDownStartTime	Time	渐变期的开始时间。
properties.rampDownStartVMOnConnect	SetStartVMOnConnect	在向下坡道阶段，主机池的“启动 VM On Connect”的所需配置。
properties.rampUpActionOnDisconnect	SessionHandlingOperation	用户在纵向扩展期间断开连接后要执行的操作。
properties.rampUpActionOnLogoff	SessionHandlingOperation	在增加期间注销后要执行的操作。
properties.rampUpAutoStartHosts	StartupBehavior	主机池中个人 VM 在纵向扩展期间所需的启动行为。
properties.rampUpMinutesToWaitOnDisconnect	integer (int32) minimum: 0	当用户在纵向扩展期间断开连接时，在执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.rampUpMinutesToWaitOnLogoff	integer (int32) minimum: 0	当用户在增加期间注销时，在执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.rampUpStartTime	Time	加速周期的开始时间。
properties.rampUpStartVMOnConnect	SetStartVMOnConnect	在纵向扩展阶段，主机池的“启动 VM On Connect”的所需配置。 如果已禁用，则必须使用 rampUpAutoStartHosts 或手动打开会话主机。

响应

名称	类型	说明
200 OK	ScalingPlanPersonalSchedule	已成功更新 ScalingPlanPersonalSchedule。
201 Created	ScalingPlanPersonalSchedule	已成功创建 ScalingPlanPersonalSchedule。
Other Status Codes	CloudError	描述操作失败原因的自动化错误响应。

示例

ScalingPlanPersonalSchedules_Create

示例请求

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

示例响应

状态代码:

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

状态代码:

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

定义

名称	说明
CloudError	云错误对象。
CloudErrorProperties	云错误对象属性。
createdByType	创建资源的标识的类型。
DayOfWeek	一周中的一天。
ScalingPlanPersonalSchedule	表示 ScalingPlanPersonalSchedule 定义。
SessionHandlingOperation	用户在纵向扩展期间断开连接后要执行的操作。
SetStartVMOnConnect	在纵向扩展阶段，主机池的“启动 VM On Connect”的所需配置。 如果已禁用，则必须使用 rampUpAutoStartHosts 或手动打开会话主机。
StartupBehavior	主机池中个人 VM 在纵向扩展期间所需的启动行为。
systemData	与创建和上次修改资源相关的元数据。
Time	缩放操作发生的时间。

CloudError

Object

云错误对象。

名称	类型	说明
error	CloudErrorProperties	云错误对象属性。

CloudErrorProperties

Object

云错误对象属性。

名称	类型	说明
code	string	错误代码
message	string	指示操作失败的原因的错误消息。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DayOfWeek

枚举

一周中的一天。

值	说明
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

ScalingPlanPersonalSchedule

Object

表示 ScalingPlanPersonalSchedule 定义。

名称	类型	默认值	说明
id	string (arm-id)		资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string		资源的名称
properties.daysOfWeek	DayOfWeek[]		此计划处于活动状态的一周中的天数集。
properties.offPeakActionOnDisconnect	SessionHandlingOperation		在非高峰期用户断开连接后要执行的操作。
properties.offPeakActionOnLogoff	SessionHandlingOperation		在非高峰期注销后要执行的操作。
properties.offPeakMinutesToWaitOnDisconnect	integer (int32) minimum: 0		当用户在非高峰期断开连接时，在执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.offPeakMinutesToWaitOnLogoff	integer (int32) minimum: 0		当用户在非高峰期注销时，在执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.offPeakStartTime	Time		非高峰期的开始时间。
properties.offPeakStartVMOnConnect	SetStartVMOnConnect	Enable	在非高峰阶段，主机池的“启动 VM On Connect”的所需配置。
properties.peakActionOnDisconnect	SessionHandlingOperation		在高峰期用户断开连接后要执行的操作。
properties.peakActionOnLogoff	SessionHandlingOperation		在高峰期注销后要执行的操作。
properties.peakMinutesToWaitOnDisconnect	integer (int32) minimum: 0		当用户在高峰期断开连接时执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.peakMinutesToWaitOnLogoff	integer (int32) minimum: 0		当用户在高峰期注销时，在执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.peakStartTime	Time		高峰期的开始时间。
properties.peakStartVMOnConnect	SetStartVMOnConnect	Enable	在高峰阶段，主机池的 Start VM On Connect 所需配置。
properties.rampDownActionOnDisconnect	SessionHandlingOperation		用户在斜坡下降期间断开连接后要执行的操作。
properties.rampDownActionOnLogoff	SessionHandlingOperation		在斜坡下降期间注销后要执行的操作。
properties.rampDownMinutesToWaitOnDisconnect	integer (int32) minimum: 0		当用户在斜坡下降期间断开连接时，在执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.rampDownMinutesToWaitOnLogoff	integer (int32) minimum: 0		当用户在斜坡下降期间注销时，在执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.rampDownStartTime	Time		渐变期的开始时间。
properties.rampDownStartVMOnConnect	SetStartVMOnConnect	Enable	在向下坡道阶段，主机池的“启动 VM On Connect”的所需配置。
properties.rampUpActionOnDisconnect	SessionHandlingOperation		用户在纵向扩展期间断开连接后要执行的操作。
properties.rampUpActionOnLogoff	SessionHandlingOperation		在增加期间注销后要执行的操作。
properties.rampUpAutoStartHosts	StartupBehavior		主机池中个人 VM 在纵向扩展期间所需的启动行为。
properties.rampUpMinutesToWaitOnDisconnect	integer (int32) minimum: 0		当用户在纵向扩展期间断开连接时，在执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.rampUpMinutesToWaitOnLogoff	integer (int32) minimum: 0		当用户在增加期间注销时，在执行所需会话处理操作之前等待的时间（以分钟为单位）。
properties.rampUpStartTime	Time		加速周期的开始时间。
properties.rampUpStartVMOnConnect	SetStartVMOnConnect	Enable	在纵向扩展阶段，主机池的“启动 VM On Connect”的所需配置。 如果已禁用，则必须使用 rampUpAutoStartHosts 或手动打开会话主机。
systemData	systemData		与创建和上次修改资源相关的元数据。
type	string		资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

SessionHandlingOperation

枚举

用户在纵向扩展期间断开连接后要执行的操作。

值	说明
Deallocate
None

SetStartVMOnConnect

枚举

在纵向扩展阶段，主机池的“启动 VM On Connect”的所需配置。 如果已禁用，则必须使用 rampUpAutoStartHosts 或手动打开会话主机。

值	说明
Disable
Enable

StartupBehavior

枚举

主机池中个人 VM 在纵向扩展期间所需的启动行为。

值	说明
All	主机池中的所有个人会话主机将在纵向扩展期间启动。
None	会话主机不会由服务启动。 此设置取决于要启用的“连接”上的“启动 VM”来启动会话主机。
WithAssignedUser	具有已分配用户的会话主机将在 Ramp Up 期间启动

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

Time

Object

缩放操作发生的时间。

名称	类型	说明
hour	integer (int32) minimum: 0 maximum: 23	小时。
minute	integer (int32) minimum: 0 maximum: 59	分钟。