Schedules - List Applicable

Service:

Dev Test Labs

Version d'API:

2018-09-15

Répertorier toutes les planifications applicables.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
labName	path	True	string	Nom du lab.
name	path	True	string	Nom de la planification.
resourceGroupName	path	True	string	Nom du groupe de ressources.
subscriptionId	path	True	string	L'ID de l'abonnement.
api-version	query	True	string	Version d’API client.

Réponses

Nom	Type	Description
200 OK	ScheduleList	Ok
Other Status Codes	CloudError	BadRequest

Sécurité

azure_auth

Octroi implicite OAuth2

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Accéder à Microsoft Azure

Exemples

Schedules_ListApplicable

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
CloudError	Erreur d’une requête REST.
CloudErrorBody	Corps d’une erreur à partir d’une requête REST.
DayDetails	Propriétés d’une planification quotidienne.
EnableStatus	Status de la planification (par exemple, Activé, Désactivé)
HourDetails	Propriétés d’une planification horaire.
NotificationSettings	Paramètres de notification pour une planification.
Schedule	Une planification.
ScheduleList	Réponse d’une opération de liste.
WeekDetails	Propriétés d’une planification hebdomadaire.

CloudError

Erreur d’une requête REST.

Nom	Type	Description
error	CloudErrorBody	Erreur cloud qui s’est produite

CloudErrorBody

Corps d’une erreur à partir d’une requête REST.

Nom	Type	Description
code	string	Code d'erreur.
details	CloudErrorBody[]	Erreurs internes.
message	string	Message d’erreur.
target	string	Cible d’erreur.

DayDetails

Propriétés d’une planification quotidienne.

Nom	Type	Description
time	string	Heure de la journée à laquelle la planification aura lieu.

EnableStatus

Status de la planification (par exemple, Activé, Désactivé)

Nom	Type	Description
Disabled	string
Enabled	string

HourDetails

Propriétés d’une planification horaire.

Nom	Type	Description
minute	integer	Minutes de l’heure d’exécution de la planification.

NotificationSettings

Paramètres de notification pour une planification.

Nom	Type	Valeur par défaut	Description
emailRecipient	string		Destinataire de l’e-mail auquel envoyer des notifications (peut être une liste d’adresses e-mail séparées par des points-deux-points).
notificationLocale	string		Paramètres régionaux à utiliser lors de l’envoi d’une notification (secours pour les langues non prises en charge est EN).
status	EnableStatus	Disabled	Si les notifications sont activées pour cette planification (par exemple, Activé, Désactivé).
timeInMinutes	integer		Heure en minutes avant l’événement à laquelle la notification sera envoyée.
webhookUrl	string		URL du webhook à laquelle la notification sera envoyée.

Schedule

Une planification.

Nom	Type	Valeur par défaut	Description
id	string		Identificateur de la ressource.
location	string		Emplacement de la ressource.
name	string		Nom de la ressource.
properties.createdDate	string		Date de création de la planification.
properties.dailyRecurrence	DayDetails		Si la planification se produit une fois par jour de la semaine, spécifiez la périodicité quotidienne.
properties.hourlyRecurrence	HourDetails		Si la planification se produit plusieurs fois par jour, spécifiez la périodicité horaire.
properties.notificationSettings	NotificationSettings		Paramètres de notification.
properties.provisioningState	string		Status d’approvisionnement de la ressource.
properties.status	EnableStatus	Disabled	Status de la planification (par exemple, Activé, Désactivé)
properties.targetResourceId	string		ID de ressource auquel appartient la planification
properties.taskType	string		Type de tâche de la planification (par exemple, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		L’ID de fuseau horaire (par exemple, l’heure standard de la Chine, l’heure standard du Groenland, l’heure du Pacifique, etc.). Les valeurs possibles pour cette propriété se trouvent dans IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier	string		Identificateur immuable unique d’une ressource (GUID).
properties.weeklyRecurrence	WeekDetails		Si la planification ne se produit que quelques jours de la semaine, spécifiez la périodicité hebdomadaire.
tags	object		Balises de la ressource.
type	string		Type de la ressource.

ScheduleList

Réponse d’une opération de liste.

Nom	Type	Description
nextLink	string	Lien pour l’ensemble de résultats suivant.
value	Schedule[]	Résultats de l’opération de liste.

WeekDetails

Propriétés d’une planification hebdomadaire.

Nom	Type	Description
time	string	Heure du jour où la planification aura lieu.
weekdays	string[]	Jours de la semaine pour lesquels la planification est définie (par exemple, dimanche, lundi, mardi, etc.).