Schedules - List

Lista scheman i ett visst labb.

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

URI-parametrar

Name In Required Type Description
labName
path True
  • string

Namnet på labbet.

resourceGroupName
path True
  • string

Namnet på resursgruppen.

subscriptionId
path True
  • string

Prenumerations-ID: t.

api-version
query True
  • string

Klient-API-version.

$expand
query
  • string

Ange frågan $expand. Exempel: "properties($select=status)"

$filter
query
  • string

Filtret som ska tillämpas på åtgärden. Exempel: '$filter=contains(name,'myName')

$orderby
query
  • string

Orderuttrycket för resultaten med OData-notation. Exempel: "$orderby=name desc"

$top
query
  • integer
int32

Det maximala antalet resurser som ska returneras från åtgärden. Exempel: "$top=10"

Svar

Name Type Description
200 OK

OK

Other Status Codes

BadRequest

Säkerhet

azure_auth

Implicit beviljande av OAuth2

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

Scopes

Name Description
user_impersonation Åtkomst Microsoft Azure

Exempel

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

Definitioner

CloudError

Fel från en REST-begäran.

CloudErrorBody

Brödtext för ett fel från en REST-begäran.

DayDetails

Egenskaper för ett dagligt schema.

EnableStatus

Status för schemat (t.ex. Aktiverad, Inaktiverad)

HourDetails

Egenskaper för ett schema per timme.

NotificationSettings

Meddelandeinställningar för ett schema.

Schedule

Ett schema.

ScheduleList

Svaret för en liståtgärd.

WeekDetails

Egenskaper för ett veckoschema.

CloudError

Fel från en REST-begäran.

Name Type Description
error

Molnfelet som inträffade

CloudErrorBody

Brödtext för ett fel från en REST-begäran.

Name Type Description
code
  • string

Felkoden.

details

Inre fel.

message
  • string

Felmeddelandet.

target
  • string

Felmålet.

DayDetails

Egenskaper för ett dagligt schema.

Name Type Description
time
  • string

Den tid på dagen som schemat inträffar.

EnableStatus

Status för schemat (t.ex. Aktiverad, Inaktiverad)

Name Type Description
Disabled
  • string
Enabled
  • string

HourDetails

Egenskaper för ett schema per timme.

Name Type Description
minute
  • integer

Minuter av timmen som schemat körs.

NotificationSettings

Meddelandeinställningar för ett schema.

Name Type Default Value Description
emailRecipient
  • string

E-postmottagaren att skicka meddelanden till (kan vara en lista med semikolonavgränsade e-postadresser).

notificationLocale
  • string

Språkvarianten som ska användas när du skickar ett meddelande (återställning för språk som inte stöds är EN).

status Disabled

Om meddelanden är aktiverade för det här schemat (t.ex. aktiverat, inaktiverat).

timeInMinutes
  • integer

Tid i minuter innan händelsen då meddelandet skickas.

webhookUrl
  • string

Den webhook-URL som meddelandet ska skickas till.

Schedule

Ett schema.

Name Type Default Value Description
id
  • string

Resursens identifierare.

location
  • string

Platsen för resursen.

name
  • string

Namnet på resursen.

properties.createdDate
  • string

Datumet då schemat skapades.

properties.dailyRecurrence

Om schemat ska ske en gång varje dag i veckan anger du den dagliga upprepningen.

properties.hourlyRecurrence

Om schemat ska ske flera gånger om dagen anger du upprepningen varje timme.

properties.notificationSettings

Meddelandeinställningar.

properties.provisioningState
  • string

Resursens etableringsstatus.

properties.status Disabled

Status för schemat (t.ex. Aktiverad, Inaktiverad)

properties.targetResourceId
  • string

Det resurs-ID som schemat tillhör

properties.taskType
  • string

Uppgiftstypen för schemat (t.ex. LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId
  • string

Tidszons-ID (t.ex. Pacific Standard-tid).

properties.uniqueIdentifier
  • string

Den unika oföränderliga identifieraren för en resurs (GUID).

properties.weeklyRecurrence

Om schemat bara inträffar några dagar i veckan anger du veckovis upprepning.

tags
  • object

Taggarna för resursen.

type
  • string

Resurstypen.

ScheduleList

Svaret för en liståtgärd.

Name Type Description
nextLink
  • string

Länk för nästa uppsättning resultat.

value

Resultat av liståtgärden.

WeekDetails

Egenskaper för ett veckoschema.

Name Type Description
time
  • string

Den tid på dagen som schemat inträffar.

weekdays
  • string[]

Veckodagarna som schemat anges för (t.ex. söndag, måndag, tisdag osv.).