Job Scheduler - List Item Schedules
必要的委派範圍
針對專案 API,請使用下列範圍類型:
- 泛型範圍:Item.ReadWrite.All 或 Item.Read.All
- 特定範圍:itemType。ReadWrite.All 或 itemType。Read.All (例如:Notebook.ReadWrite.All)
如需範圍的詳細資訊,請參閱 範圍一文。
Microsoft Entra 支援的身分識別
此 API 支援本節中列出的Microsoft 身分識別。
身份 | 支援 |
---|---|
使用者 | 是的 |
服務主體 和 受控識別 | 不 |
介面
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/{jobType}/schedules
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/jobs/{jobType}/schedules?continuationToken={continuationToken}
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
item
|
path | True |
string uuid |
項目標識碼。 |
job
|
path | True |
string |
作業類型。 |
workspace
|
path | True |
string uuid |
工作區標識碼。 |
continuation
|
query |
string |
用來擷取下一頁結果的令牌。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
已成功擷取所有專案排程。 |
|
Other Status Codes |
常見的錯誤碼:
|
範例
List item schedules example
範例要求
GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items/3546052c-ae64-4526-b1a8-52af7761426f/jobs/DefaultJob/schedules
範例回覆
{
"value": [
{
"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"
}
},
{
"id": "96f3f0ff-4fe2-4712-b61b-05a456ba9357",
"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": "Weekly",
"weekdays": [
"Monday",
"Tuesday"
],
"times": [
"18:09",
"17:12"
]
},
"owner": {
"id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
"type": "User"
}
},
{
"id": "c0ed1d27-32dc-49e6-90ba-cac9b6248c7f",
"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": "Daily",
"times": [
"18:09",
"17:12"
]
},
"owner": {
"id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
"type": "User"
}
}
]
}
定義
名稱 | Description |
---|---|
Cron |
|
Daily |
|
Day |
工作日清單,最多允許七個元素。 |
Error |
錯誤相關的資源詳細資料物件。 |
Error |
錯誤回應。 |
Error |
錯誤回應詳細數據。 |
Group |
群組特定詳細數據。 當主體類型 |
Group |
群組的類型。 可能會隨著時間新增其他群組類型。 |
Item |
專案排程。 |
Item |
此專案的排程清單。 |
Principal |
代表身分識別或Microsoft Entra 群組。 |
Principal |
主體的類型。 可能會隨著時間新增其他主體類型。 |
Service |
服務主體特定詳細數據。 當主體類型 |
Service |
服務主體配置檔詳細數據。 當主體類型 |
User |
用戶主體特定詳細數據。 當主體類型 |
Weekly |
CronScheduleConfig
名稱 | 類型 | Description |
---|---|---|
endDateTime |
string date-time |
此排程的結束時間。 結束時間必須晚於開始時間。 |
interval |
integer int32 |
以分鐘為單位的時間間隔。 介於 1 到 5270400 (10 年) 之間的數位。 |
localTimeZoneId |
string |
Windows 本機電腦上的時區標識元登錄,請參閱 預設時區 |
startDateTime |
string date-time |
此排程的開始時間。 如果開始時間過去,它會立即觸發作業。 |
type |
string:
Cron |
字串表示計劃的型別。 可能會隨著時間新增其他 planType 類型。 |
DailyScheduleConfig
名稱 | 類型 | Description |
---|---|---|
endDateTime |
string date-time |
此排程的結束時間。 結束時間必須晚於開始時間。 |
localTimeZoneId |
string |
Windows 本機電腦上的時區標識元登錄,請參閱 預設時區 |
startDateTime |
string date-time |
此排程的開始時間。 如果開始時間過去,它會立即觸發作業。 |
times |
string[] |
hh:mm 格式的時段清單,最多允許 100 個專案。 |
type |
string:
Daily |
字串表示計劃的型別。 可能會隨著時間新增其他 planType 類型。 |
DayOfWeek
工作日清單,最多允許七個元素。
值 | Description |
---|---|
Friday |
星期五 |
Monday |
星期一 |
Saturday |
星期六 |
Sunday |
星期日 |
Thursday |
星期四 |
Tuesday |
星期二 |
Wednesday |
星期三 |
ErrorRelatedResource
錯誤相關的資源詳細資料物件。
名稱 | 類型 | Description |
---|---|---|
resourceId |
string |
發生錯誤的資源識別碼。 |
resourceType |
string |
發生錯誤的資源類型。 |
ErrorResponse
錯誤回應。
名稱 | 類型 | Description |
---|---|---|
errorCode |
string |
提供錯誤狀況相關信息的特定標識碼,允許服務與其使用者之間的標準化通訊。 |
message |
string |
錯誤的人類可讀取表示法。 |
moreDetails |
其他錯誤詳細數據的清單。 |
|
relatedResource |
錯誤相關的資源詳細數據。 |
|
requestId |
string |
與錯誤相關聯的要求標識碼。 |
ErrorResponseDetails
錯誤回應詳細數據。
名稱 | 類型 | Description |
---|---|---|
errorCode |
string |
提供錯誤狀況相關信息的特定標識碼,允許服務與其使用者之間的標準化通訊。 |
message |
string |
錯誤的人類可讀取表示法。 |
relatedResource |
錯誤相關的資源詳細數據。 |
GroupDetails
群組特定詳細數據。 當主體類型 Group
時適用。
名稱 | 類型 | Description |
---|---|---|
groupType |
群組的類型。 可能會隨著時間新增其他群組類型。 |
GroupType
群組的類型。 可能會隨著時間新增其他群組類型。
值 | Description |
---|---|
DistributionList |
主體是通訊組清單。 |
SecurityGroup |
主體是安全組。 |
Unknown |
主體群組類型未知。 |
ItemSchedule
專案排程。
名稱 | 類型 | Description |
---|---|---|
configuration | ScheduleConfig: |
實際數據報含此排程的時間/工作日。 |
createdDateTime |
string date-time |
此排程的建立時間戳為 Utc。 |
enabled |
boolean |
是否啟用此排程。 True - Enabled、False - Disabled。 |
id |
string uuid |
排程標識碼。 |
owner |
建立此排程或上次修改的使用者身分識別。 |
ItemSchedules
此專案的排程清單。
名稱 | 類型 | Description |
---|---|---|
continuationToken |
string |
下一個結果集批次的令牌。 如果沒有其他記錄,則會從回應中移除。 |
continuationUri |
string |
下一個結果集批次的 URI。 如果沒有其他記錄,則會從回應中移除。 |
value |
此專案的排程清單。 |
Principal
代表身分識別或Microsoft Entra 群組。
名稱 | 類型 | Description |
---|---|---|
displayName |
string |
主體的顯示名稱。 |
groupDetails |
群組特定詳細數據。 當主體類型 |
|
id |
string uuid |
主體的標識碼。 |
servicePrincipalDetails |
服務主體特定詳細數據。 當主體類型 |
|
servicePrincipalProfileDetails |
服務主體配置檔詳細數據。 當主體類型 |
|
type |
主體的類型。 可能會隨著時間新增其他主體類型。 |
|
userDetails |
用戶主體特定詳細數據。 當主體類型 |
PrincipalType
主體的類型。 可能會隨著時間新增其他主體類型。
值 | Description |
---|---|
Group |
主體是安全組。 |
ServicePrincipal |
主體是Microsoft Entra 服務主體。 |
ServicePrincipalProfile |
主體是服務主體配置檔。 |
User |
主體是 entra 用戶主體Microsoft。 |
ServicePrincipalDetails
服務主體特定詳細數據。 當主體類型 ServicePrincipal
時適用。
名稱 | 類型 | Description |
---|---|---|
aadAppId |
string uuid |
服務主體的 Microsoft Entra AppId。 |
ServicePrincipalProfileDetails
服務主體配置檔詳細數據。 當主體類型 ServicePrincipalProfile
時適用。
名稱 | 類型 | Description |
---|---|---|
parentPrincipal |
服務主體配置檔的父主體。 |
UserDetails
用戶主體特定詳細數據。 當主體類型 User
時適用。
名稱 | 類型 | Description |
---|---|---|
userPrincipalName |
string |
用戶主體名稱。 |
WeeklyScheduleConfig
名稱 | 類型 | Description |
---|---|---|
endDateTime |
string date-time |
此排程的結束時間。 結束時間必須晚於開始時間。 |
localTimeZoneId |
string |
Windows 本機電腦上的時區標識元登錄,請參閱 預設時區 |
startDateTime |
string date-time |
此排程的開始時間。 如果開始時間過去,它會立即觸發作業。 |
times |
string[] |
hh:mm 格式的時段清單,最多允許 100 個專案。 |
type |
string:
Weekly |
字串表示計劃的型別。 可能會隨著時間新增其他 planType 類型。 |
weekdays |
工作日清單,最多允許七個元素。 |