Schedules - List Applicable

Service:

Dev Test Labs

API-versie:

2018-09-15

Lijsten alle toepasselijke schema's

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

URI-parameters

Name	In	Vereist	Type	Description
labName	path	True	string	De naam van het lab.
name	path	True	string	De naam van de planning.
resourceGroupName	path	True	string	De naam van de resourcegroep.
subscriptionId	path	True	string	De abonnements-id.
api-version	query	True	string	Client-API-versie.

Antwoorden

Name	Type	Description
200 OK	ScheduleList	OK
Other Status Codes	CloudError	BadRequest

Beveiliging

azure_auth

Impliciete OAuth2-toekenning

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Toegang tot Microsoft Azure

Voorbeelden

Schedules_ListApplicable

Voorbeeldaanvraag

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DevTestLabs.Models;
using Azure.ResourceManager.DevTestLabs;

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

Voorbeeldrespons

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

Definities

Name	Description
CloudError	Fout van een REST-aanvraag.
CloudErrorBody	Hoofdtekst van een fout van een REST-aanvraag.
DayDetails	Eigenschappen van een dagelijks schema.
EnableStatus	De status van de planning (ingeschakeld, uitgeschakeld)
HourDetails	Eigenschappen van een uurschema.
NotificationSettings	Meldingsinstellingen voor een planning.
Schedule	Een planning.
ScheduleList	Het antwoord van een lijstbewerking.
WeekDetails	Eigenschappen van een wekelijks schema.

CloudError

Fout van een REST-aanvraag.

Name	Type	Description
error	CloudErrorBody	De cloudfout die is opgetreden

CloudErrorBody

Hoofdtekst van een fout van een REST-aanvraag.

Name	Type	Description
code	string	De foutcode.
details	CloudErrorBody[]	Interne fouten.
message	string	Het foutbericht.
target	string	Het foutdoel.

DayDetails

Eigenschappen van een dagelijks schema.

Name	Type	Description
time	string	Het tijdstip van de dag waarop de planning wordt uitgevoerd.

EnableStatus

De status van de planning (ingeschakeld, uitgeschakeld)

Name	Type	Description
Disabled	string
Enabled	string

HourDetails

Eigenschappen van een uurschema.

Name	Type	Description
minute	integer	Minuten van het uur dat het schema wordt uitgevoerd.

NotificationSettings

Meldingsinstellingen voor een planning.

Name	Type	Default value	Description
emailRecipient	string		De e-mailontvanger waarnaar u meldingen wilt verzenden (dit kan een lijst met door puntkomma's gescheiden e-mailadressen zijn).
notificationLocale	string		De landinstelling die moet worden gebruikt bij het verzenden van een melding (terugval voor niet-ondersteunde talen is EN).
status	EnableStatus	Disabled	Als meldingen zijn ingeschakeld voor dit schema (bijvoorbeeld Ingeschakeld, Uitgeschakeld).
timeInMinutes	integer		Tijd in minuten vóór de gebeurtenis waarop de melding wordt verzonden.
webhookUrl	string		De url van de webhook waarnaar de melding wordt verzonden.

Schedule

Een planning.

Name	Type	Default value	Description
id	string		De id van de resource.
location	string		De locatie van de resource.
name	string		De naam van de resource.
properties.createdDate	string		De aanmaakdatum van de planning.
properties.dailyRecurrence	DayDetails		Als de planning eenmaal per dag van de week wordt uitgevoerd, geeft u het dagelijkse terugkeerpatroon op.
properties.hourlyRecurrence	HourDetails		Als de planning meerdere keren per dag wordt uitgevoerd, geeft u het terugkeerpatroon per uur op.
properties.notificationSettings	NotificationSettings		Instellingen voor meldingen.
properties.provisioningState	string		De inrichtingsstatus van de resource.
properties.status	EnableStatus	Disabled	De status van de planning (ingeschakeld, uitgeschakeld)
properties.targetResourceId	string		De resource-id waartoe de planning behoort
properties.taskType	string		Het taaktype van de planning (bijvoorbeeld LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		De tijdzone-id (bijvoorbeeld China (standaardtijd), Groenland (standaardtijd), Pacific (standaardtijd) enzovoort). De mogelijke waarden voor deze eigenschap vindt u in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier	string		De unieke onveranderbare id van een resource (GUID).
properties.weeklyRecurrence	WeekDetails		Als de planning slechts enkele dagen van de week wordt uitgevoerd, geeft u het wekelijkse terugkeerpatroon op.
tags	object		De tags van de resource.
type	string		Het type resource.

ScheduleList

Het antwoord van een lijstbewerking.

Name	Type	Description
nextLink	string	Koppeling voor de volgende set resultaten.
value	Schedule[]	Resultaten van de lijstbewerking.

WeekDetails

Eigenschappen van een wekelijks schema.

Name	Type	Description
time	string	Het tijdstip van de dag waarop de planning wordt uitgevoerd.
weekdays	string[]	De dagen van de week waarvoor de planning is ingesteld (bijvoorbeeld zondag, maandag, dinsdag, enz.).