Schedules - List Applicable

Serviço:: Dev Test Labs

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

Lista todos os horários aplicáveis

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
labName	path	True	string	laboratórios
name	path	True	string	O nome da Agenda
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	ScheduleList	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

Schedules_ListApplicable

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "name": "{scheduleName}",
      "type": "Microsoft.DevTestLab/labs/schedules",
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/schedules/{scheduleName}",
      "location": "{location}",
      "properties": {
        "createdDate": "2018-10-01T18:40:48.1739018-07:00",
        "dailyRecurrence": {
          "time": "{timeOfTheDayTheScheduleWillOccurEveryDay}"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "notificationSettings": {
          "emailRecipient": "{email}",
          "notificationLocale": "EN",
          "status": "{Enabled|Disabled}",
          "timeInMinutes": 15,
          "webhookUrl": "{webhookUrl}"
        },
        "provisioningState": "Creating",
        "status": "{Enabled|Disabled}",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}",
        "taskType": "{myLabVmTaskType}",
        "timeZoneId": "Pacific Standard Time",
        "uniqueIdentifier": "{uniqueIdentifier}",
        "weeklyRecurrence": {
          "time": "{timeOfTheDayTheScheduleWillOccurOnThoseDays}",
          "weekdays": [
            "Monday",
            "Wednesday",
            "Friday"
          ]
        }
      },
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

Definições

Name	Description
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.
ScheduleList	A resposta de uma operação de lista.
WeekDetails	Propriedades de um horário semanal.

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.

ScheduleList

Object

A resposta de uma operação de lista.

Name	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	Schedule[]	Os itens Agendar nesta página

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

Schedules - List Applicable

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Schedules_ListApplicable

Pedido de amostra

Resposta da amostra

Definições

DayDetails

EnableStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HourDetails

NotificationSettings

Schedule

ScheduleList

WeekDetails