Schedules - List

Enumerar programaciones en un laboratorio determinado.

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

Parámetros de identificador URI

Name In Required Type Description
labName
path True
  • string

El nombre del laboratorio.

resourceGroupName
path True
  • string

Nombre del grupo de recursos.

subscriptionId
path True
  • string

Identificador de la suscripción.

api-version
query True
  • string

Versión de API del cliente.

$expand
query
  • string

Especifique la consulta de $expand. Ejemplo: 'properties($select=status)'

$filter
query
  • string

Filtro que se va a aplicar a la operación. Ejemplo: '$filter=contains(name,'myName')

$orderby
query
  • string

Expresión de ordenación de los resultados, mediante notación OData. Ejemplo: '$orderby=name desc'

$top
query
  • integer
int32

Número máximo de recursos que se van a devolver de la operación. Ejemplo: "$top=10"

Respuestas

Name Type Description
200 OK

Aceptar

Other Status Codes

BadRequest

Seguridad

azure_auth

Concesión implícita de OAuth2

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

Scopes

Name Description
user_impersonation Acceso Microsoft Azure

Ejemplos

Schedules_List

Sample Request

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

Sample Response

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

Definiciones

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.

ScheduleList

Respuesta de una operación de lista.

WeekDetails

Propiedades de una programación semanal.

CloudError

Error de una solicitud REST.

Name Type Description
error

Error en la nube que se produjo

CloudErrorBody

Cuerpo de un error de una solicitud REST.

Name Type Description
code
  • string

Código de error.

details

Errores internos.

message
  • string

El mensaje de error.

target
  • string

Destino del error.

DayDetails

Propiedades de una programación diaria.

Name Type Description
time
  • string

Hora del día en que se producirá la programación.

EnableStatus

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

Name Type Description
Disabled
  • string
Enabled
  • string

HourDetails

Propiedades de una programación por hora.

Name Type Description
minute
  • integer

Minutos de la hora en que se ejecutará la programación.

NotificationSettings

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

Name Type Default Value 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

La configuración regional que se va a usar al enviar una notificación (la reserva de idiomas no admitidos es EN).

status Disabled

Si las notificaciones están habilitadas para esta programación (es decir, Habilitada, Deshabilitada).

timeInMinutes
  • integer

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

Una programación.

Name Type Default Value Description
id
  • string

Identificador del recurso.

location
  • string

Ubicación del recurso.

name
  • string

Nombre del recurso.

properties.createdDate
  • string

Fecha de creación de la programación.

properties.dailyRecurrence

Si la programación se producirá una vez cada día de la semana, especifique la periodicidad diaria.

properties.hourlyRecurrence

Si la programación se producirá varias veces al día, especifique la periodicidad por hora.

properties.notificationSettings

Configuración de notificación.

properties.provisioningState
  • string

Estado de aprovisionamiento del recurso.

properties.status 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

Tipo de tarea de la programación (por ejemplo, LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId
  • string

Identificador de zona horaria (por ejemplo, hora estándar del Pacífico).

properties.uniqueIdentifier
  • string

Identificador inmutable único de un recurso (Guid).

properties.weeklyRecurrence

Si la programación se producirá solo algunos días de la semana, especifique la periodicidad semanal.

tags
  • object

Etiquetas del recurso.

type
  • string

Tipo de recurso.

ScheduleList

Respuesta de una operación de lista.

Name Type Description
nextLink
  • string

Vínculo para el siguiente conjunto de resultados.

value

Resultados de la operación de lista.

WeekDetails

Propiedades de una programación semanal.

Name Type 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.).