Global Schedules - Get

Referencia

Szolgáltatás:: Dev Test Labs

API-verzió:: 2018-09-15

Ütemezés lekérése.

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
name	path	True	string	Az ütemezés neve.
resourceGroupName	path	True	string	Az erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés azonosítója.
api-version	query	True	string	Ügyfél API-verziója.
$expand	query		string	Adja meg a $expand lekérdezést. Példa: 'properties($select=status)'

Válaszok

Name	Típus	Description
200 OK	Schedule	OKÉ
Other Status Codes	CloudError	Hibás kérés

Biztonság

azure_auth

OAuth2 Implicit Grant

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	Hozzáférés a Microsoft Azure-hoz

Példák

GlobalSchedules_Get

Mintakérelem

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


/**
 * Samples for GlobalSchedules GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/GlobalSchedules_Get.
     * json
     */
    /**
     * Sample code: GlobalSchedules_Get.
     * 
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void globalSchedulesGet(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager.globalSchedules().getByResourceGroupWithResponse("resourceGroupName", "labvmautostart", 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 global_schedules_get.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.global_schedules.get(
        resource_group_name="resourceGroupName",
        name="labvmautostart",
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/GlobalSchedules_Get.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/GlobalSchedules_Get.json
func ExampleGlobalSchedulesClient_Get() {
	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)
	}
	res, err := clientFactory.NewGlobalSchedulesClient().Get(ctx, "resourceGroupName", "labvmautostart", &armdevtestlabs.GlobalSchedulesClientGetOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Schedule = armdevtestlabs.Schedule{
	// 	Name: to.Ptr("LabVmAutoStart"),
	// 	Type: to.Ptr("microsoft.devtestlab/labs/schedules"),
	// 	ID: to.Ptr("/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/schedules/labvmautostart"),
	// 	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, "2020-12-29T22:54:54.933Z"); return t}()),
	// 		NotificationSettings: &armdevtestlabs.NotificationSettings{
	// 			Status: to.Ptr(armdevtestlabs.EnableStatusDisabled),
	// 			TimeInMinutes: to.Ptr[int32](0),
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		Status: to.Ptr(armdevtestlabs.EnableStatusEnabled),
	// 		TaskType: to.Ptr("LabVmsStartupTask"),
	// 		TimeZoneID: to.Ptr("Hawaiian Standard Time"),
	// 		UniqueIdentifier: to.Ptr("{id}"),
	// 		WeeklyRecurrence: &armdevtestlabs.WeekDetails{
	// 			Time: to.Ptr("0700"),
	// 			Weekdays: []*string{
	// 				to.Ptr("Monday"),
	// 				to.Ptr("Tuesday"),
	// 				to.Ptr("Wednesday"),
	// 				to.Ptr("Thursday"),
	// 				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 Get schedule.
 *
 * @summary Get schedule.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/GlobalSchedules_Get.json
 */
async function globalSchedulesGet() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const name = "labvmautostart";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.globalSchedules.get(resourceGroupName, name);
  console.log(result);
}

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

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/GlobalSchedules_Get.json
// this example is just showing the usage of "GlobalSchedules_Get" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this DevTestLabGlobalScheduleResource
DevTestLabGlobalScheduleCollection collection = resourceGroupResource.GetDevTestLabGlobalSchedules();

// invoke the operation
string name = "labvmautostart";
NullableResponse<DevTestLabGlobalScheduleResource> response = await collection.GetIfExistsAsync(name);
DevTestLabGlobalScheduleResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result 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 = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:: 200

{
  "properties": {
    "status": "Enabled",
    "taskType": "LabVmsStartupTask",
    "weeklyRecurrence": {
      "weekdays": [
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday"
      ],
      "time": "0700"
    },
    "timeZoneId": "Hawaiian Standard Time",
    "notificationSettings": {
      "status": "Disabled",
      "timeInMinutes": 0
    },
    "createdDate": "2020-12-29T22:54:54.9335182+00:00",
    "provisioningState": "Succeeded",
    "uniqueIdentifier": "{id}"
  },
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/schedules/labvmautostart",
  "name": "LabVmAutoStart",
  "type": "microsoft.devtestlab/labs/schedules",
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Definíciók

Name	Description
CloudError	REST-kérés hibája.
CloudErrorBody	Egy REST-kérésből származó hiba törzse.
DayDetails	A napi ütemezés tulajdonságai.
EnableStatus	Az ütemezés állapota (azaz engedélyezve, letiltva)
HourDetails	Az órarend tulajdonságai.
NotificationSettings	Ütemezés értesítési beállításai.
Schedule	Egy ütemterv.
WeekDetails	Heti ütemezés tulajdonságai.

CloudError

Objektum

REST-kérés hibája.

Name	Típus	Description
error	CloudErrorBody	A felhőben bekövetkezett hiba

CloudErrorBody

Objektum

Egy REST-kérésből származó hiba törzse.

Name	Típus	Description
code	string	A hibakód.
details	CloudErrorBody[]	Belső hibák.
message	string	A hibaüzenet.
target	string	A hibacél.

DayDetails

Objektum

A napi ütemezés tulajdonságai.

Name	Típus	Description
time	string	Az ütemezés napjának időpontja.

EnableStatus

Enumerálás

Az ütemezés állapota (azaz engedélyezve, letiltva)

Érték	Description
Disabled
Enabled

HourDetails

Objektum

Az órarend tulajdonságai.

Name	Típus	Description
minute	integer (int32)	Az ütemezés percei.

NotificationSettings

Objektum

Ütemezés értesítési beállításai.

Name	Típus	Alapértelmezett érték	Description
emailRecipient	string		Az e-mail címzettje, akinek értesítéseket szeretne küldeni (a pontosvesszővel elválasztott e-mail-címek listája lehet).
notificationLocale	string		Az értesítés küldésekor használandó területi beállítás (a nem támogatott nyelvekre vonatkozó tartalék az EN).
status	EnableStatus	Disabled	Ha az értesítések engedélyezve vannak ehhez az ütemezéshez (azaz engedélyezve, letiltva).
timeInMinutes	integer (int32)		Az értesítés elküldésének időpontja percekben az esemény előtt.
webhookUrl	string		A webhook URL-címe, amelyre az értesítést küldi.

Schedule

Objektum

Egy ütemterv.

Name	Típus	Alapértelmezett érték	Description
id	string		Az erőforrás azonosítója.
location	string		Az erőforrás helye.
name	string		Az erőforrás neve.
properties.createdDate	string (date-time)		Az ütemezés létrehozási dátuma.
properties.dailyRecurrence	DayDetails		Ha az ütemezés a hét minden napján egyszer megtörténik, adja meg a napi ismétlődéseket.
properties.hourlyRecurrence	HourDetails		Ha az ütemezés naponta többször is megtörténik, adja meg az óránkénti ismétlődéseket.
properties.notificationSettings	NotificationSettings		Értesítési beállítások.
properties.provisioningState	string		Az erőforrás kiépítési állapota.
properties.status	EnableStatus	Disabled	Az ütemezés állapota (azaz engedélyezve, letiltva)
properties.targetResourceId	string		Az erőforrás-azonosító, amelyhez az ütemezés tartozik
properties.taskType	string		Az ütemezés tevékenységtípusa (pl. LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		Az időzóna azonosítója (pl. kínai téli idő, grönlandi téli idő, csendes-óceáni téli idő stb.). A tulajdonság lehetséges értékei `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier	string		Az erőforrás egyedi nem módosítható azonosítója (Guid).
properties.weeklyRecurrence	WeekDetails		Ha az ütemezés csak a hét egyes napjaiban fordul elő, adja meg a heti ismétlődéseket.
tags	object		Az erőforrás címkéi.
type	string		Az erőforrás típusa.

WeekDetails

Objektum

Heti ütemezés tulajdonságai.

Name	Típus	Description
time	string	Az ütemezés napjának időpontja.
weekdays	string[]	A hét azon napjai, amelyekre az ütemezés be van állítva (például vasárnap, hétfő, kedd stb.).