Virtual Machines - List Applicable Schedules

Başvuru

Hizmet:: Dev Test Labs

API Sürümü:: 2018-09-15

Varsa ilgili başlatma/durdurma zamanlamalarını Listeler.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/listApplicableSchedules?api-version=2018-09-15

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
labName	path	True	string	Laboratuvarın adı.
name	path	True	string	Sanal makinenin adı.
resourceGroupName	path	True	string	Kaynak grubunun adı.
subscriptionId	path	True	string	Abonelik kimliği.
api-version	query	True	string	İstemci API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	ApplicableSchedule	Tamam
Other Status Codes	CloudError	BadRequest

Güvenlik

azure_auth

OAuth2 Örtük Verme

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	Microsoft Azure'a erişme

Örnekler

VirtualMachines_ListApplicableSchedules

Örnek isteği

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}/listApplicableSchedules?api-version=2018-09-15

/** Samples for VirtualMachines ListApplicableSchedules. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_ListApplicableSchedules.json
     */
    /**
     * Sample code: VirtualMachines_ListApplicableSchedules.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void virtualMachinesListApplicableSchedules(
        com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .virtualMachines()
            .listApplicableSchedulesWithResponse(
                "resourceGroupName", "{labName}", "{vmName}", com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python virtual_machines_list_applicable_schedules.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 = DevTestLabsClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscriptionId}",
    )

    response = client.virtual_machines.list_applicable_schedules(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        name="{vmName}",
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_ListApplicableSchedules.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

package armdevtestlabs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_ListApplicableSchedules.json
func ExampleVirtualMachinesClient_ListApplicableSchedules() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevtestlabs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVirtualMachinesClient().ListApplicableSchedules(ctx, "resourceGroupName", "{labName}", "{vmName}", 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.ApplicableSchedule = armdevtestlabs.ApplicableSchedule{
	// 	Properties: &armdevtestlabs.ApplicableScheduleProperties{
	// 		LabVMsShutdown: &armdevtestlabs.Schedule{
	// 			Name: to.Ptr("LabVmsShutdown"),
	// 			Type: to.Ptr("Microsoft.DevTestLab/labs/virtualMachines/schedules"),
	// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/myAutoShutdownSchedule"),
	// 			Location: to.Ptr("{location}"),
	// 			Properties: &armdevtestlabs.ScheduleProperties{
	// 				CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-29T21:48:14.136Z"); return t}()),
	// 				DailyRecurrence: &armdevtestlabs.DayDetails{
	// 					Time: to.Ptr("1900"),
	// 				},
	// 				HourlyRecurrence: &armdevtestlabs.HourDetails{
	// 					Minute: to.Ptr[int32](30),
	// 				},
	// 				NotificationSettings: &armdevtestlabs.NotificationSettings{
	// 					EmailRecipient: to.Ptr("{email}"),
	// 					NotificationLocale: to.Ptr("EN"),
	// 					Status: to.Ptr(armdevtestlabs.EnableStatusEnabled),
	// 					TimeInMinutes: to.Ptr[int32](30),
	// 					WebhookURL: to.Ptr("{webhookUrl}"),
	// 				},
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				Status: to.Ptr(armdevtestlabs.EnableStatusEnabled),
	// 				TargetResourceID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}"),
	// 				TaskType: to.Ptr("LabVmsShutdownTask"),
	// 				TimeZoneID: to.Ptr("Pacific Standard Time"),
	// 				UniqueIdentifier: to.Ptr("4acf0408-1c10-49cb-96b7-28ce655c8320"),
	// 				WeeklyRecurrence: &armdevtestlabs.WeekDetails{
	// 					Time: to.Ptr("1700"),
	// 					Weekdays: []*string{
	// 						to.Ptr("Friday"),
	// 						to.Ptr("Saturday"),
	// 						to.Ptr("Sunday")},
	// 					},
	// 				},
	// 			},
	// 			LabVMsStartup: &armdevtestlabs.Schedule{
	// 				Name: to.Ptr("LabVmAutoStart"),
	// 				Type: to.Ptr("Microsoft.DevTestLab/labs/virtualMachines/schedules"),
	// 				ID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/myAutoStartSchedule"),
	// 				Location: to.Ptr("{location}"),
	// 				Properties: &armdevtestlabs.ScheduleProperties{
	// 					CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-29T21:46:37.047Z"); return t}()),
	// 					DailyRecurrence: &armdevtestlabs.DayDetails{
	// 						Time: to.Ptr("0900"),
	// 					},
	// 					HourlyRecurrence: &armdevtestlabs.HourDetails{
	// 						Minute: to.Ptr[int32](30),
	// 					},
	// 					NotificationSettings: &armdevtestlabs.NotificationSettings{
	// 						EmailRecipient: to.Ptr("{email}"),
	// 						NotificationLocale: to.Ptr("EN"),
	// 						Status: to.Ptr(armdevtestlabs.EnableStatusEnabled),
	// 						TimeInMinutes: to.Ptr[int32](30),
	// 						WebhookURL: to.Ptr("{webhookUrl}"),
	// 					},
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 					Status: to.Ptr(armdevtestlabs.EnableStatusEnabled),
	// 					TargetResourceID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}"),
	// 					TaskType: to.Ptr("LabVmsStartupTask"),
	// 					TimeZoneID: to.Ptr("Pacific Standard Time"),
	// 					WeeklyRecurrence: &armdevtestlabs.WeekDetails{
	// 						Time: to.Ptr("1000"),
	// 						Weekdays: []*string{
	// 							to.Ptr("Friday"),
	// 							to.Ptr("Saturday"),
	// 							to.Ptr("Sunday")},
	// 						},
	// 					},
	// 				},
	// 			},
	// 		}
}

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

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

/**
 * This sample demonstrates how to Lists the applicable start/stop schedules, if any.
 *
 * @summary Lists the applicable start/stop schedules, if any.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_ListApplicableSchedules.json
 */
async function virtualMachinesListApplicableSchedules() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const name = "{vmName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.virtualMachines.listApplicableSchedules(
    resourceGroupName,
    labName,
    name
  );
  console.log(result);
}

virtualMachinesListApplicableSchedules().catch(console.error);

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

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

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_ListApplicableSchedules.json
// this example is just showing the usage of "VirtualMachines_ListApplicableSchedules" 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://video2.skills-academy.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 DevTestLabVmResource created on azure
// for more information of creating DevTestLabVmResource, please refer to the document of DevTestLabVmResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
string name = "{vmName}";
ResourceIdentifier devTestLabVmResourceId = DevTestLabVmResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName, name);
DevTestLabVmResource devTestLabVm = client.GetDevTestLabVmResource(devTestLabVmResourceId);

// invoke the operation
DevTestLabApplicableSchedule result = await devTestLabVm.GetApplicableSchedulesAsync();

Console.WriteLine($"Succeeded: {result}");

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

Örnek yanıt

Durum kodu:: 200

{
  "properties": {
    "labVmsShutdown": {
      "properties": {
        "status": "Enabled",
        "taskType": "LabVmsShutdownTask",
        "weeklyRecurrence": {
          "weekdays": [
            "Friday",
            "Saturday",
            "Sunday"
          ],
          "time": "1700"
        },
        "dailyRecurrence": {
          "time": "1900"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "timeZoneId": "Pacific Standard Time",
        "notificationSettings": {
          "status": "Enabled",
          "timeInMinutes": 30,
          "webhookUrl": "{webhookUrl}",
          "emailRecipient": "{email}",
          "notificationLocale": "EN"
        },
        "createdDate": "2020-12-29T21:48:14.1369355+00:00",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}",
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "4acf0408-1c10-49cb-96b7-28ce655c8320"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/myAutoShutdownSchedule",
      "name": "LabVmsShutdown",
      "type": "Microsoft.DevTestLab/labs/virtualMachines/schedules",
      "location": "{location}"
    },
    "labVmsStartup": {
      "properties": {
        "status": "Enabled",
        "taskType": "LabVmsStartupTask",
        "weeklyRecurrence": {
          "weekdays": [
            "Friday",
            "Saturday",
            "Sunday"
          ],
          "time": "1000"
        },
        "dailyRecurrence": {
          "time": "0900"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "timeZoneId": "Pacific Standard Time",
        "notificationSettings": {
          "status": "Enabled",
          "timeInMinutes": 30,
          "webhookUrl": "{webhookUrl}",
          "emailRecipient": "{email}",
          "notificationLocale": "EN"
        },
        "createdDate": "2020-12-29T21:46:37.0473976+00:00",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}",
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/myAutoStartSchedule",
      "name": "LabVmAutoStart",
      "type": "Microsoft.DevTestLab/labs/virtualMachines/schedules",
      "location": "{location}"
    }
  }
}

Tanımlar

Name	Description
ApplicableSchedule	Bir sanal makine için geçerli zamanlamalar. Zamanlamalar bir VM'de veya laboratuvar düzeyinde tanımlanmış olabilir.
CloudError	REST isteğinden hata.
CloudErrorBody	REST isteğindeki bir hatanın gövdesi.
DayDetails	Günlük zamanlamanın özellikleri.
EnableStatus	Zamanlamanın durumu (etkin, devre dışı)
HourDetails	Saatlik zamanlamanın özellikleri.
NotificationSettings	Zamanlama için bildirim ayarları.
Schedule	Bir zamanlama.
WeekDetails	Haftalık zamanlamanın özellikleri.

ApplicableSchedule

Bir sanal makine için geçerli zamanlamalar. Zamanlamalar bir VM'de veya laboratuvar düzeyinde tanımlanmış olabilir.

Name	Tür	Description
id	string	Kaynağın tanımlayıcısı.
location	string	Kaynağın konumu.
name	string	Kaynağın adı.
properties.labVmsShutdown	Schedule	Laboratuvar veya laboratuvar kaynak düzeyinde ayarlanmışsa otomatik kapatma zamanlaması.
properties.labVmsStartup	Schedule	Laboratuvar veya laboratuvar kaynak düzeyinde ayarlanmışsa otomatik başlatma zamanlaması.
tags	object	Kaynağın etiketleri.
type	string	Kaynağın türü.

CloudError

REST isteğinden hata.

Name	Tür	Description
error	CloudErrorBody	Oluşan bulut hatası

CloudErrorBody

REST isteğindeki bir hatanın gövdesi.

Name	Tür	Description
code	string	Hata kodu.
details	CloudErrorBody[]	İç hatalar.
message	string	Hata iletisi.
target	string	Hata hedefi.

DayDetails

Günlük zamanlamanın özellikleri.

Name	Tür	Description
time	string	Zamanlamanın gerçekleşeceği günün saati.

EnableStatus

Zamanlamanın durumu (etkin, devre dışı)

Name	Tür	Description
Disabled	string
Enabled	string

HourDetails

Saatlik zamanlamanın özellikleri.

Name	Tür	Description
minute	integer	Zamanlamanın çalıştırılacağı saatin dakikaları.

NotificationSettings

Zamanlama için bildirim ayarları.

Name	Tür	Default value	Description
emailRecipient	string		Bildirimlerin gönderileceği e-posta alıcısı (noktalı virgülle ayrılmış e-posta adreslerinin listesi olabilir).
notificationLocale	string		Bildirim gönderirken kullanılacak yerel ayar (desteklenmeyen dillerin geri dönüşü EN'dir).
status	EnableStatus	Disabled	Bu zamanlama için bildirimler etkinleştirildiyse (etkin, devre dışı).
timeInMinutes	integer		Bildirimin gönderileceği olaydan dakika cinsinden dakika cinsinden süre.
webhookUrl	string		Bildirimin gönderileceği web kancası URL'si.

Schedule

Bir zamanlama.

Name	Tür	Default value	Description
id	string		Kaynağın tanımlayıcısı.
location	string		Kaynağın konumu.
name	string		Kaynağın adı.
properties.createdDate	string		Zamanlamanın oluşturulma tarihi.
properties.dailyRecurrence	DayDetails		Zamanlama haftanın her günü bir kez gerçekleşecekse, günlük yinelenmeyi belirtin.
properties.hourlyRecurrence	HourDetails		Zamanlama günde birden çok kez gerçekleşecekse saatlik yinelenmeyi belirtin.
properties.notificationSettings	NotificationSettings		Bildirim ayarları.
properties.provisioningState	string		Kaynağın sağlama durumu.
properties.status	EnableStatus	Disabled	Zamanlamanın durumu (etkin, devre dışı)
properties.targetResourceId	string		Zamanlamanın ait olduğu kaynak kimliği
properties.taskType	string		Zamanlamanın görev türü (örneğin LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		Saat dilimi kimliği (ör. Çin Standart Saati, Grönland Standart Saati, Pasifik Standart saati vb.). Bu özelliğin olası değerleri (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) içinde bulunabilir `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds`
properties.uniqueIdentifier	string		Kaynağın benzersiz sabit tanımlayıcısı (Guid).
properties.weeklyRecurrence	WeekDetails		Zamanlama haftanın yalnızca birkaç günü gerçekleşecekse haftalık yinelenmeyi belirtin.
tags	object		Kaynağın etiketleri.
type	string		Kaynağın türü.

WeekDetails

Haftalık zamanlamanın özellikleri.

Name	Tür	Description
time	string	Zamanlamanın gerçekleşeceği günün saati.
weekdays	string[]	Zamanlamanın ayarlandığı haftanın günleri (örneğin, Pazar, Pazartesi, Salı vb.).