通过

Job Scheduler - Create Item Schedule

  • 参考
服务:
Core
API 版本:
v1

为项创建新计划。 项目可以创建最多 20 个计划程序。

所需的委托范围：

Item.Execute.All 和 Item.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份 支持
用户 是的
服务主体 和 托管标识 不

接口

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

URI 参数

名称 在 必需 类型 说明
itemId
 path True

string

uuid

项 ID。
jobType
 path True

string

作业类型。
workspaceId
 path True

string

uuid

工作区 ID。

请求正文

名称 必需 类型 说明
configuration True ScheduleConfig:

实际数据包含此计划的时间/工作日。
enabled True

boolean

是否启用此计划。 True - Enabled、False - Disabled。

响应

名称 类型 说明
201 Created

ItemSchedule

成功创建计划。

标头

Location: string
Other Status Codes

ErrorResponse

常见错误代码：

  • InsufficientPrivileges - 调用方没有足够的权限访问项

  • ItemNotFound - 找不到请求的项目 ID

  • ScheduleExceedsLimit - 项目创建的计划数超过限制

示例

create item schedule example

示例请求

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/jobs/DefaultJob/schedules

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

示例响应

状态代码:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/cfafbeb1-8037-4d0c-896e-a46fb27ff229/jobs/DefaultJob/schedules/235faf08-6ca0-488d-a2ca-6d706d530ebc
{
  "id": "235faf08-6ca0-488d-a2ca-6d706d530ebc",
  "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"
  }
}

定义

名称 说明
CreateScheduleRequest

创建项计划计划计划请求有效负载。
CronScheduleConfig
DailyScheduleConfig
DayOfWeek

允许使用工作日列表，最多允许七个元素。
ErrorRelatedResource

与错误相关的资源详细信息对象。
ErrorResponse

错误响应。
ErrorResponseDetails

错误响应详细信息。
GroupDetails

组特定详细信息。 当主体类型 Group时适用。
GroupType

组的类型。 可能会随着时间的推移添加其他组类型。
ItemSchedule

项计划。
Principal

表示标识或Microsoft Entra 组。
PrincipalType

主体的类型。 可能会随着时间的推移添加其他主体类型。
ServicePrincipalDetails

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
ServicePrincipalProfileDetails

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
UserDetails

用户主体特定详细信息。 当主体类型 User时适用。
WeeklyScheduleConfig

CreateScheduleRequest

Object

创建项计划计划计划请求有效负载。

名称 类型 说明
configuration ScheduleConfig:

实际数据包含此计划的时间/工作日。
enabled

boolean

是否启用此计划。 True - Enabled、False - Disabled。

CronScheduleConfig

Object
名称 类型 说明
endDateTime

string

date-time

此计划的结束时间。 结束时间必须晚于开始时间。
interval

integer

int32

时间间隔（以分钟为单位）。 介于 1 到 5270400（10 年）之间的数字。
localTimeZoneId

string

windows 本地计算机上的时区标识符注册表，请参阅 默认时区
startDateTime

string

date-time

此计划的开始时间。 如果开始时间过去，它将立即触发作业。
type string:

Cron

字符串表示计划的类型。 可能会随着时间的推移添加其他 planType 类型。

DailyScheduleConfig

Object
名称 类型 说明
endDateTime

string

date-time

此计划的结束时间。 结束时间必须晚于开始时间。
localTimeZoneId

string

windows 本地计算机上的时区标识符注册表，请参阅 默认时区
startDateTime

string

date-time

此计划的开始时间。 如果开始时间过去，它将立即触发作业。
times

string[]

hh：mm 格式的时间段列表，最多允许 100 个元素。
type string:

Daily

字符串表示计划的类型。 可能会随着时间的推移添加其他 planType 类型。

DayOfWeek

Enumeration

允许使用工作日列表，最多允许七个元素。

值 说明
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

Enumeration

组的类型。 可能会随着时间的推移添加其他组类型。

值 说明
DistributionList

主体是通讯组列表。
SecurityGroup

主体是安全组。
Unknown

主体组类型未知。

ItemSchedule

Object

项计划。

名称 类型 说明
configuration ScheduleConfig:

实际数据包含此计划的时间/工作日。
createdDateTime

string

date-time

此计划的创建时间戳（以 Utc 为单位）。
enabled

boolean

是否启用此计划。 True - Enabled、False - Disabled。
id

string

uuid

计划 ID。
owner

Principal

创建此计划或上次修改的用户标识。

Principal

Object

表示标识或Microsoft Entra 组。

名称 类型 说明
displayName

string

主体的显示名称。
groupDetails

GroupDetails

组特定详细信息。 当主体类型 Group时适用。
id

string

uuid

主体的 ID。
servicePrincipalDetails

ServicePrincipalDetails

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
type

PrincipalType

主体的类型。 可能会随着时间的推移添加其他主体类型。
userDetails

UserDetails

用户主体特定详细信息。 当主体类型 User时适用。

PrincipalType

Enumeration

主体的类型。 可能会随着时间的推移添加其他主体类型。

值 说明
Group

主体是安全组。
ServicePrincipal

主体是Microsoft Entra 服务主体。
ServicePrincipalProfile

主体是服务主体配置文件。
User

主体是Microsoft Entra 用户主体。

ServicePrincipalDetails

Object

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。

名称 类型 说明
aadAppId

string

uuid

服务主体的 Microsoft Entra AppId。

ServicePrincipalProfileDetails

Object

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。

名称 类型 说明
parentPrincipal

Principal

服务主体配置文件的父主体。

UserDetails

Object

用户主体特定详细信息。 当主体类型 User时适用。

名称 类型 说明
userPrincipalName

string

用户主体名称。

WeeklyScheduleConfig

Object
名称 类型 说明
endDateTime

string

date-time

此计划的结束时间。 结束时间必须晚于开始时间。
localTimeZoneId

string

windows 本地计算机上的时区标识符注册表，请参阅 默认时区
startDateTime

string

date-time

此计划的开始时间。 如果开始时间过去，它将立即触发作业。
times

string[]

hh：mm 格式的时间段列表，最多允许 100 个元素。
type string:

Weekly

字符串表示计划的类型。 可能会随着时间的推移添加其他 planType 类型。
weekdays

DayOfWeek[]

允许使用工作日列表，最多允许七个元素。