Schedules - List Applicable

서비스:

Dev Test Labs

API 버전:

2018-09-15

적용 가능한 모든 일정을 나열합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
labName	path	True	string	랩의 이름입니다.
name	path	True	string	일정의 이름입니다.
resourceGroupName	path	True	string	리소스 그룹의 이름.
subscriptionId	path	True	string	구독 ID입니다.
api-version	query	True	string	클라이언트 API 버전입니다.

응답

Name	형식	Description
200 OK	ScheduleList	정상
Other Status Codes	CloudError	BadRequest

보안

azure_auth

OAuth2 암시적 허용

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	Microsoft Azure에 액세스

예제

Schedules_ListApplicable

샘플 요청

HTTP

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

Java

/** Samples for Schedules ListApplicable. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Schedules_ListApplicable.json
     */
    /**
     * Sample code: Schedules_ListApplicable.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void schedulesListApplicable(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .schedules()
            .listApplicable("resourceGroupName", "{labName}", "{scheduleName}", 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_applicable.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_applicable(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        name="{scheduleName}",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Schedules_ListApplicable.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_ListApplicable.json
func ExampleSchedulesClient_NewListApplicablePager() {
	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().NewListApplicablePager("resourceGroupName", "{labName}", "{scheduleName}", 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 Lists all applicable schedules
 *
 * @summary Lists all applicable schedules
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Schedules_ListApplicable.json
 */
async function schedulesListApplicable() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const name = "{scheduleName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.schedules.listApplicable(resourceGroupName, labName, name)) {
    resArray.push(item);
  }
  console.log(resArray);
}

schedulesListApplicable().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_ListApplicable.json
// this example is just showing the usage of "Schedules_ListApplicable" 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
string name = "{scheduleName}";
await foreach (DevTestLabScheduleResource item in collection.GetApplicableAsync(name))
{
    // 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

샘플 응답

상태 코드:

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

정의

Name	Description
CloudError	REST 요청의 오류입니다.
CloudErrorBody	REST 요청의 오류 본문입니다.
DayDetails	일일 일정의 속성입니다.
EnableStatus	일정의 상태(예: 사용, 사용 안 함)
HourDetails	시간별 일정의 속성입니다.
NotificationSettings	일정에 대한 알림 설정입니다.
Schedule	일정입니다.
ScheduleList	목록 작업의 응답입니다.
WeekDetails	주별 일정의 속성입니다.

CloudError

REST 요청의 오류입니다.

Name	형식	Description
error	CloudErrorBody	발생한 클라우드 오류

CloudErrorBody

REST 요청의 오류 본문입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	CloudErrorBody[]	내부 오류.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

DayDetails

일일 일정의 속성입니다.

Name	형식	Description
time	string	일정이 발생하는 시간입니다.

EnableStatus

일정의 상태(예: 사용, 사용 안 함)

Name	형식	Description
Disabled	string
Enabled	string

HourDetails

시간별 일정의 속성입니다.

Name	형식	Description
minute	integer	일정이 실행되는 시간(분)입니다.

NotificationSettings

일정에 대한 알림 설정입니다.

Name	형식	Default value	Description
emailRecipient	string		알림을 보낼 전자 메일 받는 사람(세미콜론으로 구분된 전자 메일 주소 목록일 수 있음).
notificationLocale	string		알림을 보낼 때 사용할 로캘입니다(지원되지 않는 언어에 대한 대체는 EN임).
status	EnableStatus	Disabled	이 일정에 대한 알림이 활성화된 경우(예: 사용, 사용 안 함)
timeInMinutes	integer		알림이 전송되는 이벤트 전 시간(분)입니다.
webhookUrl	string		알림을 보낼 웹후크 URL입니다.

Schedule

일정입니다.

Name	형식	Default value	Description
id	string		리소스의 식별자입니다.
location	string		리소스의 위치입니다.
name	string		리소스의 이름입니다.
properties.createdDate	string		일정의 생성 날짜입니다.
properties.dailyRecurrence	DayDetails		일정이 요일마다 한 번씩 발생하는 경우 일별 되풀이를 지정합니다.
properties.hourlyRecurrence	HourDetails		일정이 하루에 여러 번 발생하는 경우 시간별 되풀이를 지정합니다.
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

목록 작업의 응답입니다.

Name	형식	Description
nextLink	string	다음 결과 집합에 대한 링크입니다.
value	Schedule[]	목록 작업의 결과입니다.

WeekDetails

주별 일정의 속성입니다.

Name	형식	Description
time	string	일정이 발생하는 날짜 시간입니다.
weekdays	string[]	일정이 설정된 요일(예: 일요일, 월요일, 화요일 등)입니다.