Virtual Machines - List Applicable Schedules

Serviço:: Dev Test Labs

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

Lista os horários 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 do URI

Name	Em	Necessá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 utilizar para esta operação.

Respostas

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

VirtualMachines_ListApplicableSchedules

Pedido de amostra

HTTP

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": {
      "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

Name	Description
ApplicableSchedule	Agendas aplicáveis a uma máquina virtual. As agendas podem ter sido definidas em uma VM ou em nível de laboratório.
DayDetails	Propriedades de uma programação diária.
EnableStatus	Indica se a origem do artefato está habilitada (valores: Habilitado, Desabilitado).
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
HourDetails	Propriedades de um horário horário.
NotificationSettings	Configurações de notificação para uma agenda.
Schedule	Um horário.
WeekDetails	Propriedades de um horário semanal.

ApplicableSchedule

Object

Agendas aplicáveis a uma máquina virtual. As agendas podem ter sido definidas em uma VM ou em nível de 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	A agenda de desligamento automático, se tiver sido definida no nível de recursos de laboratório ou laboratório.
properties.labVmsStartup	Schedule	O agendamento de inicialização automática, se tiver sido definido no nível de recurso de laboratório ou laboratório.
tags	object	As tags do recurso.
type	string	O tipo do recurso.

DayDetails

Object

Propriedades de uma programação diária.

Name	Tipo	Description
time	string	A hora do dia o horário ocorrerá.

EnableStatus

Enumeração

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

Valor	Description
Enabled
Disabled

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

HourDetails

Object

Propriedades de um horário horário.

Name	Tipo	Description
minute	integer (int32)	Minutos da hora em que o horário será executado.

NotificationSettings

Object

Configuraçõ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 ponto-e-vírgula).
notificationLocale	string		A localidade a ser usada ao enviar uma notificação (fallback para idiomas não suportados é EN).
status	EnableStatus	Disabled	Se as notificações estiverem habilitadas para esse agendamento (ou seja, Habilitado, Desativado).
timeInMinutes	integer (int32)		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

Object

Um horário.

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 (date-time)		A data de criação do cronograma.
properties.dailyRecurrence	DayDetails		Se o horário ocorrer uma vez em cada dia da semana, especifique a recorrência diária.
properties.hourlyRecurrence	HourDetails		Se o agendamento ocorrer várias vezes ao dia, especifique a recorrência horária.
properties.notificationSettings	NotificationSettings		Configurações de notificação.
properties.provisioningState	string		O status de provisionamento do recurso.
properties.status	EnableStatus	Disabled	O status da agenda (ou seja, Habilitado, Desativado)
properties.targetResourceId	string		O ID do recurso ao qual a agenda pertence
properties.taskType	string		O tipo de tarefa do cronograma (por exemplo, LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		O 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 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 único imutável de um recurso (Guid).
properties.weeklyRecurrence	WeekDetails		Se o horário ocorrer apenas alguns dias da semana, especifique a recorrência semanal.
tags	object		As tags do recurso.
type	string		O tipo do recurso.

WeekDetails

Object

Propriedades de um horário semanal.

Name	Tipo	Description
time	string	A hora do dia em que ocorrerá o agendamento.
weekdays	string[]	Os dias da semana para os quais o horário está definido (por exemplo, domingo, segunda-feira, terça-feira, etc.).

Partilhar via

Virtual Machines - List Applicable Schedules

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

VirtualMachines_ListApplicableSchedules

Pedido de amostra

Resposta da amostra

Definições

ApplicableSchedule

DayDetails

EnableStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HourDetails

NotificationSettings

Schedule

WeekDetails