Virtual Machines - List Applicable Schedules

  • Referencia
Service:
Dev Test Labs
API Version:
2018-09-15

Muestra, si las hay, las programaciones de inicio y detención aplicables.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
labName
 path True

string

El nombre del laboratorio.
name
 path True

string

El nombre de la máquina virtual.
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.

Respuestas

Nombre Tipo Description
200 OK

ApplicableSchedule

Aceptar
Other Status Codes

CloudError

BadRequest

Seguridad

azure_auth

Concesión implícita de OAuth2

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

Scopes

Nombre Description
user_impersonation Acceso a Microsoft Azure

Ejemplos

VirtualMachines_ListApplicableSchedules

Sample Request

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

Sample Response

Status code:
200 
{
  "properties": {
    "labVmsShutdown": {
      "properties": {
        "status": "Enabled",
        "taskType": "LabVmsShutdownTask",
        "weeklyRecurrence": {
          "weekdays": [
            "Friday",
            "Saturday",
            "Sunday"
          ],
          "time": "1700"
        },
        "dailyRecurrence": {
          "time": "1900"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "timeZoneId": "Pacific Standard Time",
        "notificationSettings": {
          "status": "Enabled",
          "timeInMinutes": 30,
          "webhookUrl": "{webhookUrl}",
          "emailRecipient": "{email}",
          "notificationLocale": "EN"
        },
        "createdDate": "2020-12-29T21:48:14.1369355+00:00",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}",
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "4acf0408-1c10-49cb-96b7-28ce655c8320"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/myAutoShutdownSchedule",
      "name": "LabVmsShutdown",
      "type": "Microsoft.DevTestLab/labs/virtualMachines/schedules",
      "location": "{location}"
    },
    "labVmsStartup": {
      "properties": {
        "status": "Enabled",
        "taskType": "LabVmsStartupTask",
        "weeklyRecurrence": {
          "weekdays": [
            "Friday",
            "Saturday",
            "Sunday"
          ],
          "time": "1000"
        },
        "dailyRecurrence": {
          "time": "0900"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "timeZoneId": "Pacific Standard Time",
        "notificationSettings": {
          "status": "Enabled",
          "timeInMinutes": 30,
          "webhookUrl": "{webhookUrl}",
          "emailRecipient": "{email}",
          "notificationLocale": "EN"
        },
        "createdDate": "2020-12-29T21:46:37.0473976+00:00",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}",
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/myAutoStartSchedule",
      "name": "LabVmAutoStart",
      "type": "Microsoft.DevTestLab/labs/virtualMachines/schedules",
      "location": "{location}"
    }
  }
}

Definiciones

Nombre Description
ApplicableSchedule

Programaciones aplicables a una máquina virtual. Las programaciones se pueden haber definido en una máquina virtual o en el nivel de laboratorio.
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.

ApplicableSchedule

Programaciones aplicables a una máquina virtual. Las programaciones se pueden haber definido en una máquina virtual o en el nivel de laboratorio.

Nombre Tipo Description
id

string

Identificador del recurso.
location

string

Ubicación del recurso.
name

string

Nombre del recurso.
properties.labVmsShutdown

Schedule

La programación de apagado automático, si se ha establecido una en el nivel de recurso de laboratorio o laboratorio.
properties.labVmsStartup

Schedule

La programación de inicio automático, si se ha establecido una en el nivel de recurso de laboratorio o laboratorio.
tags

object

Las etiquetas del recurso.
type

string

Tipo de recurso.

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.

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