Schedules - List

Service:

Dev Test Labs

API Version:

2018-09-15

特定のラボのスケジュールを一覧表示します。

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15

URI パラメーター

名前	/	必須	型	説明
labName	path	True	string	ラボの名前。
resourceGroupName	path	True	string	リソース グループの名前。
subscriptionId	path	True	string	サブスクリプション ID です。
api-version	query	True	string	クライアント API バージョン。
$expand	query		string	$expand クエリを指定します。 例: 'properties($select=status)'
$filter	query		string	操作に適用するフィルター。 例: '$filter=contains(name,'myName')
$orderby	query		string	OData 表記を使用した結果の順序付け式。 例: '$orderby=name desc'
$top	query		integer int32	操作から返されるリソースの最大数。 例: '$top=10'

応答

名前	型	説明
200 OK	ScheduleList	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 にアクセスする

例

Schedules_List

Sample Request

HTTP

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

Java

/** Samples for Schedules List. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Schedules_List.json
     */
    /**
     * Sample code: Schedules_List.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void schedulesList(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .schedules()
            .list("resourceGroupName", "{labName}", null, null, null, null, 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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python schedules_list.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.schedules.list(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Schedules_List.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 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/Schedules_List.json
func ExampleSchedulesClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewSchedulesClient().NewListPager("resourceGroupName", "{labName}", &armdevtestlabs.SchedulesClientListOptions{Expand: nil,
		Filter:  nil,
		Top:     nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ScheduleList = armdevtestlabs.ScheduleList{
		// 	Value: []*armdevtestlabs.Schedule{
		// 		{
		// 			Name: to.Ptr("{scheduleName}"),
		// 			Type: to.Ptr("Microsoft.DevTestLab/labs/schedules"),
		// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/schedules/{scheduleName}"),
		// 			Location: to.Ptr("{location}"),
		// 			Tags: map[string]*string{
		// 				"tagName1": to.Ptr("tagValue1"),
		// 			},
		// 			Properties: &armdevtestlabs.ScheduleProperties{
		// 				CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-02T01:40:48.173Z"); return t}()),
		// 				DailyRecurrence: &armdevtestlabs.DayDetails{
		// 					Time: to.Ptr("{timeOfTheDayTheScheduleWillOccurEveryDay}"),
		// 				},
		// 				HourlyRecurrence: &armdevtestlabs.HourDetails{
		// 					Minute: to.Ptr[int32](30),
		// 				},
		// 				NotificationSettings: &armdevtestlabs.NotificationSettings{
		// 					EmailRecipient: to.Ptr("{email}"),
		// 					NotificationLocale: to.Ptr("EN"),
		// 					Status: to.Ptr(armdevtestlabs.EnableStatus("{Enabled|Disabled}")),
		// 					TimeInMinutes: to.Ptr[int32](15),
		// 					WebhookURL: to.Ptr("{webhookUrl}"),
		// 				},
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				Status: to.Ptr(armdevtestlabs.EnableStatus("{Enabled|Disabled}")),
		// 				TargetResourceID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}"),
		// 				TaskType: to.Ptr("{myLabVmTaskType}"),
		// 				TimeZoneID: to.Ptr("Pacific Standard Time"),
		// 				UniqueIdentifier: to.Ptr("{uniqueIdentifier}"),
		// 				WeeklyRecurrence: &armdevtestlabs.WeekDetails{
		// 					Time: to.Ptr("{timeOfTheDayTheScheduleWillOccurOnThoseDays}"),
		// 					Weekdays: []*string{
		// 						to.Ptr("Monday"),
		// 						to.Ptr("Wednesday"),
		// 						to.Ptr("Friday")},
		// 					},
		// 				},
		// 		}},
		// 	}
	}
}

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 { DevTestLabsClient } = require("@azure/arm-devtestlabs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List schedules in a given lab.
 *
 * @summary List schedules in a given lab.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Schedules_List.json
 */
async function schedulesList() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.schedules.list(resourceGroupName, labName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

schedulesList().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

dotnet

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/Schedules_List.json
// this example is just showing the usage of "Schedules_List" 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 DevTestLabResource created on azure
// for more information of creating DevTestLabResource, please refer to the document of DevTestLabResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
ResourceIdentifier devTestLabResourceId = DevTestLabResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName);
DevTestLabResource devTestLab = client.GetDevTestLabResource(devTestLabResourceId);

// get the collection of this DevTestLabScheduleResource
DevTestLabScheduleCollection collection = devTestLab.GetDevTestLabSchedules();

// invoke the operation and iterate over the result
await foreach (DevTestLabScheduleResource item in collection.GetAllAsync())
{
    // the variable item 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
    DevTestLabScheduleData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "properties": {
        "status": "{Enabled|Disabled}",
        "taskType": "{myLabVmTaskType}",
        "weeklyRecurrence": {
          "weekdays": [
            "Monday",
            "Wednesday",
            "Friday"
          ],
          "time": "{timeOfTheDayTheScheduleWillOccurOnThoseDays}"
        },
        "dailyRecurrence": {
          "time": "{timeOfTheDayTheScheduleWillOccurEveryDay}"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "timeZoneId": "Pacific Standard Time",
        "notificationSettings": {
          "status": "{Enabled|Disabled}",
          "timeInMinutes": 15,
          "webhookUrl": "{webhookUrl}",
          "emailRecipient": "{email}",
          "notificationLocale": "EN"
        },
        "createdDate": "2018-10-01T18:40:48.1739018-07:00",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
        "provisioningState": "Creating",
        "uniqueIdentifier": "{uniqueIdentifier}"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/schedules/{scheduleName}",
      "name": "{scheduleName}",
      "type": "Microsoft.DevTestLab/labs/schedules",
      "location": "{location}",
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

定義

名前	説明
CloudError	REST 要求からのエラー。
CloudErrorBody	REST 要求からのエラーの本文。
DayDetails	毎日のスケジュールのプロパティ。
EnableStatus	スケジュールの状態 (有効、無効)
HourDetails	1 時間ごとのスケジュールのプロパティ。
NotificationSettings	スケジュールの通知設定。
Schedule	スケジュール。
ScheduleList	リスト操作の応答。
WeekDetails	週単位のスケジュールのプロパティ。

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		リソースの型。

ScheduleList

リスト操作の応答。

名前	型	説明
nextLink	string	次の結果セットのリンク。
value	Schedule[]	リスト操作の結果。

WeekDetails

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

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