Compartilhar via


Schedules - List

Listar agendas em um determinado laboratório.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules?api-version=2018-09-15
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15

Parâmetros de URI

Nome Em Obrigatório Tipo Description
labName
path True

string

O nome do lab.

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.

$expand
query

string

Especifique a consulta $expand. Exemplo: 'properties($select=status)'

$filter
query

string

O filtro a ser aplicado à operação. Exemplo: '$filter=contains(name,'myName')

$orderby
query

string

A expressão de ordenação para os resultados, usando a notação OData. Exemplo: '$orderby=name desc'

$top
query

integer

int32

O número máximo de recursos a serem retornados da operação. Exemplo: '$top=10'

Respostas

Nome Tipo Description
200 OK

ScheduleList

OK

Other Status Codes

CloudError

BadRequest

Segurança

azure_auth

Concessão Implícita OAuth2

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

Escopos

Nome Description
user_impersonation Acessar o Microsoft Azure

Exemplos

Schedules_List

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
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

Um agendamento.

ScheduleList

A resposta de uma operação de lista.

WeekDetails

Propriedades de uma agenda semanal.

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 o agendamento 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 no qual a notificação será enviada.

webhookUrl

string

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

Schedule

Um agendamento.

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 do agendamento.

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.

ScheduleList

A resposta de uma operação de lista.

Nome Tipo Description
nextLink

string

Link para o próximo conjunto de resultados.

value

Schedule[]

Resultados da operação de lista.

WeekDetails

Propriedades de uma agenda semanal.

Nome Tipo Description
time

string

A hora do dia em que o agendamento ocorrerá.

weekdays

string[]

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