Schedules - List Applicable

Servicio:: Dev Test Labs

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

Enumera todas las programaciones aplicables

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
labName	path	True	string	Laboratorios
name	path	True	string	El nombre del Horario
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	ScheduleList	La operación de Azure se completó correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory.

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

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Schedules_ListApplicable

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "name": "{scheduleName}",
      "type": "Microsoft.DevTestLab/labs/schedules",
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/schedules/{scheduleName}",
      "location": "{location}",
      "properties": {
        "createdDate": "2018-10-01T18:40:48.1739018-07:00",
        "dailyRecurrence": {
          "time": "{timeOfTheDayTheScheduleWillOccurEveryDay}"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "notificationSettings": {
          "emailRecipient": "{email}",
          "notificationLocale": "EN",
          "status": "{Enabled|Disabled}",
          "timeInMinutes": 15,
          "webhookUrl": "{webhookUrl}"
        },
        "provisioningState": "Creating",
        "status": "{Enabled|Disabled}",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
        "taskType": "{myLabVmTaskType}",
        "timeZoneId": "Pacific Standard Time",
        "uniqueIdentifier": "{uniqueIdentifier}",
        "weeklyRecurrence": {
          "time": "{timeOfTheDayTheScheduleWillOccurOnThoseDays}",
          "weekdays": [
            "Monday",
            "Wednesday",
            "Friday"
          ]
        }
      },
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

Definiciones

Nombre	Description
DayDetails	Propiedades de una programación diaria.
EnableStatus	Indica si el origen del artefacto está habilitado (valores: Habilitado, Deshabilitado).
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
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.

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

Indica si el origen del artefacto está habilitado (valores: Habilitado, Deshabilitado).

Valor	Description
Enabled
Disabled

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

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.

ScheduleList

Object

Respuesta de una operación de lista.

Nombre	Tipo	Description
nextLink	string (uri)	Vínculo a la página siguiente de elementos
value	Schedule[]	Los elementos Programación de esta página

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

Compartir a través de

Schedules - List Applicable

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Schedules_ListApplicable

Solicitud de ejemplo

Respuesta de muestra

Definiciones

DayDetails

EnableStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HourDetails

NotificationSettings

Schedule

ScheduleList

WeekDetails