Virtual Machines - List Applicable Schedules

  • Referência
Service:
Dev Test Labs
API Version:
2018-09-15

Lista as agendas de iniciar/parar aplicáveis, se houver alguma.

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 URI

Nome Em Obrigatório Tipo Description
labName
 path True

string

O nome do lab.
name
 path True

string

O nome da máquina virtual.
resourceGroupName
 path True

string

O nome do grupo de recursos.
subscriptionId
 path True

string

A ID da assinatura.
api-version
 query True

string

Versão de API do cliente.

Respostas

Nome Tipo Description
200 OK

ApplicableSchedule

OK
Other Status Codes

CloudError

BadRequest

Segurança

azure_auth

Concessão Implícita OAuth2

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

Scopes

Nome Description
user_impersonation Acessar o Microsoft Azure

Exemplos

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

Definições

Nome Description
ApplicableSchedule

Agendas aplicáveis a uma máquina virtual. Os agendamentos podem ter sido definidos em uma VM ou no nível do laboratório.
CloudError

Erro de uma solicitação REST.
CloudErrorBody

Corpo de um erro de uma solicitação REST.
DayDetails

Propriedades de uma agenda diária.
EnableStatus

O status do agendamento (ou seja, Habilitado, Desabilitado)
HourDetails

Propriedades de um agendamento por hora.
NotificationSettings

Configurações de notificação para um agendamento.
Schedule

Uma agenda.
WeekDetails

Propriedades de um agendamento semanal.

ApplicableSchedule

Agendas aplicáveis a uma máquina virtual. Os agendamentos podem ter sido definidos em uma VM ou no nível do laboratório.

Nome Tipo Description
id

string

O identificador do recurso.
location

string

A localização do recurso.
name

string

O nome do recurso.
properties.labVmsShutdown

Schedule

O agendamento de desligamento automático, se um tiver sido definido no nível do recurso de laboratório ou laboratório.
properties.labVmsStartup

Schedule

O agendamento de inicialização automática, se um tiver sido definido no nível de recurso de laboratório ou laboratório.
tags

object

As marcas do recurso.
type

string

Tipo do recurso.

CloudError

Erro de uma solicitação REST.

Nome Tipo Description
error

CloudErrorBody

O erro de nuvem que ocorreu

CloudErrorBody

Corpo de um erro de uma solicitação REST.

Nome Tipo Description
code

string

O código de erro.
details

CloudErrorBody[]

Erros internos.
message

string

A mensagem de erro.
target

string

O destino do erro.

DayDetails

Propriedades de uma agenda diária.

Nome Tipo Description
time

string

A hora do dia em que a agenda ocorrerá.

EnableStatus

O status do agendamento (ou seja, Habilitado, Desabilitado)

Nome Tipo Description
Disabled

string

Enabled

string

HourDetails

Propriedades de um agendamento por hora.

Nome Tipo Description
minute

integer

Minutos da hora em que o agendamento será executado.

NotificationSettings

Configurações de notificação para um agendamento.

Nome Tipo Valor padrão Description
emailRecipient

string

O destinatário do email para o qual enviar notificações (pode ser uma lista de endereços de email separados por ponto e vírgula).
notificationLocale

string

A localidade a ser usada ao enviar uma notificação (o fallback para idiomas sem suporte é EN).
status

EnableStatus

Disabled

Se as notificações estiverem habilitadas para esse agendamento (ou seja, Habilitado, Desabilitado).
timeInMinutes

integer

Tempo em minutos antes do evento em que a notificação será enviada.
webhookUrl

string

A URL do webhook para a qual a notificação será enviada.

Schedule

Uma agenda.

Nome Tipo Valor padrão Description
id

string

O identificador do recurso.
location

string

A localização do recurso.
name

string

O nome do recurso.
properties.createdDate

string

A data de criação da agenda.
properties.dailyRecurrence

DayDetails

Se o agendamento ocorrer uma vez a cada dia da semana, especifique a recorrência diária.
properties.hourlyRecurrence

HourDetails

Se o agendamento ocorrer várias vezes por dia, especifique a recorrência por hora.
properties.notificationSettings

NotificationSettings

Configurações de notificação.
properties.provisioningState

string

O status de provisionamento do recurso.
properties.status

EnableStatus

Disabled

O status do agendamento (ou seja, Habilitado, Desabilitado)
properties.targetResourceId

string

A ID do recurso à qual o agendamento pertence
properties.taskType

string

O tipo de tarefa do agendamento (por exemplo, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId

string

A ID do fuso horário (por exemplo, Hora Padrão da China, Hora Padrão da Groenlândia, Hora Padrão do Pacífico etc.). Os valores possíveis para essa propriedade podem ser encontrados em IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier

string

O identificador imutável exclusivo de um recurso (Guid).
properties.weeklyRecurrence

WeekDetails

Se o agendamento ocorrer apenas alguns dias da semana, especifique a recorrência semanal.
tags

object

As marcas do recurso.
type

string

Tipo do recurso.

WeekDetails

Propriedades de um agendamento semanal.

Nome Tipo Description
time

string

A hora do dia em que o agendamento ocorrerá.
weekdays

string[]

Os dias da semana para os quais a agenda é definida (por exemplo, domingo, segunda- feira, terça-feira, etc.).