Schedules - List Applicable

Dienst:

Dev Test Labs

API-Version:

2018-09-15

Listet alle anwendbaren Zeitpläne auf.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
labName	path	True	string	Der Name des Labs.
name	path	True	string	Der Name des Zeitplans.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Die Abonnement-ID.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ScheduleList	OK
Other Status Codes	CloudError	BadRequest

Sicherheit

azure_auth

Implizite OAuth2-Gewährung

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Zugriff auf Microsoft Azure

Beispiele

Schedules_ListApplicable

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
CloudError	Fehler aus einer REST-Anforderung.
CloudErrorBody	Text eines Fehlers aus einer REST-Anforderung.
DayDetails	Eigenschaften eines Tageszeitplans.
EnableStatus	Die status des Zeitplans (d. h. aktiviert, deaktiviert)
HourDetails	Eigenschaften eines Stundenplans.
NotificationSettings	Benachrichtigungseinstellungen für einen Zeitplan.
Schedule	Ein Zeitplan.
ScheduleList	Die Antwort eines Listenvorgangs.
WeekDetails	Eigenschaften eines Wochenplans.

CloudError

Fehler aus einer REST-Anforderung.

Name	Typ	Beschreibung
error	CloudErrorBody	Der aufgetretene Cloudfehler

CloudErrorBody

Text eines Fehlers aus einer REST-Anforderung.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	CloudErrorBody[]	Innere Fehler.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

DayDetails

Eigenschaften eines Tageszeitplans.

Name	Typ	Beschreibung
time	string	Die Tageszeit, zu der der Zeitplan ausgeführt wird.

EnableStatus

Die status des Zeitplans (d. h. aktiviert, deaktiviert)

Name	Typ	Beschreibung
Disabled	string
Enabled	string

HourDetails

Eigenschaften eines Stundenplans.

Name	Typ	Beschreibung
minute	integer	Minuten der Stunde, die der Zeitplan ausgeführt wird.

NotificationSettings

Benachrichtigungseinstellungen für einen Zeitplan.

Name	Typ	Standardwert	Beschreibung
emailRecipient	string		Der E-Mail-Empfänger, an den Benachrichtigungen gesendet werden sollen (kann eine Liste von durch Semikolon getrennten E-Mail-Adressen sein).
notificationLocale	string		Das Gebietsschema, das beim Senden einer Benachrichtigung verwendet werden soll (Fallback für nicht unterstützte Sprachen ist EN).
status	EnableStatus	Disabled	Wenn Benachrichtigungen für diesen Zeitplan aktiviert sind (d. h. Aktiviert, Deaktiviert).
timeInMinutes	integer		Zeit in Minuten vor dem Ereignis, zu dem die Benachrichtigung gesendet wird.
webhookUrl	string		Die Webhook-URL, an die die Benachrichtigung gesendet wird.

Schedule

Ein Zeitplan.

Name	Typ	Standardwert	Beschreibung
id	string		Der Bezeichner der Ressource.
location	string		Der Speicherort der Ressource.
name	string		Der Name der Ressource.
properties.createdDate	string		Das Erstellungsdatum des Zeitplans.
properties.dailyRecurrence	DayDetails		Wenn der Zeitplan einmal pro Wochentag auftritt, geben Sie die tägliche Wiederholung an.
properties.hourlyRecurrence	HourDetails		Wenn der Zeitplan mehrmals täglich auftritt, geben Sie die stündliche Wiederholung an.
properties.notificationSettings	NotificationSettings		Benachrichtigungseinstellungen.
properties.provisioningState	string		Der Bereitstellungs-status der Ressource.
properties.status	EnableStatus	Disabled	Die status des Zeitplans (d. h. aktiviert, deaktiviert)
properties.targetResourceId	string		Die Ressourcen-ID, zu der der Zeitplan gehört
properties.taskType	string		Der Aufgabentyp des Zeitplans (z. B. LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		Die Zeitzonen-ID (z. B. China Standardzeit, Grönland Standardzeit, Pazifische Standardzeit usw.). Die möglichen Werte für diese Eigenschaft finden Sie in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier	string		Der eindeutige unveränderliche Bezeichner einer Ressource (Guid).
properties.weeklyRecurrence	WeekDetails		Wenn der Zeitplan nur an einigen Tagen der Woche auftritt, geben Sie die wöchentliche Wiederholung an.
tags	object		Die Tags der Ressource.
type	string		Der Typ der Ressource.

ScheduleList

Die Antwort eines Listenvorgangs.

Name	Typ	Beschreibung
nextLink	string	Link für den nächsten Satz von Ergebnissen.
value	Schedule[]	Ergebnisse des Listenvorgangs.

WeekDetails

Eigenschaften eines Wochenplans.

Name	Typ	Beschreibung
time	string	Die Uhrzeit des Tages, zu dem der Zeitplan auftritt.
weekdays	string[]	Die Wochentage, für die der Zeitplan festgelegt ist (z. B. Sonntag, Montag, Dienstag usw.).