Global Schedules - Get

Referencia

Servicio:: Dev Test Labs

Versión de la API:: 2018-09-15

Obtener programación.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
name	path	True	string	Nombre de la programación.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
subscriptionId	path	True	string	Identificador de suscripción.
api-version	query	True	string	Versión de la API de cliente.
$expand	query		string	Especifique la consulta $expand. Ejemplo: 'properties($select=status)'

Respuestas

Nombre	Tipo	Description
200 OK	Schedule	De acuerdo
Other Status Codes	CloudError	Solicitud incorrecta

Seguridad

azure_auth

Concesión implícita de OAuth2

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	Acceso a Microsoft Azure

Ejemplos

GlobalSchedules_Get

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
  }
}

Definiciones

Nombre	Description
CloudError	Error de una solicitud REST.
CloudErrorBody	Cuerpo de un error de una solicitud REST.
DayDetails	Propiedades de una programación diaria.
EnableStatus	Estado de la programación (es decir, Habilitado, Deshabilitado)
HourDetails	Propiedades de una programación por hora.
NotificationSettings	Configuración de notificación para una programación.
Schedule	Una programación.
WeekDetails	Propiedades de una programación semanal.

CloudError

Object

Error de una solicitud REST.

Nombre	Tipo	Description
error	CloudErrorBody	Error en la nube que se produjo

CloudErrorBody

Object

Cuerpo de un error de una solicitud REST.

Nombre	Tipo	Description
code	string	Código de error.
details	CloudErrorBody[]	Errores internos.
message	string	Mensaje de error.
target	string	Destino del error.

DayDetails

Object

Propiedades de una programación diaria.

Nombre	Tipo	Description
time	string	Hora del día en que se producirá la programación.

EnableStatus

Enumeración

Estado de la programación (es decir, Habilitado, Deshabilitado)

Valor	Description
Disabled
Enabled

HourDetails

Object

Propiedades de una programación por hora.

Nombre	Tipo	Description
minute	integer (int32)	Minutos de la hora en que se ejecutará la programación.

NotificationSettings

Object

Configuración de notificación para una programación.

Nombre	Tipo	Valor predeterminado	Description
emailRecipient	string		El destinatario del correo electrónico al que enviar notificaciones (puede ser una lista de direcciones de correo electrónico separadas por punto y coma).
notificationLocale	string		Configuración regional que se va a usar al enviar una notificación (la reserva de idiomas no admitidos es EN).
status	EnableStatus	Disabled	Si las notificaciones están habilitadas para esta programación (es decir, Habilitada, Deshabilitada).
timeInMinutes	integer (int32)		Tiempo en minutos antes del evento en el que se enviará la notificación.
webhookUrl	string		Dirección URL del webhook a la que se enviará la notificación.

Schedule

Object

Una programación.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador del recurso.
location	string		La ubicación del recurso.
name	string		Nombre del recurso.
properties.createdDate	string (date-time)		Fecha de creación de la programación.
properties.dailyRecurrence	DayDetails		Si la programación se producirá una vez cada día de la semana, especifique la periodicidad diaria.
properties.hourlyRecurrence	HourDetails		Si la programación se producirá varias veces al día, especifique la periodicidad por hora.
properties.notificationSettings	NotificationSettings		Configuración de notificaciones.
properties.provisioningState	string		Estado de aprovisionamiento del recurso.
properties.status	EnableStatus	Disabled	Estado de la programación (es decir, Habilitado, Deshabilitado)
properties.targetResourceId	string		Identificador de recurso al que pertenece la programación
properties.taskType	string		El tipo de tarea de la programación (por ejemplo, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		El identificador de zona horaria (por ejemplo, hora estándar de China, hora estándar de Groenlandia, hora estándar del Pacífico, etc.). Los valores posibles para esta propiedad se pueden encontrar en `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier	string		Identificador inmutable único de un recurso (Guid).
properties.weeklyRecurrence	WeekDetails		Si la programación solo se producirá algunos días de la semana, especifique la periodicidad semanal.
tags	object		Etiquetas del recurso.
type	string		Tipo del recurso.

WeekDetails

Object

Propiedades de una programación semanal.

Nombre	Tipo	Description
time	string	Hora del día en que se producirá la programación.
weekdays	string[]	Los días de la semana para los que se establece la programación (por ejemplo, domingo, lunes, martes, etc.).