Service Fabrics - List Applicable Schedules
存在する場合は、該当する開始/停止のスケジュールを一覧表示します。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}/listApplicableSchedules?api-version=2018-09-15
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
lab
|
path | True |
string |
ラボの名前。 |
name
|
path | True |
string |
サービス ファブリックの名前。 |
resource
|
path | True |
string |
リソース グループの名前。 |
subscription
|
path | True |
string |
サブスクリプション ID です。 |
user
|
path | True |
string |
ユーザー プロファイルの名前。 |
api-version
|
query | True |
string |
クライアント API バージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
BadRequest |
セキュリティ
azure_auth
OAuth2 暗黙的な許可
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | Microsoft Azure にアクセスする |
例
ServiceFabrics_ListApplicableSchedules
要求のサンプル
応答のサンプル
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{scheduleName}",
"location": "{location}",
"name": "{scheduleName}",
"properties": {
"labVmsShutdown": {
"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"
}
},
"labVmsStartup": {
"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"
}
}
},
"type": "{scheduleType}",
"tags": {
"tagName1": "tagValue1"
}
}
定義
名前 | 説明 |
---|---|
Applicable |
仮想マシンに適用できるスケジュール。 スケジュールは、VM またはラボ レベルで定義されている可能性があります。 |
Cloud |
REST 要求からのエラー。 |
Cloud |
REST 要求からのエラーの本文。 |
Day |
毎日のスケジュールのプロパティ。 |
Enable |
スケジュールの状態 (有効、無効) |
Hour |
1 時間ごとのスケジュールのプロパティ。 |
Notification |
スケジュールの通知設定。 |
Schedule |
スケジュール。 |
Week |
週単位のスケジュールのプロパティ。 |
ApplicableSchedule
仮想マシンに適用できるスケジュール。 スケジュールは、VM またはラボ レベルで定義されている可能性があります。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの識別子。 |
location |
string |
リソースの場所。 |
name |
string |
リソースの名前。 |
properties.labVmsShutdown |
自動シャットダウン スケジュール (ラボまたはラボ リソース レベルで設定されている場合)。 |
|
properties.labVmsStartup |
自動起動スケジュール (ラボまたはラボ リソース レベルで設定されている場合)。 |
|
tags |
object |
リソースのタグ。 |
type |
string |
リソースの型。 |
CloudError
REST 要求からのエラー。
名前 | 型 | 説明 |
---|---|---|
error |
発生したクラウド エラー |
CloudErrorBody
REST 要求からのエラーの本文。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
details |
内部エラー。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
DayDetails
毎日のスケジュールのプロパティ。
名前 | 型 | 説明 |
---|---|---|
time |
string |
スケジュールが発生する時刻。 |
EnableStatus
スケジュールの状態 (有効、無効)
名前 | 型 | 説明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
HourDetails
1 時間ごとのスケジュールのプロパティ。
名前 | 型 | 説明 |
---|---|---|
minute |
integer |
スケジュールが実行される時間の分数。 |
NotificationSettings
スケジュールの通知設定。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
emailRecipient |
string |
通知を送信する電子メール受信者 (セミコロンで区切られた電子メール アドレスの一覧を指定できます)。 |
|
notificationLocale |
string |
通知を送信するときに使用するロケール (サポートされていない言語のフォールバックは EN です)。 |
|
status | Disabled |
このスケジュールに対して通知が有効になっている場合 (つまり、有効、無効)。 |
|
timeInMinutes |
integer |
通知が送信されるイベントの前の時間 (分)。 |
|
webhookUrl |
string |
通知の送信先となる Webhook URL。 |
Schedule
スケジュール。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
id |
string |
リソースの識別子。 |
|
location |
string |
リソースの場所。 |
|
name |
string |
リソースの名前。 |
|
properties.createdDate |
string |
スケジュールの作成日。 |
|
properties.dailyRecurrence |
スケジュールが曜日ごとに 1 回発生する場合は、毎日の繰り返しを指定します。 |
||
properties.hourlyRecurrence |
スケジュールが 1 日に複数回発生する場合は、時間単位の繰り返しを指定します。 |
||
properties.notificationSettings |
通知設定。 |
||
properties.provisioningState |
string |
リソースのプロビジョニング状態。 |
|
properties.status | Disabled |
スケジュールの状態 (有効、無効) |
|
properties.targetResourceId |
string |
スケジュールが属するリソース ID |
|
properties.taskType |
string |
スケジュールのタスクの種類 (LabVmsShutdownTask、LabVmAutoStart など)。 |
|
properties.timeZoneId |
string |
タイム ゾーン ID (中国標準時、グリーンランド標準時、太平洋標準時など)。 このプロパティで使用できる値は、 (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) にあります |
|
properties.uniqueIdentifier |
string |
リソースの一意の不変識別子 (Guid)。 |
|
properties.weeklyRecurrence |
スケジュールが週の数日だけ発生する場合は、週単位の繰り返しを指定します。 |
||
tags |
object |
リソースのタグ。 |
|
type |
string |
リソースの型。 |
WeekDetails
週単位のスケジュールのプロパティ。
名前 | 型 | 説明 |
---|---|---|
time |
string |
スケジュールが発生する時刻。 |
weekdays |
string[] |
スケジュールが設定されている曜日 (日曜日、月曜日、火曜日など)。 |