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	LabVirtualMachine の名前
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	ApplicableSchedule	Azure 操作は正常に完了しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

VirtualMachines_ListApplicableSchedules

要求のサンプル

HTTP

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

定義

名前	説明
ApplicableSchedule	仮想マシンに適用できるスケジュール。スケジュールは、VM またはラボレベルで定義されている可能性があります。
DayDetails	毎日のスケジュールのプロパティ。
EnableStatus	成果物ソースが有効になっているかどうかを示します (値: 有効、無効)。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
HourDetails	1 時間ごとのスケジュールのプロパティ。
NotificationSettings	スケジュールの通知設定。
Schedule	スケジュール。
WeekDetails	週単位のスケジュールのプロパティ。

ApplicableSchedule

Object

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

名前	型	説明
id	string	リソースの識別子。
___location	string	リソースの場所。
name	string	リソースの名前。
properties.labVmsShutdown	Schedule	自動シャットダウンスケジュール (ラボまたはラボリソースレベルで設定されている場合)。
properties.labVmsStartup	Schedule	自動起動スケジュール (ラボまたはラボリソースレベルで設定されている場合)。
tags	object	リソースのタグ。
type	string	リソースの種類。

DayDetails

Object

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

名前	型	説明
time	string	スケジュールが発生する時刻。

EnableStatus

列挙

成果物ソースが有効になっているかどうかを示します (値: 有効、無効)。

値	説明
Enabled
Disabled

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

HourDetails

Object

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

名前	型	説明
minute	integer (int32)	スケジュールが実行される時間の分数。

NotificationSettings

Object

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

名前	型	規定値	説明
emailRecipient	string		通知を送信する電子メール受信者 (セミコロンで区切られた電子メールアドレスの一覧を指定できます)。
notificationLocale	string		通知を送信するときに使用するロケール (サポートされていない言語のフォールバックは EN です)。
status	EnableStatus	Disabled	このスケジュールに対して通知が有効になっている場合 (つまり、有効、無効)。
timeInMinutes	integer (int32)		通知が送信されるイベントの前の時間 (分)。
webhookUrl	string		通知の送信先となる Webhook URL。

Schedule

Object

スケジュール。

名前	型	規定値	説明
id	string		リソースの識別子。
___location	string		リソースの場所。
name	string		リソースの名前。
properties.createdDate	string (date-time)		スケジュールの作成日。
properties.dailyRecurrence	DayDetails		スケジュールが週の各日に 1 回行われる場合は、毎日の繰り返しを指定します。
properties.hourlyRecurrence	HourDetails		スケジュールが 1 日に複数回発生する場合は、1 時間ごとに繰り返しを指定します。
properties.notificationSettings	NotificationSettings		通知の設定。
properties.provisioningState	string		リソースのプロビジョニング状態。
properties.status	EnableStatus	Disabled	スケジュールの状態 (有効、無効)
properties.targetResourceId	string		スケジュールが属するリソース ID
properties.taskType	string		スケジュールのタスクの種類 (LabVmsShutdownTask、LabVmAutoStart など)。
properties.timeZoneId	string		タイムゾーン ID (中国標準時、グリーンランド標準時、太平洋標準時など)。このプロパティに指定できる値は、`IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) にあります。
properties.uniqueIdentifier	string		リソースの一意の変更できない識別子 (Guid)。
properties.weeklyRecurrence	WeekDetails		スケジュールが週の数日だけ発生する場合は、週単位の繰り返しを指定します。
tags	object		リソースのタグ。
type	string		リソースの種類。

WeekDetails

Object

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

名前	型	説明
time	string	スケジュールが発生する時刻。
weekdays	string[]	スケジュールが設定されている曜日 (日曜日、月曜日、火曜日など)。

次の方法で共有

Virtual Machines - List Applicable Schedules

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

VirtualMachines_ListApplicableSchedules

要求のサンプル

応答のサンプル

定義

ApplicableSchedule

DayDetails

EnableStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HourDetails

NotificationSettings

Schedule

WeekDetails