Schedules - List

Riferimento

Service:: Dev Test Labs

API Version:: 2018-09-15

Elencare le pianificazioni in un determinato lab.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
labName	path	True	string	Il nome del lab.
resourceGroupName	path	True	string	Nome del gruppo di risorse.
subscriptionId	path	True	string	ID della sottoscrizione.
api-version	query	True	string	Versione API client.
$expand	query		string	Specificare la query $expand. Esempio: 'properties($select=status)'
$filter	query		string	Filtro da applicare all'operazione. Esempio: '$filter=contains(name,'myName')
$orderby	query		string	Espressione di ordinamento per i risultati, utilizzando la notazione OData. Esempio: '$orderby=name desc'
$top	query		integer int32	Numero massimo di risorse da restituire dall'operazione. Esempio: '$top=10'

Risposte

Nome	Tipo	Descrizione
200 OK	ScheduleList	OK
Other Status Codes	CloudError	BadRequest

Sicurezza

azure_auth

Concessione implicita OAuth2

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

Scopes

Nome	Descrizione
user_impersonation	Accedere a Microsoft Azure

Esempio

Schedules_List

Sample Request

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

/** 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

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

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

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

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

Definizioni

Nome	Descrizione
CloudError	Errore da una richiesta REST.
CloudErrorBody	Corpo di un errore da una richiesta REST.
DayDetails	Proprietà di una pianificazione giornaliera.
EnableStatus	Stato della pianificazione (ad esempio Abilitato, Disabilitato)
HourDetails	Proprietà di una pianificazione oraria.
NotificationSettings	Impostazioni di notifica per una pianificazione.
Schedule	Una pianificazione.
ScheduleList	Risposta di un'operazione di elenco.
WeekDetails	Proprietà di una pianificazione settimanale.

CloudError

Errore da una richiesta REST.

Nome	Tipo	Descrizione
error	CloudErrorBody	Errore cloud che si è verificato

CloudErrorBody

Corpo di un errore da una richiesta REST.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	CloudErrorBody[]	Errori interni.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

DayDetails

Proprietà di una pianificazione giornaliera.

Nome	Tipo	Descrizione
time	string	Ora del giorno in cui verrà eseguita la pianificazione.

EnableStatus

Stato della pianificazione (ad esempio Abilitato, Disabilitato)

Nome	Tipo	Descrizione
Disabled	string
Enabled	string

HourDetails

Proprietà di una pianificazione oraria.

Nome	Tipo	Descrizione
minute	integer	Minuti dell'ora in cui verrà eseguita la pianificazione.

NotificationSettings

Impostazioni di notifica per una pianificazione.

Nome	Tipo	Valore predefinito	Descrizione
emailRecipient	string		Il destinatario del messaggio di posta elettronica a cui inviare notifiche (può essere un elenco di indirizzi di posta elettronica separati da punto e virgola).
notificationLocale	string		Impostazioni locali da usare per l'invio di una notifica (fallback per le lingue non supportate è EN).
status	EnableStatus	Disabled	Se le notifiche sono abilitate per questa pianificazione ,ad esempio Abilitato, Disabilitato.
timeInMinutes	integer		Tempo in minuti prima dell'evento in cui verrà inviata la notifica.
webhookUrl	string		URL del webhook a cui verrà inviata la notifica.

Schedule

Una pianificazione.

Nome	Tipo	Valore predefinito	Descrizione
id	string		Identificatore della risorsa.
location	string		Il percorso della risorsa.
name	string		Nome della risorsa.
properties.createdDate	string		Data di creazione della pianificazione.
properties.dailyRecurrence	DayDetails		Se la pianificazione verrà eseguita una volta ogni giorno della settimana, specificare la ricorrenza giornaliera.
properties.hourlyRecurrence	HourDetails		Se la pianificazione verrà eseguita più volte al giorno, specificare la ricorrenza oraria.
properties.notificationSettings	NotificationSettings		Impostazioni di notifica.
properties.provisioningState	string		Stato del provisioning della risorsa.
properties.status	EnableStatus	Disabled	Stato della pianificazione (ad esempio Abilitato, Disabilitato)
properties.targetResourceId	string		ID risorsa a cui appartiene la pianificazione
properties.taskType	string		Tipo di attività della pianificazione, ad esempio LabVmsShutdownTask, LabVmAutoStart.
properties.timeZoneId	string		ID del fuso orario (ad esempio, ora solare cina, ora solare della Groenlandia, ora solare pacifico e così via). I valori possibili per questa proprietà sono disponibili in `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier	string		Identificatore univoco non modificabile di una risorsa (GUID).
properties.weeklyRecurrence	WeekDetails		Se la pianificazione verrà eseguita solo alcuni giorni della settimana, specificare la ricorrenza settimanale.
tags	object		Tag della risorsa.
type	string		Tipo di risorsa.

ScheduleList

Risposta di un'operazione di elenco.

Nome	Tipo	Descrizione
nextLink	string	Collegamento per il set di risultati successivo.
value	Schedule[]	Risultati dell'operazione di elenco.

WeekDetails

Proprietà di una pianificazione settimanale.

Nome	Tipo	Descrizione
time	string	Ora del giorno in cui verrà eseguita la pianificazione.
weekdays	string[]	Giorni della settimana per cui è impostata la pianificazione (ad esempio domenica, lunedì, martedì e così via).