Scaling Plan Personal Schedules - Update

Serviço:

Desktop Virtualization

Versão da API:

2024-04-03

Atualize um ScalingPlanPersonalSchedule.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
scalingPlanName	path	True	string	O nome do plano de dimensionamento. Padrão Regex: ^[A-Za-z0-9@.\-_ ]*$
scalingPlanScheduleName	path	True	string	O nome do ScalingPlanSchedule Padrão Regex: ^[A-Za-z0-9@.\-_ ]*$
subscriptionId	path	True	string uuid	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties.daysOfWeek	DayOfWeek[]	Conjunto de dias da semana em que este horário está ativo.
properties.offPeakActionOnDisconnect	SessionHandlingOperation	Ação a ser tomada após a desconexão de um usuário durante o período fora de pico.
properties.offPeakActionOnLogoff	SessionHandlingOperation	Ação a ser tomada após um logoff durante o período fora de pico.
properties.offPeakMinutesToWaitOnDisconnect	integer	O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário se desconecta durante o período fora de pico.
properties.offPeakMinutesToWaitOnLogoff	integer	O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário faz logoff durante o período fora de pico.
properties.offPeakStartTime	Time	Hora de início para o período fora de pico.
properties.offPeakStartVMOnConnect	SetStartVMOnConnect	A configuração desejada de Start VM On Connect para o hostpool durante a fase fora de pico.
properties.peakActionOnDisconnect	SessionHandlingOperation	Ação a ser tomada após a desconexão de um usuário durante o período de pico.
properties.peakActionOnLogoff	SessionHandlingOperation	Ação a ser tomada após um logoff durante o período de pico.
properties.peakMinutesToWaitOnDisconnect	integer	O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário se desconecta durante o período de pico.
properties.peakMinutesToWaitOnLogoff	integer	O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário faz logoff durante o período de pico.
properties.peakStartTime	Time	Hora de início para o período de pico.
properties.peakStartVMOnConnect	SetStartVMOnConnect	A configuração desejada de Start VM On Connect para o hostpool durante a fase de pico.
properties.rampDownActionOnDisconnect	SessionHandlingOperation	Ação a ser tomada após a desconexão de um usuário durante o período de ramp down.
properties.rampDownActionOnLogoff	SessionHandlingOperation	Ação a ser tomada após um logoff durante o período de rampa.
properties.rampDownMinutesToWaitOnDisconnect	integer	O tempo em minutos para esperar antes de executar a ação de manipulação de sessão desejada quando um usuário se desconecta durante o período de rampa down.
properties.rampDownMinutesToWaitOnLogoff	integer	O tempo em minutos para esperar antes de executar a ação de manipulação de sessão desejada quando um usuário faz logoff durante o período de ramp down.
properties.rampDownStartTime	Time	Hora de início para o período de rampa down.
properties.rampDownStartVMOnConnect	SetStartVMOnConnect	A configuração desejada de Start VM On Connect para o hostpool durante a fase de ramp down.
properties.rampUpActionOnDisconnect	SessionHandlingOperation	Ação a ser tomada após a desconexão de um usuário durante o período de ramp up.
properties.rampUpActionOnLogoff	SessionHandlingOperation	Ação a ser tomada após um logoff durante o período de ramp up.
properties.rampUpAutoStartHosts	StartupBehavior	O comportamento de inicialização desejado durante o período de ramp up para vms pessoais no hostpool.
properties.rampUpMinutesToWaitOnDisconnect	integer	O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário se desconecta durante o período de ramp up.
properties.rampUpMinutesToWaitOnLogoff	integer	O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário faz logoff durante o período de ramp up.
properties.rampUpStartTime	Time	Hora de início para o período de ramp up.
properties.rampUpStartVMOnConnect	SetStartVMOnConnect	A configuração desejada de Start VM On Connect para o hostpool durante a fase de ramp up. Se isso estiver desabilitado, os hosts de sessão deverão ser ativados usando rampUpAutoStartHosts ou ativando-os manualmente.

Respostas

Name	Tipo	Description
200 OK	ScalingPlanPersonalSchedule	ScalingPlanPersonalSchedule atualizado com êxito.
Other Status Codes	CloudError	Resposta de erro de automação descrevendo por que a operação falhou.

Exemplos

ScalingPlanPersonalSchedules_Update

Pedido de amostra

HTTP

PATCH 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": {
    "peakStartTime": {
      "hour": 8,
      "minute": 0
    },
    "peakActionOnDisconnect": "None",
    "peakMinutesToWaitOnDisconnect": 10,
    "peakActionOnLogoff": "Deallocate",
    "peakMinutesToWaitOnLogoff": 10,
    "rampDownStartTime": {
      "hour": 18,
      "minute": 0
    },
    "rampDownActionOnDisconnect": "None",
    "rampDownMinutesToWaitOnDisconnect": 10,
    "rampDownActionOnLogoff": "Deallocate",
    "rampDownMinutesToWaitOnLogoff": 10,
    "offPeakStartTime": {
      "hour": 20,
      "minute": 0
    },
    "offPeakStartVMOnConnect": "Disable",
    "offPeakActionOnDisconnect": "None",
    "offPeakMinutesToWaitOnDisconnect": 10,
    "offPeakActionOnLogoff": "Deallocate",
    "offPeakMinutesToWaitOnLogoff": 10
  }
}

Java

import com.azure.resourcemanager.desktopvirtualization.models.ScalingPlanPersonalSchedule;
import com.azure.resourcemanager.desktopvirtualization.models.SessionHandlingOperation;
import com.azure.resourcemanager.desktopvirtualization.models.SetStartVMOnConnect;
import com.azure.resourcemanager.desktopvirtualization.models.Time;

/**
 * Samples for ScalingPlanPersonalSchedules Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/
     * ScalingPlanPersonalSchedule_Update.json
     */
    /**
     * Sample code: ScalingPlanPersonalSchedules_Update.
     * 
     * @param manager Entry point to DesktopVirtualizationManager.
     */
    public static void scalingPlanPersonalSchedulesUpdate(
        com.azure.resourcemanager.desktopvirtualization.DesktopVirtualizationManager manager) {
        ScalingPlanPersonalSchedule resource = manager.scalingPlanPersonalSchedules().getWithResponse("resourceGroup1",
            "scalingPlan1", "scalingPlanScheduleWeekdays1", com.azure.core.util.Context.NONE).getValue();
        resource.update().withPeakStartTime(new Time().withHour(8).withMinute(0))
            .withPeakActionOnDisconnect(SessionHandlingOperation.NONE).withPeakMinutesToWaitOnDisconnect(10)
            .withPeakActionOnLogoff(SessionHandlingOperation.DEALLOCATE).withPeakMinutesToWaitOnLogoff(10)
            .withRampDownStartTime(new Time().withHour(18).withMinute(0))
            .withRampDownActionOnDisconnect(SessionHandlingOperation.NONE).withRampDownMinutesToWaitOnDisconnect(10)
            .withRampDownActionOnLogoff(SessionHandlingOperation.DEALLOCATE).withRampDownMinutesToWaitOnLogoff(10)
            .withOffPeakStartTime(new Time().withHour(20).withMinute(0))
            .withOffPeakStartVMOnConnect(SetStartVMOnConnect.DISABLE)
            .withOffPeakActionOnDisconnect(SessionHandlingOperation.NONE).withOffPeakMinutesToWaitOnDisconnect(10)
            .withOffPeakActionOnLogoff(SessionHandlingOperation.DEALLOCATE).withOffPeakMinutesToWaitOnLogoff(10)
            .apply();
    }
}

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_update.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.update(
        resource_group_name="resourceGroup1",
        scaling_plan_name="scalingPlan1",
        scaling_plan_schedule_name="scalingPlanScheduleWeekdays1",
    )
    print(response)


# x-ms-original-file: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/ScalingPlanPersonalSchedule_Update.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_Update.json
func ExampleScalingPlanPersonalSchedulesClient_Update() {
	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().Update(ctx, "resourceGroup1", "scalingPlan1", "scalingPlanScheduleWeekdays1", &armdesktopvirtualization.ScalingPlanPersonalSchedulesClientUpdateOptions{ScalingPlanSchedule: &armdesktopvirtualization.ScalingPlanPersonalSchedulePatch{
		Properties: &armdesktopvirtualization.ScalingPlanPersonalScheduleProperties{
			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.SetStartVMOnConnectDisable),
			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),
			},
			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),
			},
		},
	},
	})
	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.SetStartVMOnConnectDisable),
	// 			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),
	// 		},
	// 	}
}

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 Update a ScalingPlanPersonalSchedule.
 *
 * @summary Update a ScalingPlanPersonalSchedule.
 * x-ms-original-file: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/stable/2024-04-03/examples/ScalingPlanPersonalSchedule_Update.json
 */
async function scalingPlanPersonalSchedulesUpdate() {
  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 = {
    offPeakActionOnDisconnect: "None",
    offPeakActionOnLogoff: "Deallocate",
    offPeakMinutesToWaitOnDisconnect: 10,
    offPeakMinutesToWaitOnLogoff: 10,
    offPeakStartTime: { hour: 20, minute: 0 },
    offPeakStartVMOnConnect: "Disable",
    peakActionOnDisconnect: "None",
    peakActionOnLogoff: "Deallocate",
    peakMinutesToWaitOnDisconnect: 10,
    peakMinutesToWaitOnLogoff: 10,
    peakStartTime: { hour: 8, minute: 0 },
    rampDownActionOnDisconnect: "None",
    rampDownActionOnLogoff: "Deallocate",
    rampDownMinutesToWaitOnDisconnect: 10,
    rampDownMinutesToWaitOnLogoff: 10,
    rampDownStartTime: { hour: 18, minute: 0 },
  };
  const options = {
    scalingPlanSchedule,
  };
  const credential = new DefaultAzureCredential();
  const client = new DesktopVirtualizationAPIClient(credential, subscriptionId);
  const result = await client.scalingPlanPersonalSchedules.update(
    resourceGroupName,
    scalingPlanName,
    scalingPlanScheduleName,
    options,
  );
  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_Update.json
// this example is just showing the usage of "ScalingPlanPersonalSchedules_Update" 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 ScalingPlanPersonalScheduleResource created on azure
// for more information of creating ScalingPlanPersonalScheduleResource, please refer to the document of ScalingPlanPersonalScheduleResource
string subscriptionId = "daefabc0-95b4-48b3-b645-8a753a63c4fa";
string resourceGroupName = "resourceGroup1";
string scalingPlanName = "scalingPlan1";
string scalingPlanScheduleName = "scalingPlanScheduleWeekdays1";
ResourceIdentifier scalingPlanPersonalScheduleResourceId = ScalingPlanPersonalScheduleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, scalingPlanName, scalingPlanScheduleName);
ScalingPlanPersonalScheduleResource scalingPlanPersonalSchedule = client.GetScalingPlanPersonalScheduleResource(scalingPlanPersonalScheduleResourceId);

// invoke the operation
ScalingPlanPersonalSchedulePatch patch = new ScalingPlanPersonalSchedulePatch()
{
    PeakStartTime = new ScalingActionTime(8, 0),
    PeakActionOnDisconnect = SessionHandlingOperation.None,
    PeakMinutesToWaitOnDisconnect = 10,
    PeakActionOnLogoff = SessionHandlingOperation.Deallocate,
    PeakMinutesToWaitOnLogoff = 10,
    RampDownStartTime = new ScalingActionTime(18, 0),
    RampDownActionOnDisconnect = SessionHandlingOperation.None,
    RampDownMinutesToWaitOnDisconnect = 10,
    RampDownActionOnLogoff = SessionHandlingOperation.Deallocate,
    RampDownMinutesToWaitOnLogoff = 10,
    OffPeakStartTime = new ScalingActionTime(20, 0),
    OffPeakStartVmOnConnect = SetStartVmOnConnect.Disable,
    OffPeakActionOnDisconnect = SessionHandlingOperation.None,
    OffPeakMinutesToWaitOnDisconnect = 10,
    OffPeakActionOnLogoff = SessionHandlingOperation.Deallocate,
    OffPeakMinutesToWaitOnLogoff = 10,
};
ScalingPlanPersonalScheduleResource result = await scalingPlanPersonalSchedule.UpdateAsync(patch);

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

Resposta da amostra

Código de estado:

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",
    "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": "Disable",
    "offPeakActionOnDisconnect": "None",
    "offPeakMinutesToWaitOnDisconnect": 10,
    "offPeakActionOnLogoff": "Deallocate",
    "offPeakMinutesToWaitOnLogoff": 10
  }
}

Definições

Name	Description
CloudError	Objeto de erro na nuvem.
CloudErrorProperties	Propriedades do objeto de erro na nuvem.
createdByType	O tipo de identidade que criou o recurso.
DayOfWeek	Dia da semana.
ScalingPlanPersonalSchedule	Representa uma definição ScalingPlanPersonalSchedule.
ScalingPlanPersonalSchedulePatch	ScalingPlanPersonalSchedule propriedades que podem ser corrigidas.
SessionHandlingOperation	Ação a ser tomada após a desconexão de um usuário durante o período de ramp up.
SetStartVMOnConnect	A configuração desejada de Start VM On Connect para o hostpool durante a fase de ramp up. Se isso estiver desabilitado, os hosts de sessão deverão ser ativados usando rampUpAutoStartHosts ou ativando-os manualmente.
StartupBehavior	O comportamento de inicialização desejado durante o período de ramp up para vms pessoais no hostpool.
systemData	Metadados referentes à criação e última modificação do recurso.
Time	O tempo para uma ação de dimensionamento ocorrer.

CloudError

Objeto de erro na nuvem.

Name	Tipo	Description
error	CloudErrorProperties	Propriedades do objeto de erro na nuvem.

CloudErrorProperties

Propriedades do objeto de erro na nuvem.

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

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DayOfWeek

Dia da semana.

Name	Tipo	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ScalingPlanPersonalSchedule

Representa uma definição ScalingPlanPersonalSchedule.

Name	Tipo	Default value	Description
id	string		ID de recurso totalmente qualificado 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 este horário está ativo.
properties.offPeakActionOnDisconnect	SessionHandlingOperation		Ação a ser tomada após a desconexão de um usuário durante o período fora de pico.
properties.offPeakActionOnLogoff	SessionHandlingOperation		Ação a ser tomada após um logoff durante o período fora de pico.
properties.offPeakMinutesToWaitOnDisconnect	integer		O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário se desconecta durante o período fora de pico.
properties.offPeakMinutesToWaitOnLogoff	integer		O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário faz logoff durante o período fora de pico.
properties.offPeakStartTime	Time		Hora de início para o período fora de pico.
properties.offPeakStartVMOnConnect	SetStartVMOnConnect	Enable	A configuração desejada de Start VM On Connect para o hostpool durante a fase fora de pico.
properties.peakActionOnDisconnect	SessionHandlingOperation		Ação a ser tomada após a desconexão de um usuário durante o período de pico.
properties.peakActionOnLogoff	SessionHandlingOperation		Ação a ser tomada após um logoff durante o período de pico.
properties.peakMinutesToWaitOnDisconnect	integer		O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário se desconecta durante o período de pico.
properties.peakMinutesToWaitOnLogoff	integer		O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário faz logoff durante o período de pico.
properties.peakStartTime	Time		Hora de início para o período de pico.
properties.peakStartVMOnConnect	SetStartVMOnConnect	Enable	A configuração desejada de Start VM On Connect para o hostpool durante a fase de pico.
properties.rampDownActionOnDisconnect	SessionHandlingOperation		Ação a ser tomada após a desconexão de um usuário durante o período de ramp down.
properties.rampDownActionOnLogoff	SessionHandlingOperation		Ação a ser tomada após um logoff durante o período de rampa.
properties.rampDownMinutesToWaitOnDisconnect	integer		O tempo em minutos para esperar antes de executar a ação de manipulação de sessão desejada quando um usuário se desconecta durante o período de rampa down.
properties.rampDownMinutesToWaitOnLogoff	integer		O tempo em minutos para esperar antes de executar a ação de manipulação de sessão desejada quando um usuário faz logoff durante o período de ramp down.
properties.rampDownStartTime	Time		Hora de início para o período de rampa down.
properties.rampDownStartVMOnConnect	SetStartVMOnConnect	Enable	A configuração desejada de Start VM On Connect para o hostpool durante a fase de ramp down.
properties.rampUpActionOnDisconnect	SessionHandlingOperation		Ação a ser tomada após a desconexão de um usuário durante o período de ramp up.
properties.rampUpActionOnLogoff	SessionHandlingOperation		Ação a ser tomada após um logoff durante o período de ramp up.
properties.rampUpAutoStartHosts	StartupBehavior		O comportamento de inicialização desejado durante o período de ramp up para vms pessoais no hostpool.
properties.rampUpMinutesToWaitOnDisconnect	integer		O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário se desconecta durante o período de ramp up.
properties.rampUpMinutesToWaitOnLogoff	integer		O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário faz logoff durante o período de ramp up.
properties.rampUpStartTime	Time		Hora de início para o período de ramp up.
properties.rampUpStartVMOnConnect	SetStartVMOnConnect	Enable	A configuração desejada de Start VM On Connect para o hostpool durante a fase de ramp up. Se isso estiver desabilitado, os hosts de sessão deverão ser ativados usando rampUpAutoStartHosts ou ativando-os manualmente.
systemData	systemData		Metadados referentes à criação e última modificação do recurso.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ScalingPlanPersonalSchedulePatch

ScalingPlanPersonalSchedule propriedades que podem ser corrigidas.

Name	Tipo	Default value	Description
properties.daysOfWeek	DayOfWeek[]		Conjunto de dias da semana em que este horário está ativo.
properties.offPeakActionOnDisconnect	SessionHandlingOperation		Ação a ser tomada após a desconexão de um usuário durante o período fora de pico.
properties.offPeakActionOnLogoff	SessionHandlingOperation		Ação a ser tomada após um logoff durante o período fora de pico.
properties.offPeakMinutesToWaitOnDisconnect	integer		O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário se desconecta durante o período fora de pico.
properties.offPeakMinutesToWaitOnLogoff	integer		O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário faz logoff durante o período fora de pico.
properties.offPeakStartTime	Time		Hora de início para o período fora de pico.
properties.offPeakStartVMOnConnect	SetStartVMOnConnect	Enable	A configuração desejada de Start VM On Connect para o hostpool durante a fase fora de pico.
properties.peakActionOnDisconnect	SessionHandlingOperation		Ação a ser tomada após a desconexão de um usuário durante o período de pico.
properties.peakActionOnLogoff	SessionHandlingOperation		Ação a ser tomada após um logoff durante o período de pico.
properties.peakMinutesToWaitOnDisconnect	integer		O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário se desconecta durante o período de pico.
properties.peakMinutesToWaitOnLogoff	integer		O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário faz logoff durante o período de pico.
properties.peakStartTime	Time		Hora de início para o período de pico.
properties.peakStartVMOnConnect	SetStartVMOnConnect	Enable	A configuração desejada de Start VM On Connect para o hostpool durante a fase de pico.
properties.rampDownActionOnDisconnect	SessionHandlingOperation		Ação a ser tomada após a desconexão de um usuário durante o período de ramp down.
properties.rampDownActionOnLogoff	SessionHandlingOperation		Ação a ser tomada após um logoff durante o período de rampa.
properties.rampDownMinutesToWaitOnDisconnect	integer		O tempo em minutos para esperar antes de executar a ação de manipulação de sessão desejada quando um usuário se desconecta durante o período de rampa down.
properties.rampDownMinutesToWaitOnLogoff	integer		O tempo em minutos para esperar antes de executar a ação de manipulação de sessão desejada quando um usuário faz logoff durante o período de ramp down.
properties.rampDownStartTime	Time		Hora de início para o período de rampa down.
properties.rampDownStartVMOnConnect	SetStartVMOnConnect	Enable	A configuração desejada de Start VM On Connect para o hostpool durante a fase de ramp down.
properties.rampUpActionOnDisconnect	SessionHandlingOperation		Ação a ser tomada após a desconexão de um usuário durante o período de ramp up.
properties.rampUpActionOnLogoff	SessionHandlingOperation		Ação a ser tomada após um logoff durante o período de ramp up.
properties.rampUpAutoStartHosts	StartupBehavior		O comportamento de inicialização desejado durante o período de ramp up para vms pessoais no hostpool.
properties.rampUpMinutesToWaitOnDisconnect	integer		O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário se desconecta durante o período de ramp up.
properties.rampUpMinutesToWaitOnLogoff	integer		O tempo, em minutos, de espera antes de executar a ação de manipulação de sessão desejada quando um usuário faz logoff durante o período de ramp up.
properties.rampUpStartTime	Time		Hora de início para o período de ramp up.
properties.rampUpStartVMOnConnect	SetStartVMOnConnect	Enable	A configuração desejada de Start VM On Connect para o hostpool durante a fase de ramp up. Se isso estiver desabilitado, os hosts de sessão deverão ser ativados usando rampUpAutoStartHosts ou ativando-os manualmente.

SessionHandlingOperation

Ação a ser tomada após a desconexão de um usuário durante o período de ramp up.

Name	Tipo	Description
Deallocate	string
None	string

SetStartVMOnConnect

A configuração desejada de Start VM On Connect para o hostpool durante a fase de ramp up. Se isso estiver desabilitado, os hosts de sessão deverão ser ativados usando rampUpAutoStartHosts ou ativando-os manualmente.

Name	Tipo	Description
Disable	string
Enable	string

StartupBehavior

O comportamento de inicialização desejado durante o período de ramp up para vms pessoais no hostpool.

Name	Tipo	Description
All	string	Todos os anfitriões de sessão pessoais no hostpool serão iniciados durante o ramp up.
None	string	Os anfitriões de sessão não serão iniciados pelo serviço. Essa configuração depende de Iniciar VM em Conectar para ser habilitado para iniciar os hosts de sessão.
WithAssignedUser	string	Os hosts de sessão com um usuário atribuído serão iniciados durante o Ramp Up

systemData

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

Name	Tipo	Description
createdAt	string	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	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

O tempo para uma ação de dimensionamento ocorrer.

Name	Tipo	Description
hour	integer	A hora.
minute	integer	O minuto.