Global Schedules - Get

Služba:

Dev Test Labs

Verze rozhraní API:

2018-09-15

Získejte plán.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
name	path	True	string	Název plánu
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
$expand	query		string	Zadejte dotaz $expand. Příklad: 'properties($select=status)'

Odpovědi

Name	Typ	Description
200 OK	Schedule	Operace Azure byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

GlobalSchedules_Get

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

{
  "name": "LabVmAutoStart",
  "type": "microsoft.devtestlab/labs/schedules",
  "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{labName}/schedules/labvmautostart",
  "location": "{location}",
  "properties": {
    "createdDate": "2020-12-29T22:54:54.9335182+00:00",
    "notificationSettings": {
      "status": "Disabled",
      "timeInMinutes": 0
    },
    "provisioningState": "Succeeded",
    "status": "Enabled",
    "taskType": "LabVmsStartupTask",
    "timeZoneId": "Hawaiian Standard Time",
    "uniqueIdentifier": "{id}",
    "weeklyRecurrence": {
      "time": "0700",
      "weekdays": [
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday"
      ]
    }
  },
  "tags": {
    "tagName1": "tagValue1"
  }
}

Definice

Name	Description
DayDetails	Vlastnosti denního plánu
EnableStatus	Označuje, jestli je zdroj artefaktů povolený (hodnoty: Povoleno, Zakázáno).
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
HourDetails	Vlastnosti hodinového plánu
NotificationSettings	Nastavení oznámení pro plán
Schedule	Plán.
WeekDetails	Vlastnosti týdenního plánu

DayDetails

Objekt

Vlastnosti denního plánu

Name	Typ	Description
time	string	Nastane čas v den, kdy bude plán probíhat.

EnableStatus

Výčet

Označuje, jestli je zdroj artefaktů povolený (hodnoty: Povoleno, Zakázáno).

Hodnota	Description
Enabled
Disabled

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

HourDetails

Objekt

Vlastnosti hodinového plánu

Name	Typ	Description
minute	integer (int32)	Minuty hodiny, po které se plán spustí.

NotificationSettings

Objekt

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 středník 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áložní pro nepodporované jazyky je EN).
status	EnableStatus	Disabled	Pokud jsou pro tento plán povolená oznámení (tj. Povoleno, Zakázáno).
timeInMinutes	integer (int32)		Čas v minutách před událostí, ve které se oznámení odešle.
webhookUrl	string		Adresa URL webhooku, na kterou se oznámení odešle.

Schedule

Objekt

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 (date-time)		Datum vytvoření plánu.
properties.dailyRecurrence	DayDetails		Pokud plán nastane jednou denně v týdnu, zadejte denní opakování.
properties.hourlyRecurrence	HourDetails		Pokud bude plán probíhat vícekrá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, do kterého plán patří
properties.taskType	string		Typ úkolu plánu (např. LabVmsShutdownTask, LabVmAutoStart).
properties.timeZoneId	string		ID časového pásma (např. Standardní čas Číny, Standardní čas Greenlandu, Tichomoří (běžný čas) atd.). Možné hodnoty této vlastnosti najdete v IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
properties.uniqueIdentifier	string		Jedinečný neměnný identifikátor prostředku (GUID).
properties.weeklyRecurrence	WeekDetails		Pokud bude plán probíhat 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.

WeekDetails

Objekt

Vlastnosti týdenního plánu

Name	Typ	Description
time	string	Nastane čas v den, 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.).