Partilhar via


Schedules - List

Listar agendas num 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 do URI

Name Em Necessário Tipo Description
labName
path True

string

O nome do laboratório.

resourceGroupName
path True

string

O nome do grupo de recursos.

subscriptionId
path True

string

O ID da subscrição.

api-version
query True

string

Versão da API de Cliente.

$expand
query

string

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

$filter
query

string

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

$orderby
query

string

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

$top
query

integer

int32

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

Respostas

Name Tipo Description
200 OK

ScheduleList

OK

Other Status Codes

CloudError

BadRequest

Segurança

azure_auth

Concessão Implícita OAuth2

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

Âmbitos

Name Description
user_impersonation Aceder ao Microsoft Azure

Exemplos

Schedules_List

Pedido de amostra

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

Resposta da amostra

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

Name Description
CloudError

Erro de um pedido REST.

CloudErrorBody

Corpo de um erro de um pedido REST.

DayDetails

Propriedades de uma agenda diária.

EnableStatus

O estado da agenda (ou seja, Ativado, Desativado)

HourDetails

Propriedades de uma agenda por hora.

NotificationSettings

Definições de notificação para uma agenda.

Schedule

Uma agenda.

ScheduleList

A resposta de uma operação de lista.

WeekDetails

Propriedades de uma agenda semanal.

CloudError

Erro de um pedido REST.

Name Tipo Description
error

CloudErrorBody

O erro na cloud que ocorreu

CloudErrorBody

Corpo de um erro de um pedido REST.

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

Name Tipo Description
time

string

A hora do dia em que a agenda irá ocorrer.

EnableStatus

O estado da agenda (ou seja, Ativado, Desativado)

Name Tipo Description
Disabled

string

Enabled

string

HourDetails

Propriedades de uma agenda por hora.

Name Tipo Description
minute

integer

Minutos da hora em que o agendamento será executado.

NotificationSettings

Definiçõ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 região a utilizar ao enviar uma notificação (contingência para idiomas não suportados é EN).

status

EnableStatus

Disabled

Se as notificações estiverem ativadas para esta agenda (ou seja, Ativada, Desativada).

timeInMinutes

integer

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

Uma agenda.

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

A data de criação da agenda.

properties.dailyRecurrence

DayDetails

Se a agenda ocorrer uma vez por dia da semana, especifique a periodicidade diária.

properties.hourlyRecurrence

HourDetails

Se a agenda ocorrer várias vezes por dia, especifique a periodicidade por hora.

properties.notificationSettings

NotificationSettings

Definições de notificação.

properties.provisioningState

string

O estado de aprovisionamento do recurso.

properties.status

EnableStatus

Disabled

O estado da agenda (ou seja, Ativado, Desativado)

properties.targetResourceId

string

O ID do recurso ao qual a agenda pertence

properties.taskType

string

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

properties.timeZoneId

string

O ID do fuso horário (por exemplo, Hora Padrão da China, Hora Padrão da Gronelâ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 imutável exclusivo de um recurso (Guid).

properties.weeklyRecurrence

WeekDetails

Se a agenda ocorrer apenas alguns dias da semana, especifique a periodicidade semanal.

tags

object

As etiquetas do recurso.

type

string

O tipo do recurso.

ScheduleList

A resposta de uma operação de lista.

Name Tipo Description
nextLink

string

Ligação para o próximo conjunto de resultados.

value

Schedule[]

Resultados da operação de lista.

WeekDetails

Propriedades de uma agenda semanal.

Name Tipo Description
time

string

A hora do dia em que a agenda irá ocorrer.

weekdays

string[]

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