Compartir a través de


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

Nombre En Requerido Tipo 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 $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 para 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

Nombre Tipo Description
200 OK

ScheduleList

Aceptar

Other Status Codes

CloudError

BadRequest

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

Schedules_List

Solicitud de ejemplo

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

Respuesta de muestra

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

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.

ScheduleList

Respuesta de una operación de lista.

WeekDetails

Propiedades de una programación semanal.

CloudError

Error de una solicitud REST.

Nombre Tipo Description
error

CloudErrorBody

Error en la nube que se produjo

CloudErrorBody

Cuerpo de un error de una solicitud REST.

Nombre Tipo Description
code

string

Código de error.

details

CloudErrorBody[]

Errores internos.

message

string

El mensaje de error.

target

string

Destino del error.

DayDetails

Propiedades de una programación diaria.

Nombre Tipo Description
time

string

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

EnableStatus

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

Nombre Tipo Description
Disabled

string

Enabled

string

HourDetails

Propiedades de una programación por hora.

Nombre Tipo Description
minute

integer

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

NotificationSettings

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

Nombre Tipo Valor predeterminado Description
emailRecipient

string

El destinatario de 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 para idiomas no admitidos es EN).

status

EnableStatus

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.

Nombre Tipo Valor predeterminado 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

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 horaria.

properties.notificationSettings

NotificationSettings

Configuración de notificación.

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

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

Las etiquetas del recurso.

type

string

Tipo de recurso.

ScheduleList

Respuesta de una operación de lista.

Nombre Tipo Description
nextLink

string

Vínculo para el siguiente conjunto de resultados.

value

Schedule[]

Resultados de la operación de lista.

WeekDetails

Propiedades de una programación semanal.

Nombre Tipo Description
time

string

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

weekdays

string[]

Días de la semana para los que se establece la programación (por ejemplo, domingo, lunes, martes, etc.).