Schedules - List

特定のラボのスケジュールを一覧表示します。

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 パラメーター

Name In Required Type Description
labName
path True
  • string

ラボの名前。

resourceGroupName
path True
  • string

リソース グループの名前。

subscriptionId
path True
  • string

サブスクリプション ID です。

api-version
query True
  • string

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

$expand
query
  • string

クエリの$expand指定します。 例: 'properties($select=status)'

$filter
query
  • string

操作に適用するフィルター。 例: '$filter=contains(name,'myName')

$orderby
query
  • string

OData 表記を使用した結果の順序付け式。 例: '$orderby=name desc'

$top
query
  • integer
int32

操作から返されるリソースの最大数。 例: '$top=10'

応答

Name Type Description
200 OK

OK

Other Status Codes

BadRequest

セキュリティ

azure_auth

OAuth2 暗黙的な許可

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

Scopes

Name Description
user_impersonation アクセス Microsoft Azure

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

定義

CloudError

REST 要求からのエラー。

CloudErrorBody

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

DayDetails

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

EnableStatus

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

HourDetails

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

NotificationSettings

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

Schedule

スケジュール。

ScheduleList

リスト操作の応答。

WeekDetails

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

CloudError

REST 要求からのエラー。

Name Type Description
error

発生したクラウド エラー

CloudErrorBody

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

Name Type Description
code
  • string

エラー コード。

details

内部エラー。

message
  • string

エラー メッセージ。

target
  • string

エラー ターゲット。

DayDetails

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

Name Type Description
time
  • string

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

EnableStatus

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

Name Type Description
Disabled
  • string
Enabled
  • string

HourDetails

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

Name Type Description
minute
  • integer

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

NotificationSettings

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

Name Type Description
emailRecipient
  • string

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

notificationLocale
  • string

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

status

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

timeInMinutes
  • integer

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

webhookUrl
  • string

通知の送信先の Webhook URL。

Schedule

スケジュール。

Name Type Description
id
  • string

リソースの識別子。

location
  • string

リソースの場所。

name
  • string

リソースの名前。

properties.createdDate
  • string

スケジュールの作成日。

properties.dailyRecurrence

スケジュールが毎日 1 回実行される場合は、毎日の繰り返しを指定します。

properties.hourlyRecurrence

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

properties.notificationSettings

通知設定。

properties.provisioningState
  • string

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

properties.status

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

properties.targetResourceId
  • string

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

properties.taskType
  • string

スケジュールのタスクの種類 (例: LabVmsShutdownTask、LabVmAutoStart)。

properties.timeZoneId
  • string

タイム ゾーン ID (太平洋標準時など)。

properties.uniqueIdentifier
  • string

リソースの一意の変更できない識別子 (Guid)。

properties.weeklyRecurrence

スケジュールが週の一部の日だけ行われる場合は、週単位の繰り返しを指定します。

tags
  • object

リソースのタグ。

type
  • string

リソースの型。

ScheduleList

リスト操作の応答。

Name Type Description
nextLink
  • string

次の結果セットのリンク。

value

リスト操作の結果。

WeekDetails

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

Name Type Description
time
  • string

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

weekdays
  • string[]

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