Delen via


Schedules - List

Schema's in een bepaald lab weergeven.

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-parameters

Name In Vereist Type Description
labName
path True

string

De naam van het lab.

resourceGroupName
path True

string

De naam van de resourcegroep.

subscriptionId
path True

string

De abonnements-id.

api-version
query True

string

Client-API-versie.

$expand
query

string

Geef de $expand query op. Voorbeeld: 'properties($select=status)'

$filter
query

string

Het filter dat moet worden toegepast op de bewerking. Voorbeeld: '$filter=contains(name,'myName')

$orderby
query

string

De volgorde-expressie voor de resultaten, met behulp van OData-notatie. Voorbeeld: '$orderby=name desc'

$top
query

integer

int32

Het maximum aantal resources dat door de bewerking moet worden geretourneerd. Voorbeeld: '$top=10'

Antwoorden

Name Type Description
200 OK

ScheduleList

OK

Other Status Codes

CloudError

BadRequest

Beveiliging

azure_auth

Impliciete OAuth2-toekenning

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Toegang tot Microsoft Azure

Voorbeelden

Schedules_List

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
CloudError

Fout van een REST-aanvraag.

CloudErrorBody

Hoofdtekst van een fout van een REST-aanvraag.

DayDetails

Eigenschappen van een dagelijkse planning.

EnableStatus

De status van de planning (ingeschakeld, uitgeschakeld)

HourDetails

Eigenschappen van een uurschema.

NotificationSettings

Meldingsinstellingen voor een planning.

Schedule

Een planning.

ScheduleList

Het antwoord van een lijstbewerking.

WeekDetails

Eigenschappen van een wekelijks schema.

CloudError

Fout van een REST-aanvraag.

Name Type Description
error

CloudErrorBody

De cloudfout die is opgetreden

CloudErrorBody

Hoofdtekst van een fout van een REST-aanvraag.

Name Type Description
code

string

De foutcode.

details

CloudErrorBody[]

Interne fouten.

message

string

Het foutbericht.

target

string

Het foutdoel.

DayDetails

Eigenschappen van een dagelijkse planning.

Name Type Description
time

string

Het tijdstip van de dag waarop de planning plaatsvindt.

EnableStatus

De status van de planning (ingeschakeld, uitgeschakeld)

Name Type Description
Disabled

string

Enabled

string

HourDetails

Eigenschappen van een uurschema.

Name Type Description
minute

integer

Minuten van het uur dat de planning wordt uitgevoerd.

NotificationSettings

Meldingsinstellingen voor een planning.

Name Type Default value Description
emailRecipient

string

De e-mailontvanger waarnaar meldingen moeten worden verzonden (dit kan een lijst zijn met door puntkomma's gescheiden e-mailadressen).

notificationLocale

string

De landinstelling die moet worden gebruikt bij het verzenden van een melding (terugval voor niet-ondersteunde talen is EN).

status

EnableStatus

Disabled

Als meldingen zijn ingeschakeld voor dit schema (bijvoorbeeld Ingeschakeld, Uitgeschakeld).

timeInMinutes

integer

Tijd in minuten vóór gebeurtenis waarop de melding wordt verzonden.

webhookUrl

string

De url van de webhook waarnaar de melding wordt verzonden.

Schedule

Een planning.

Name Type Default value Description
id

string

De id van de resource.

location

string

De locatie van de resource.

name

string

De naam van de resource.

properties.createdDate

string

De aanmaakdatum van de planning.

properties.dailyRecurrence

DayDetails

Als de planning eenmaal per dag van de week wordt uitgevoerd, geeft u het dagelijkse terugkeerpatroon op.

properties.hourlyRecurrence

HourDetails

Als de planning meerdere keren per dag wordt uitgevoerd, geeft u het terugkeerpatroon per uur op.

properties.notificationSettings

NotificationSettings

Instellingen voor meldingen.

properties.provisioningState

string

De inrichtingsstatus van de resource.

properties.status

EnableStatus

Disabled

De status van de planning (ingeschakeld, uitgeschakeld)

properties.targetResourceId

string

De resource-id waartoe de planning behoort

properties.taskType

string

Het taaktype van de planning (bijvoorbeeld LabVmsShutdownTask, LabVmAutoStart).

properties.timeZoneId

string

De tijdzone-id (bijvoorbeeld China (standaardtijd), Groenland (standaardtijd), Pacific (standaardtijd), enzovoort). De mogelijke waarden voor deze eigenschap vindt u in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)

properties.uniqueIdentifier

string

De unieke onveranderbare id van een resource (GUID).

properties.weeklyRecurrence

WeekDetails

Als de planning slechts enkele dagen van de week voorkomt, geeft u het wekelijkse terugkeerpatroon op.

tags

object

De tags van de resource.

type

string

Het type resource.

ScheduleList

Het antwoord van een lijstbewerking.

Name Type Description
nextLink

string

Koppeling voor de volgende set resultaten.

value

Schedule[]

Resultaten van de lijstbewerking.

WeekDetails

Eigenschappen van een wekelijks schema.

Name Type Description
time

string

Het tijdstip van de dag waarop de planning plaatsvindt.

weekdays

string[]

De dagen van de week waarvoor de planning is ingesteld (bijvoorbeeld zondag, maandag, dinsdag, enz.).