Schedules - List

Seznam 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 In Required Type 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 rozhraní API klienta

$expand
query
  • string

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

$filter
query
  • string

Filtr, který se má použít pro operaci. Příklad: ' $filter = Contains (název; ' Jmene ')

$orderby
query
  • string

Výraz řazení pro výsledky pomocí zápisu OData. Příklad: ' $orderby = název DESC '

$top
query
  • integer
int32

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

Odpovědi

Name Type Description
200 OK

OK

Other Status Codes

Důvodu chybného požadavku

Zabezpečení

azure_auth

Implicitní grant OAuth2

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

Scopes

Name Description
user_impersonation Přístup Microsoft Azure

Příklady

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

Definice

CloudError

Chyba z požadavku REST.

CloudErrorBody

Tělo chyby z žádosti REST

DayDetails

Vlastnosti denního plánu.

EnableStatus

Stav plánu (například Enabled, disabled)

HourDetails

Vlastnosti hodinového plánu.

NotificationSettings

Nastavení oznámení pro plán.

Schedule

Plán.

ScheduleList

Odpověď na operaci seznamu

WeekDetails

Vlastnosti týdenního plánu.

CloudError

Chyba z požadavku REST.

Name Type Description
error

Chyba cloudu, ke které došlo

CloudErrorBody

Tělo chyby z žádosti REST

Name Type Description
code
  • string

Kód chyby

details

Vnitřní chyby.

message
  • string

Chybová zpráva

target
  • string

Cílová chyba.

DayDetails

Vlastnosti denního plánu.

Name Type Description
time
  • string

Čas, kdy bude plán proveden.

EnableStatus

Stav plánu (například Enabled, disabled)

Name Type Description
Disabled
  • string
Enabled
  • string

HourDetails

Vlastnosti hodinového plánu.

Name Type Description
minute
  • integer

Minuty z hodiny, kdy se plán spustí

NotificationSettings

Nastavení oznámení pro plán.

Name Type Description
emailRecipient
  • string

Příjemce e-mailu, do kterého se mají posílat oznámení (může se jednat o seznam středníkem oddělených e-mailových adres).

notificationLocale
  • string

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

status

Pokud jsou pro tento plán povolena oznámení (například povoleno, zakázáno).

timeInMinutes
  • integer

Doba v minutách, po které bude odesláno oznámení.

webhookUrl
  • string

Adresa URL Webhooku, na kterou se bude odesílat oznámení

Schedule

Plán.

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

Pokud k plánu dojde jednou denně v týdnu, zadejte denní opakování.

properties.hourlyRecurrence

Pokud k plánu dojde několikrát denně, zadejte hodinové opakování.

properties.notificationSettings

Nastavení oznámení

properties.provisioningState
  • string

Stav zřizování prostředku

properties.status

Stav plánu (například Enabled, disabled)

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ř. Tichomoří (běžný čas)).

properties.uniqueIdentifier
  • string

Jedinečný identifikátor neproměnlivého identifikátoru prostředku (GUID).

properties.weeklyRecurrence

Pokud k plánu dojde jenom po dobu v týdnu, zadejte týdenní opakování.

tags
  • object

Značky prostředku

type
  • string

Typ prostředku.

ScheduleList

Odpověď na operaci seznamu

Name Type Description
nextLink
  • string

Odkaz na další sadu výsledků.

value

Výsledky operace se seznamem

WeekDetails

Vlastnosti týdenního plánu.

Name Type Description
time
  • string

Čas, kdy bude plán proveden.

weekdays
  • string[]

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