次の方法で共有


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

名前 / 必須 説明
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'

応答

名前 説明
200 OK

ScheduleList

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 にアクセスする

Schedules_List

要求のサンプル

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

応答のサンプル

{
  "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 要求からのエラー。

名前 説明
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

リソースの型。

ScheduleList

リスト操作の応答。

名前 説明
nextLink

string

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

value

Schedule[]

リスト操作の結果。

WeekDetails

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

名前 説明
time

string

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

weekdays

string[]

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