Virtual Machines - List Applicable Schedules

  • Referentie
Service:
Dev Test Labs
API Version:
2018-09-15

Lijsten de toepasselijke start-/stopschema's, indien van toepassing.

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

URI-parameters

Name In Vereist Type Description
labName
 path True

string

De naam van het lab.
name
 path True

string

De naam van de virtuele machine.
resourceGroupName
 path True

string

De naam van de resourcegroep.
subscriptionId
 path True

string

De abonnements-id.
api-version
 query True

string

Client-API-versie.

Antwoorden

Name Type Description
200 OK

ApplicableSchedule

OK
Other Status Codes

CloudError

BadRequest

Beveiliging

azure_auth

Impliciete OAuth2-toekenning

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

Scopes

Name Description
user_impersonation Toegang tot Microsoft Azure

Voorbeelden

VirtualMachines_ListApplicableSchedules

Sample Request

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

Sample Response

Status code:
200 
{
  "properties": {
    "labVmsShutdown": {
      "properties": {
        "status": "Enabled",
        "taskType": "LabVmsShutdownTask",
        "weeklyRecurrence": {
          "weekdays": [
            "Friday",
            "Saturday",
            "Sunday"
          ],
          "time": "1700"
        },
        "dailyRecurrence": {
          "time": "1900"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "timeZoneId": "Pacific Standard Time",
        "notificationSettings": {
          "status": "Enabled",
          "timeInMinutes": 30,
          "webhookUrl": "{webhookUrl}",
          "emailRecipient": "{email}",
          "notificationLocale": "EN"
        },
        "createdDate": "2020-12-29T21:48:14.1369355+00:00",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}",
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "4acf0408-1c10-49cb-96b7-28ce655c8320"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/myAutoShutdownSchedule",
      "name": "LabVmsShutdown",
      "type": "Microsoft.DevTestLab/labs/virtualMachines/schedules",
      "location": "{location}"
    },
    "labVmsStartup": {
      "properties": {
        "status": "Enabled",
        "taskType": "LabVmsStartupTask",
        "weeklyRecurrence": {
          "weekdays": [
            "Friday",
            "Saturday",
            "Sunday"
          ],
          "time": "1000"
        },
        "dailyRecurrence": {
          "time": "0900"
        },
        "hourlyRecurrence": {
          "minute": 30
        },
        "timeZoneId": "Pacific Standard Time",
        "notificationSettings": {
          "status": "Enabled",
          "timeInMinutes": 30,
          "webhookUrl": "{webhookUrl}",
          "emailRecipient": "{email}",
          "notificationLocale": "EN"
        },
        "createdDate": "2020-12-29T21:46:37.0473976+00:00",
        "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}",
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/myAutoStartSchedule",
      "name": "LabVmAutoStart",
      "type": "Microsoft.DevTestLab/labs/virtualMachines/schedules",
      "location": "{location}"
    }
  }
}

Definities

Name Description
ApplicableSchedule

Schema's die van toepassing zijn op een virtuele machine. De planningen kunnen zijn gedefinieerd op een VM of op labniveau.
CloudError

Fout van een REST-aanvraag.
CloudErrorBody

Hoofdtekst van een fout van een REST-aanvraag.
DayDetails

Eigenschappen van een dagelijks schema.
EnableStatus

De status van de planning (ingeschakeld, uitgeschakeld)
HourDetails

Eigenschappen van een uurschema.
NotificationSettings

Meldingsinstellingen voor een planning.
Schedule

Een planning.
WeekDetails

Eigenschappen van een wekelijks schema.

ApplicableSchedule

Schema's die van toepassing zijn op een virtuele machine. De planningen kunnen zijn gedefinieerd op een VM of op labniveau.

Name Type Description
id

string

De id van de resource.
location

string

De locatie van de resource.
name

string

De naam van de resource.
properties.labVmsShutdown

Schedule

De planning voor automatisch afsluiten, als deze is ingesteld op het niveau van het lab of de labresource.
properties.labVmsStartup

Schedule

Het schema voor automatisch opstarten, als deze is ingesteld op het niveau van het lab of de labresource.
tags

object

De tags van de resource.
type

string

Het type resource.

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 dagelijks schema.

Name Type Description
time

string

Het tijdstip van de dag waarop de planning wordt uitgevoerd.

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 het schema wordt uitgevoerd.

NotificationSettings

Meldingsinstellingen voor een planning.

Name Type Standaardwaarde Description
emailRecipient

string

De e-mailontvanger waarnaar u meldingen wilt verzenden (dit kan een lijst met door puntkomma's gescheiden e-mailadressen zijn).
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 de gebeurtenis waarop de melding wordt verzonden.
webhookUrl

string

De url van de webhook waarnaar de melding wordt verzonden.

Schedule

Een planning.

Name Type Standaardwaarde 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 wordt uitgevoerd, geeft u het wekelijkse terugkeerpatroon op.
tags

object

De tags van de resource.
type

string

Het type resource.

WeekDetails

Eigenschappen van een wekelijks schema.

Name Type Description
time

string

Het tijdstip van de dag waarop de planning wordt uitgevoerd.
weekdays

string[]

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