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

Name In Required Type 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 de $expand. Exemplo: ' Properties ($select = status) '

$filter
query
  • string

O filtro a ser aplicado à operação. Exemplo: ' $filter = Contains (nome, ' myname ')

$orderby
query
  • string

A expressão de ordenação dos 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

Name Type Description
200 OK

OK

Other Status Codes

BadRequest

Segurança

azure_auth

Concessão implícita OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Microsoft Azure de acesso

Exemplos

Schedules_List

Sample Request

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

Sample Response

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

CloudError

Erro de uma solicitação REST.

CloudErrorBody

Corpo de um erro de uma solicitação REST.

DayDetails

Propriedades de um agendamento diário.

EnableStatus

O status da agenda (ou seja, habilitado, desabilitado)

HourDetails

Propriedades de um agendamento por hora.

NotificationSettings

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

Schedule

Uma agenda.

ScheduleList

A resposta de uma operação de lista.

WeekDetails

Propriedades de um cronograma semanal.

CloudError

Erro de uma solicitação REST.

Name Type Description
error

O erro de nuvem que ocorreu

CloudErrorBody

Corpo de um erro de uma solicitação REST.

Name Type Description
code
  • string

O código de erro.

details

Erros internos.

message
  • string

A mensagem de erro.

target
  • string

O destino do erro.

DayDetails

Propriedades de um agendamento diário.

Name Type Description
time
  • string

A hora do dia em que a agenda ocorrerá.

EnableStatus

O status da agenda (ou seja, habilitado, desabilitado)

Name Type Description
Disabled
  • string
Enabled
  • string

HourDetails

Propriedades de um agendamento por hora.

Name Type Description
minute
  • integer

Minutos da hora em que a agenda será executada.

NotificationSettings

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

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

Se as notificações estiverem habilitadas para esse agendamento (ou seja, habilitadas, desabilitadas).

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

Uma agenda.

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

Se a agenda ocorrer uma vez a cada dia da semana, especifique a recorrência diária.

properties.hourlyRecurrence

Se a agenda ocorrer várias vezes por dia, especifique a recorrência por hora.

properties.notificationSettings

Configurações de notificação.

properties.provisioningState
  • string

O status de provisionamento do recurso.

properties.status

O status da agenda (ou seja, habilitado, desabilitado)

properties.targetResourceId
  • string

A ID de recurso à qual a agenda pertence

properties.taskType
  • string

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

properties.timeZoneId
  • string

A ID de fuso horário (por exemplo, horário padrão do Pacífico).

properties.uniqueIdentifier
  • string

O identificador imutável exclusivo de um recurso (GUID).

properties.weeklyRecurrence

Se a agenda 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.

Name Type Description
nextLink
  • string

Link para o próximo conjunto de resultados.

value

Resultados da operação de lista.

WeekDetails

Propriedades de um cronograma semanal.

Name Type Description
time
  • string

A hora do dia em que a agenda ocorrerá.

weekdays
  • string[]

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