Partilhar via

Virtual Machines - List Applicable Schedules

  • Referência
Serviço:
Dev Test Labs
Versão da API:
2018-09-15

Listas os agendamentos de início/paragem aplicáveis, se existirem.

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

Parâmetros do URI

Name Em Necessário Tipo Description
labName
 path True

string

O nome do laboratório.
name
 path True

string

O nome da máquina virtual.
resourceGroupName
 path True

string

O nome do grupo de recursos.
subscriptionId
 path True

string

O ID da subscrição.
api-version
 query True

string

Versão da API de Cliente.

Respostas

Name Tipo Description
200 OK

ApplicableSchedule

OK
Other Status Codes

CloudError

BadRequest

Segurança

azure_auth

Concessão Implícita OAuth2

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation Aceder ao Microsoft Azure

Exemplos

VirtualMachines_ListApplicableSchedules

Pedido de amostra

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

Resposta da amostra

Código de estado:
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

Name Description
ApplicableSchedule

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

Erro de um pedido REST.
CloudErrorBody

Corpo de um erro de um pedido REST.
DayDetails

Propriedades de uma agenda diária.
EnableStatus

O estado da agenda (ou seja, Ativado, Desativado)
HourDetails

Propriedades de uma agenda por hora.
NotificationSettings

Definições de notificação para uma agenda.
Schedule

Uma agenda.
WeekDetails

Propriedades de uma agenda semanal.

ApplicableSchedule

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

Name 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 encerramento automático, se tiver sido definido ao nível do laboratório ou do recurso de laboratório.
properties.labVmsStartup

Schedule

O agendamento de arranque automático, se tiver sido definido ao nível do laboratório ou do recurso de laboratório.
tags

object

As etiquetas do recurso.
type

string

O tipo de recurso.

CloudError

Erro de um pedido REST.

Name Tipo Description
error

CloudErrorBody

O erro na cloud que ocorreu

CloudErrorBody

Corpo de um erro de um pedido REST.

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

Name Tipo Description
time

string

A hora do dia em que a agenda ocorrerá.

EnableStatus

O estado da agenda (ou seja, Ativado, Desativado)

Name Tipo Description
Disabled

string

Enabled

string

HourDetails

Propriedades de uma agenda por hora.

Name Tipo Description
minute

integer

Minutos da hora em que a agenda será executada.

NotificationSettings

Definições de notificação para uma agenda.

Name Tipo Default value Description
emailRecipient

string

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

string

A região a utilizar ao enviar uma notificação (contingência para idiomas não suportados é EN).
status

EnableStatus

Disabled

Se as notificações estiverem ativadas para esta agenda (ou seja, Ativada, Desativada).
timeInMinutes

integer

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

string

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

Schedule

Uma agenda.

Name Tipo Default value 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 a agenda ocorrer uma vez por dia da semana, especifique a periodicidade diária.
properties.hourlyRecurrence

HourDetails

Se a agenda ocorrer várias vezes por dia, especifique a periodicidade por hora.
properties.notificationSettings

NotificationSettings

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

string

O estado de aprovisionamento do recurso.
properties.status

EnableStatus

Disabled

O estado da agenda (ou seja, Ativado, Desativado)
properties.targetResourceId

string

O ID do recurso ao qual a agenda pertence
properties.taskType

string

O tipo de tarefa da agenda (por exemplo, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId

string

O ID do fuso horário (por exemplo, Hora Padrão da China, Hora Padrão da Gronelândia, Hora Padrão do Pacífico, etc.). Os valores possíveis para esta 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 a agenda ocorrer apenas alguns dias da semana, especifique a periodicidade semanal.
tags

object

As etiquetas do recurso.
type

string

O tipo de recurso.

WeekDetails

Propriedades de uma agenda semanal.

Name Tipo Description
time

string

A hora do dia em que a agenda ocorrerá.
weekdays

string[]

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