Job Scheduler - Update Item Schedule

リファレンス

サービス:: Core

API バージョン:: v1

アイテムの既存のスケジュールを更新します。

必要な委任されたスコープ:

Item.Execute.All と Item.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

アイデンティティ	支援
ユーザー	イエス
サービスプリンシパルとマネージド ID	イエス

インターフェイス

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/{jobType}/schedules/{scheduleId}

URI パラメーター

名前	/	必須	型	説明
itemId	path	True	string (uuid)	アイテム ID。
jobType	path	True	string	ジョブの種類。
scheduleId	path	True	string (uuid)	品目スケジュール ID。
workspaceId	path	True	string (uuid)	ワークスペース ID。

要求本文

名前	必須	型	説明
configuration	True	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	実際のデータには、このスケジュールの時刻/平日が含まれます。
enabled	True	boolean	このスケジュールが有効かどうか。 True - 有効、False - 無効。

応答

名前	型	説明
200 OK	ItemSchedule	スケジュールを正常に更新しました。
Other Status Codes	ErrorResponse	一般的なエラーコード: InsufficientPrivileges - 呼び出し元にアイテムにアクセスするための十分なアクセス許可がありません ItemNotFound - 要求された項目 ID が見つかりません

名前

型

説明

200 OK

ItemSchedule

スケジュールを正常に更新しました。

Other Status Codes

ErrorResponse

一般的なエラーコード:

InsufficientPrivileges - 呼び出し元にアイテムにアクセスするための十分なアクセス許可がありません
ItemNotFound - 要求された項目 ID が見つかりません

例

update item schedule plan example

要求のサンプル

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/jobs/DefaultJob/schedules/3546052c-ae64-4526-b1a8-52af7761426f

{
  "enabled": true,
  "configuration": {
    "startDateTime": "2024-04-28T00:00:00",
    "endDateTime": "2024-04-30T23:59:00",
    "localTimeZoneId": "Central Standard Time",
    "type": "Cron",
    "interval": 10
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "enabled": true,
  "createdDateTime": "2024-04-28T05:35:20.5366667",
  "configuration": {
    "startDateTime": "2024-04-28T00:00:00",
    "endDateTime": "2024-04-30T23:59:00",
    "localTimeZoneId": "Central Standard Time",
    "type": "Cron",
    "interval": 10
  },
  "owner": {
    "id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
    "type": "User"
  }
}

定義

名前	説明
CronScheduleConfig
DailyScheduleConfig
DayOfWeek	平日の一覧 (最大 7 つの要素が許可されます)。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
GroupDetails	グループ固有の詳細。プリンシパルの種類が `Group`場合に適用されます。
GroupType	グループの種類。グループの種類は、時間の経過と同時に追加される場合があります。
ItemSchedule	アイテムのスケジュール。
Principal	ID または Microsoft Entra グループを表します。
PrincipalType	プリンシパルの型。プリンシパルの種類は、時間の経過と同時に追加される場合があります。
ServicePrincipalDetails	サービスプリンシパル固有の詳細。プリンシパルの種類が `ServicePrincipal`場合に適用されます。
ServicePrincipalProfileDetails	サービスプリンシパルプロファイルの詳細。プリンシパルの種類が `ServicePrincipalProfile`場合に適用されます。
UpdateScheduleRequest	アイテムスケジュールプラン要求ペイロードを更新します。
UserDetails	ユーザープリンシパル固有の詳細。プリンシパルの種類が `User`場合に適用されます。
WeeklyScheduleConfig

CronScheduleConfig

Object

名前	型	説明
endDateTime	string (date-time)	このスケジュールの終了時刻。終了時刻は開始時刻より後にする必要があります。 YYYY-MM-DDTHH:mm:ssZ 形式を使用して UTC にする必要があります。
interval	integer (int32) minimum: 1 maximum: 5270400	分単位の時間間隔。 1 ~ 5270400 (10 年) の数値。
localTimeZoneId	string	Windows のローカルコンピューター上のタイムゾーン識別子レジストリについては、「既定のタイムゾーン参照してください。
startDateTime	string (date-time)	このスケジュールの開始時刻。開始時刻が過去の場合は、すぐにジョブがトリガーされます。時刻は UTC で、YYYY-MM-DDTHH:mm:ssZ 形式を使用します。
type	string: Cron	文字列はプランの種類を表します。追加の planType 型は、時間の経過と同時に追加される場合があります。

DailyScheduleConfig

Object

名前	型	説明
endDateTime	string (date-time)	このスケジュールの終了時刻。終了時刻は開始時刻より後にする必要があります。 YYYY-MM-DDTHH:mm:ssZ 形式を使用して UTC にする必要があります。
localTimeZoneId	string	Windows のローカルコンピューター上のタイムゾーン識別子レジストリについては、「既定のタイムゾーン参照してください。
startDateTime	string (date-time)	このスケジュールの開始時刻。開始時刻が過去の場合は、すぐにジョブがトリガーされます。時刻は UTC で、YYYY-MM-DDTHH:mm:ssZ 形式を使用します。
times	string[]	hh:mm 形式のタイムスロットの一覧 (最大 100 個の要素) が許可されます。
type	string: Daily	文字列はプランの種類を表します。追加の planType 型は、時間の経過と同時に追加される場合があります。

DayOfWeek

列挙

平日の一覧 (最大 7 つの要素が許可されます)。

値	説明
Friday	金曜日
Monday	月曜日
Saturday	土曜日
Sunday	日曜日
Thursday	木曜日
Tuesday	火曜日
Wednesday	水曜日

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前	型	説明
resourceId	string	エラーに関係するリソース ID。
resourceType	string	エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

GroupDetails

Object

グループ固有の詳細。プリンシパルの種類が Group場合に適用されます。

名前	型	説明
groupType	GroupType	グループの種類。グループの種類は、時間の経過と同時に追加される場合があります。

GroupType

列挙

グループの種類。グループの種類は、時間の経過と同時に追加される場合があります。

値	説明
DistributionList	プリンシパルは配布リストです。
SecurityGroup	プリンシパルはセキュリティグループです。
Unknown	プリンシパルグループの種類が不明です。

ItemSchedule

Object

アイテムのスケジュール。

名前	型	説明
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	実際のデータには、このスケジュールの時刻/平日が含まれます。
createdDateTime	string (date-time)	YYYY-MM-DDTHH:mm:ssZ 形式を使用して、このスケジュールの作成されたタイムスタンプ (UTC)。
enabled	boolean	このスケジュールが有効かどうか。 True - 有効、False - 無効。
id	string (uuid)	スケジュール ID。
owner	Principal	このスケジュールまたは最終変更を作成したユーザー ID。

Principal

Object

ID または Microsoft Entra グループを表します。

名前	型	説明
displayName	string	プリンシパルの表示名。
groupDetails	GroupDetails	グループ固有の詳細。プリンシパルの種類が `Group`場合に適用されます。
id	string (uuid)	プリンシパルの ID。
servicePrincipalDetails	ServicePrincipalDetails	サービスプリンシパル固有の詳細。プリンシパルの種類が `ServicePrincipal`場合に適用されます。
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	サービスプリンシパルプロファイルの詳細。プリンシパルの種類が `ServicePrincipalProfile`場合に適用されます。
type	PrincipalType	プリンシパルの型。プリンシパルの種類は、時間の経過と同時に追加される場合があります。
userDetails	UserDetails	ユーザープリンシパル固有の詳細。プリンシパルの種類が `User`場合に適用されます。

PrincipalType

列挙

プリンシパルの型。プリンシパルの種類は、時間の経過と同時に追加される場合があります。

値	説明
Group	プリンシパルはセキュリティグループです。
ServicePrincipal	プリンシパルは Microsoft Entra サービスプリンシパルです。
ServicePrincipalProfile	プリンシパルはサービスプリンシパルプロファイルです。
User	プリンシパルは Microsoft Entra ユーザープリンシパルです。

ServicePrincipalDetails

Object

サービスプリンシパル固有の詳細。プリンシパルの種類が ServicePrincipal場合に適用されます。

名前	型	説明
aadAppId	string (uuid)	サービスプリンシパルの Microsoft Entra AppId。

ServicePrincipalProfileDetails

Object

サービスプリンシパルプロファイルの詳細。プリンシパルの種類が ServicePrincipalProfile場合に適用されます。

名前	型	説明
parentPrincipal	Principal	サービスプリンシパルプロファイルの親プリンシパル。

UpdateScheduleRequest

Object

アイテムスケジュールプラン要求ペイロードを更新します。

名前	型	説明
configuration	ScheduleConfig: CronScheduleConfig DailyScheduleConfig WeeklyScheduleConfig	実際のデータには、このスケジュールの時刻/平日が含まれます。
enabled	boolean	このスケジュールが有効かどうか。 True - 有効、False - 無効。

UserDetails

Object

ユーザープリンシパル固有の詳細。プリンシパルの種類が User場合に適用されます。

名前	型	説明
userPrincipalName	string	ユーザープリンシパル名。

WeeklyScheduleConfig

Object

名前	型	説明
endDateTime	string (date-time)	このスケジュールの終了時刻。終了時刻は開始時刻より後にする必要があります。 YYYY-MM-DDTHH:mm:ssZ 形式を使用して UTC にする必要があります。
localTimeZoneId	string	Windows のローカルコンピューター上のタイムゾーン識別子レジストリについては、「既定のタイムゾーン参照してください。
startDateTime	string (date-time)	このスケジュールの開始時刻。開始時刻が過去の場合は、すぐにジョブがトリガーされます。時刻は UTC で、YYYY-MM-DDTHH:mm:ssZ 形式を使用します。
times	string[]	hh:mm 形式のタイムスロットの一覧 (最大 100 個の要素) が許可されます。
type	string: Weekly	文字列はプランの種類を表します。追加の planType 型は、時間の経過と同時に追加される場合があります。
weekdays	DayOfWeek[]	平日の一覧 (最大 7 つの要素が許可されます)。

次の方法で共有

Job Scheduler - Update Item Schedule

必要な委任されたスコープ:

Microsoft Entra でサポートされている ID

インターフェイス

URI パラメーター

要求本文

応答

例

update item schedule plan example

要求のサンプル

応答のサンプル

定義

CronScheduleConfig

DailyScheduleConfig

DayOfWeek

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

ItemSchedule

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UpdateScheduleRequest

UserDetails

WeeklyScheduleConfig