次の方法で共有

Virtual Machines - List Applicable Schedules

  • リファレンス
サービス:
Dev Test Labs
API バージョン:
2018-09-15

存在する場合は、該当する開始/停止のスケジュールを一覧表示します。

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

URI パラメーター

名前 / 必須 型 説明
labName
 path True

string

ラボの名前。
name
 path True

string

仮想マシンの名前。
resourceGroupName
 path True

string

リソース グループの名前。
subscriptionId
 path True

string

サブスクリプション ID です。
api-version
 query True

string

クライアント API バージョン。

応答

名前 型 説明
200 OK

ApplicableSchedule

OK
Other Status Codes

CloudError

BadRequest

セキュリティ

azure_auth

OAuth2 暗黙的な許可

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation Microsoft Azure にアクセスする

例

VirtualMachines_ListApplicableSchedules

要求のサンプル

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

応答のサンプル

状態コード:
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}"
    }
  }
}

定義

名前 説明
ApplicableSchedule

仮想マシンに適用できるスケジュール。 スケジュールは、VM またはラボ レベルで定義されている可能性があります。
CloudError

REST 要求からのエラー。
CloudErrorBody

REST 要求からのエラーの本文。
DayDetails

毎日のスケジュールのプロパティ。
EnableStatus

スケジュールの状態 (有効、無効)
HourDetails

1 時間ごとのスケジュールのプロパティ。
NotificationSettings

スケジュールの通知設定。
Schedule

スケジュール。
WeekDetails

毎週のスケジュールのプロパティ。

ApplicableSchedule

仮想マシンに適用できるスケジュール。 スケジュールは、VM またはラボ レベルで定義されている可能性があります。

名前 型 説明
id

string

リソースの識別子。
location

string

リソースの場所。
name

string

リソースの名前。
properties.labVmsShutdown

Schedule

自動シャットダウン スケジュール (ラボまたはラボ リソース レベルで設定されている場合)。
properties.labVmsStartup

Schedule

自動起動スケジュール (ラボまたはラボ リソース レベルで設定されている場合)。
tags

object

リソースのタグ。
type

string

リソースの型。

CloudError

REST 要求からのエラー。

名前 型 説明
error

CloudErrorBody

発生したクラウド エラー

CloudErrorBody

REST 要求からのエラーの本文。

名前 型 説明
code

string

エラー コード。
details

CloudErrorBody[]

内部エラー。
message

string

エラー メッセージ。
target

string

エラーのターゲット。

DayDetails

毎日のスケジュールのプロパティ。

名前 型 説明
time

string

スケジュールが発生する時刻。

EnableStatus

スケジュールの状態 (有効、無効)

名前 型 説明
Disabled

string

Enabled

string

HourDetails

1 時間ごとのスケジュールのプロパティ。

名前 型 説明
minute

integer

スケジュールが実行される時間の分数。

NotificationSettings

スケジュールの通知設定。

名前 型 規定値 説明
emailRecipient

string

通知を送信するメール受信者 (セミコロンで区切られたメール アドレスの一覧を指定できます)。
notificationLocale

string

通知を送信するときに使用するロケール (サポートされていない言語のフォールバックは EN)。
status

EnableStatus

Disabled

このスケジュールに対して通知が有効になっている場合 (つまり、有効、無効)。
timeInMinutes

integer

通知が送信されるイベントの前の時間 (分)。
webhookUrl

string

通知の送信先となる Webhook URL。

Schedule

スケジュール。

名前 型 規定値 説明
id

string

リソースの識別子。
location

string

リソースの場所。
name

string

リソースの名前。
properties.createdDate

string

スケジュールの作成日。
properties.dailyRecurrence

DayDetails

スケジュールが週の各日に 1 回行われる場合は、毎日の繰り返しを指定します。
properties.hourlyRecurrence

HourDetails

スケジュールが 1 日に複数回発生する場合は、時間単位の繰り返しを指定します。
properties.notificationSettings

NotificationSettings

通知設定。
properties.provisioningState

string

リソースのプロビジョニング状態。
properties.status

EnableStatus

Disabled

スケジュールの状態 (有効、無効)
properties.targetResourceId

string

スケジュールが属するリソース ID
properties.taskType

string

スケジュールのタスクの種類 (LabVmsShutdownTask、LabVmAutoStart など)。
properties.timeZoneId

string

タイム ゾーン ID (中国標準時、グリーンランド標準時、太平洋標準時など)。 このプロパティに使用できる値は、 (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) にありますIReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds
properties.uniqueIdentifier

string

リソースの一意の不変識別子 (Guid)。
properties.weeklyRecurrence

WeekDetails

スケジュールが週の数日だけ発生する場合は、週単位の繰り返しを指定します。
tags

object

リソースのタグ。
type

string

リソースの型。

WeekDetails

毎週のスケジュールのプロパティ。

名前 型 説明
time

string

スケジュールが発生する時刻。
weekdays

string[]

スケジュールが設定されている曜日 (日曜日、月曜日、火曜日など)。