Sdílet prostřednictvím


Schedules - List

Výpis plánů v daném testovacím prostředí

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
labName
path True

string

Název testovacího prostředí.

resourceGroupName
path True

string

Název skupiny prostředků.

subscriptionId
path True

string

ID předplatného.

api-version
query True

string

Verze klientského rozhraní API

$expand
query

string

Zadejte dotaz $expand. Příklad: properties($select=status)

$filter
query

string

Filtr, který se má použít pro operaci. Příklad: '$filter=contains(name;'myName')

$orderby
query

string

Výraz řazení výsledků pomocí notace OData Příklad: '$orderby=name desc'

$top
query

integer

int32

Maximální počet prostředků, které se mají z operace vrátit. Příklad: $top=10

Odpovědi

Name Typ Description
200 OK

ScheduleList

OK

Other Status Codes

CloudError

BadRequest

Zabezpečení

azure_auth

Implicitní udělení OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation Přístup k Microsoft Azure

Příklady

Schedules_List

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
CloudError

Chyba z požadavku REST.

CloudErrorBody

Text chyby z požadavku REST.

DayDetails

Vlastnosti denního plánu.

EnableStatus

Stav plánu (tj. Povoleno, Zakázáno)

HourDetails

Vlastnosti hodinového plánu.

NotificationSettings

Nastavení oznámení pro plán.

Schedule

Plán.

ScheduleList

Odpověď operace seznamu.

WeekDetails

Vlastnosti týdenního plánu.

CloudError

Chyba z požadavku REST.

Name Typ Description
error

CloudErrorBody

Chyba cloudu, ke které došlo

CloudErrorBody

Text chyby z požadavku REST.

Name Typ Description
code

string

Kód chyby

details

CloudErrorBody[]

Vnitřní chyby.

message

string

Chybová zpráva

target

string

Cíl chyby.

DayDetails

Vlastnosti denního plánu.

Name Typ Description
time

string

Čas, kdy bude plán probíhat.

EnableStatus

Stav plánu (tj. Povoleno, Zakázáno)

Name Typ Description
Disabled

string

Enabled

string

HourDetails

Vlastnosti hodinového plánu.

Name Typ Description
minute

integer

Počet minut v hodině, ve které bude plán běžet.

NotificationSettings

Nastavení oznámení pro plán.

Name Typ Default value Description
emailRecipient

string

Příjemce e-mailu, na který se mají odesílat oznámení (může to být seznam e-mailových adres oddělených středníkem).

notificationLocale

string

Národní prostředí, které se má použít při odesílání oznámení (náhradní pro nepodporované jazyky je EN).

status

EnableStatus

Disabled

Pokud jsou pro tento plán povolená oznámení (tj. Povoleno, Zakázáno).

timeInMinutes

integer

Čas v minutách před událostí, při které se odešle oznámení.

webhookUrl

string

Adresa URL webhooku, na kterou se oznámení odešle.

Schedule

Plán.

Name Typ Default value Description
id

string

Identifikátor prostředku.

location

string

Umístění prostředku.

name

string

Název prostředku.

properties.createdDate

string

Datum vytvoření plánu.

properties.dailyRecurrence

DayDetails

Pokud bude plán probíhat každý den v týdnu, zadejte denní opakování.

properties.hourlyRecurrence

HourDetails

Pokud bude plán probíhat několikrát denně, zadejte hodinové opakování.

properties.notificationSettings

NotificationSettings

Nastavení oznámení.

properties.provisioningState

string

Stav zřizování prostředku.

properties.status

EnableStatus

Disabled

Stav plánu (tj. Povoleno, Zakázáno)

properties.targetResourceId

string

ID prostředku, ke kterému patří plán

properties.taskType

string

Typ úkolu plánu (např. LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

ID časového pásma (např. Čína (běžný čas), Grónsko (běžný čas), Tichomoří (běžný čas) atd.). Možné hodnoty pro tuto vlastnost najdete v IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIdshttps://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md()

properties.uniqueIdentifier

string

Jedinečný neměnný identifikátor prostředku (GUID).

properties.weeklyRecurrence

WeekDetails

Pokud plán nastane pouze v některých dnech v týdnu, zadejte týdenní opakování.

tags

object

Značky prostředku.

type

string

Typ prostředku.

ScheduleList

Odpověď operace seznamu.

Name Typ Description
nextLink

string

Odkaz na další sadu výsledků

value

Schedule[]

Výsledky operace seznamu

WeekDetails

Vlastnosti týdenního plánu.

Name Typ Description
time

string

Čas dne, kdy bude plán probíhat.

weekdays

string[]

Dny v týdnu, pro které je plán nastavený (např. neděle, pondělí, úterý atd.).