Virtual Machines - List Applicable Schedules

Serviço:: Dev Test Labs

Versão da API:: 2018-09-15

Lista os agendamentos de início/parada aplicáveis, se houver.

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 laboratório.
name	path	True	string	O nome do LabVirtualMachine
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ApplicableSchedule	A operação do Azure foi concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

VirtualMachines_ListApplicableSchedules

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

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

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.
DayDetails	Propriedades de uma agenda diária.
EnableStatus	Indica se a origem do artefato está habilitada (valores: Habilitado, Desabilitado).
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
HourDetails	Propriedades de uma agenda por hora.
NotificationSettings	Configurações de notificação para um agendamento.
Schedule	Uma agenda.
WeekDetails	Propriedades de um agendamento semanal.

ApplicableSchedule

Objeto

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 de 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	O tipo do recurso.

DayDetails

Objeto

Propriedades de uma agenda diária.

Nome	Tipo	Description
time	string	A hora do dia em que a agenda ocorrerá.

EnableStatus

Enumeração

Indica se a origem do artefato está habilitada (valores: Habilitado, Desabilitado).

Valor	Description
Enabled
Disabled

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

HourDetails

Objeto

Propriedades de uma agenda por hora.

Nome	Tipo	Description
minute	integer (int32)	Minutos da hora em que o agendamento será executado.

NotificationSettings

Objeto

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

Nome	Tipo	Valor padrão	Description
emailRecipient	string		O destinatário de 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 (int32)		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

Objeto

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 (date-time)		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		O tipo do recurso.

WeekDetails

Objeto

Propriedades de um agendamento semanal.

Nome	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, terça,etc.).

Compartilhar via

Virtual Machines - List Applicable Schedules

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

VirtualMachines_ListApplicableSchedules

Solicitação de exemplo

Resposta de exemplo

Definições

ApplicableSchedule

DayDetails

EnableStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HourDetails

NotificationSettings

Schedule

WeekDetails