Virtual Machines - List Applicable Schedules

リファレンス

Service:: Dev Test Labs

API Version:: 2018-09-15

存在する場合は、該当する開始/停止のスケジュールを一覧表示します。

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

URI パラメーター

名前	/	必須	型	説明
labName	path	True	string	ラボの名前。
name	path	True	string	仮想マシンの名前。
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	サブスクリプション ID です。
api-version	query	True	string	クライアント API バージョン。

応答

名前	型	説明
200 OK	ApplicableSchedule	OK
Other Status Codes	CloudError	BadRequest

セキュリティ

azure_auth

OAuth2 暗黙的な許可

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	Microsoft Azure にアクセスする

例

VirtualMachines_ListApplicableSchedules

Sample Request

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

Sample Response

Status code:: 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}"
    }
  }
}

定義

名前	説明
ApplicableSchedule	仮想マシンに適用できるスケジュール。スケジュールは、VM またはラボレベルで定義されている可能性があります。
CloudError	REST 要求からのエラー。
CloudErrorBody	REST 要求からのエラーの本文。
DayDetails	毎日のスケジュールのプロパティ。
EnableStatus	スケジュールの状態 (有効、無効)
HourDetails	1 時間ごとのスケジュールのプロパティ。
NotificationSettings	スケジュールの通知設定。
Schedule	スケジュール。
WeekDetails	毎週のスケジュールのプロパティ。

ApplicableSchedule

仮想マシンに適用できるスケジュール。スケジュールは、VM またはラボレベルで定義されている可能性があります。

名前	型	説明
id	string	リソースの識別子。
location	string	リソースの場所。
name	string	リソースの名前。
properties.labVmsShutdown	Schedule	自動シャットダウンスケジュール (ラボまたはラボリソースレベルで設定されている場合)。
properties.labVmsStartup	Schedule	自動起動スケジュール (ラボまたはラボリソースレベルで設定されている場合)。
tags	object	リソースのタグ。
type	string	リソースの型。

CloudError

REST 要求からのエラー。

名前	型	説明
error	CloudErrorBody	発生したクラウドエラー

CloudErrorBody

REST 要求からのエラーの本文。

名前	型	説明
code	string	エラーコード。
details	CloudErrorBody[]	内部エラー。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

DayDetails

毎日のスケジュールのプロパティ。

名前	型	説明
time	string	スケジュールが発生する時刻。

EnableStatus

スケジュールの状態 (有効、無効)

名前	型	説明
Disabled	string
Enabled	string

HourDetails

1 時間ごとのスケジュールのプロパティ。

名前	型	説明
minute	integer	スケジュールが実行される時間の分数。

NotificationSettings

スケジュールの通知設定。

名前	型	既定値	説明
emailRecipient	string		通知を送信するメール受信者 (セミコロンで区切られたメールアドレスの一覧を指定できます)。
notificationLocale	string		通知を送信するときに使用するロケール (サポートされていない言語のフォールバックは EN)。
status	EnableStatus	Disabled	このスケジュールに対して通知が有効になっている場合 (つまり、有効、無効)。
timeInMinutes	integer		通知が送信されるイベントの前の時間 (分)。
webhookUrl	string		通知の送信先となる Webhook URL。

Schedule

スケジュール。

名前	型	既定値	説明
id	string		リソースの識別子。
location	string		リソースの場所。
name	string		リソースの名前。
properties.createdDate	string		スケジュールの作成日。
properties.dailyRecurrence	DayDetails		スケジュールが週の各日に 1 回行われる場合は、毎日の繰り返しを指定します。
properties.hourlyRecurrence	HourDetails		スケジュールが 1 日に複数回発生する場合は、時間単位の繰り返しを指定します。
properties.notificationSettings	NotificationSettings		通知設定。
properties.provisioningState	string		リソースのプロビジョニング状態。
properties.status	EnableStatus	Disabled	スケジュールの状態 (有効、無効)
properties.targetResourceId	string		スケジュールが属するリソース ID
properties.taskType	string		スケジュールのタスクの種類 (LabVmsShutdownTask、LabVmAutoStart など)。
properties.timeZoneId	string		タイムゾーン ID (中国標準時、グリーンランド標準時、太平洋標準時など)。このプロパティに使用できる値は、 (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) にあります`IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds`
properties.uniqueIdentifier	string		リソースの一意の不変識別子 (Guid)。
properties.weeklyRecurrence	WeekDetails		スケジュールが週の数日だけ発生する場合は、週単位の繰り返しを指定します。
tags	object		リソースのタグ。
type	string		リソースの型。

WeekDetails

毎週のスケジュールのプロパティ。

名前	型	説明
time	string	スケジュールが発生する時刻。
weekdays	string[]	スケジュールが設定されている曜日 (日曜日、月曜日、火曜日など)。