通过

Items - Discover Dataflow Parameters

服务:
Dataflow
API 版本:
v1

检索指定数据流中定义的所有参数。

Permissions

调用方必须具有数据流的 读取 权限。

所需的委派范围

Dataflow.Read.All 或 Dataflow.ReadWrite.All 或 Item.Read.All 或 Item.ReadWrite.All

Microsoft Entra 支持的标识

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

身份 Support
用户 是的
服务主体和托管标识 是的

接口

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/parameters
具有可选参数: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/parameters?continuationToken={continuationToken}

URI 参数

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

string (uuid)

数据流 ID。
workspaceId
 path True

string (uuid)

工作区 ID。
continuationToken
 query

string

用于检索下一页结果的令牌。

响应

名称 类型 说明
200 OK

DataflowParameters

请求成功完成。
Other Status Codes

ErrorResponse

常见错误代码：

  • ItemNotFound - 找不到请求的项目

  • DataflowNotParametricError - 请求的数据流不是参数数据流

示例

Get Dataflow Parameters example

示例请求

GET https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/dataflows/dddddddd-9999-0000-1111-eeeeeeeeeeee/parameters

示例响应

状态代码:
200 
{
  "value": [
    {
      "name": "manufacturer",
      "isRequired": true,
      "description": "Manufacturer of the item",
      "type": "String",
      "defaultValue": "test-value"
    },
    {
      "name": "isImported",
      "isRequired": false,
      "description": "Is the item imported",
      "type": "Boolean",
      "defaultValue": true
    },
    {
      "name": "quantity",
      "isRequired": false,
      "description": "Quantity of item",
      "type": "Integer",
      "defaultValue": 123456789
    },
    {
      "name": "weightThreshold",
      "isRequired": true,
      "description": "Weight threshold for item",
      "type": "Number",
      "defaultValue": 3.14
    },
    {
      "name": "datetimeOfOrder",
      "isRequired": true,
      "description": "Datetime of order",
      "type": "DateTime",
      "defaultValue": "2025-09-15T21:45:00.000Z"
    },
    {
      "name": "datetimeZoneOfOrder",
      "isRequired": true,
      "description": "DatetimeZone of order",
      "type": "DateTimeZone",
      "defaultValue": "2025-09-15T21:45:00+02:00"
    },
    {
      "name": "dateOfImport",
      "isRequired": true,
      "description": "Date of import",
      "type": "Date",
      "defaultValue": "2025-09-15"
    },
    {
      "name": "timeOfImport",
      "isRequired": true,
      "description": "Time of import",
      "type": "Time",
      "defaultValue": "21:45:00"
    },
    {
      "name": "durationOfImport",
      "isRequired": true,
      "description": "Duration of import",
      "type": "Duration",
      "defaultValue": "P5DT21H35M30S"
    }
  ]
}

定义

名称 说明
DataflowBooleanParameter

布尔类型的数据流参数。
DataflowDateParameter

Date 类型的数据流参数。 格式 yyyy-MM-dd 的字符串（例如： 2025-09-15 2025 年 9 月 15 日日期）。 执行数据流时，使用“自动”类型替代这种类型的参数。
DataflowDateTimeParameter

DateTime 类型的数据流参数。 格式 yyyy-MM-ddTHH:mm:ss.xxxZ 的字符串 （示例： 2025-09-15T21:45:00.000Z） 。
DataflowDateTimeZoneParameter

DateTimeZone 类型的数据流参数。 格式 yyyy-MM-ddTHH:mm:sszzz 的字符串 （示例： 2025-09-15T21:45:00+02:00） 。 执行数据流时，使用“自动”类型替代这种类型的参数。
DataflowDurationParameter

持续时间类型的数据流参数。 格式 \Pd\DTH\Hm\Ms\S 的字符串（例如： P5DT14H35M30S 5 天、14 小时、35 分 30 秒）。 执行数据流时，使用“自动”类型替代这种类型的参数。
DataflowIntegerParameter

Long 类型的数据流参数。
DataflowNumberParameter

双精度类型的数据流参数。
DataflowParameters

数据流参数的列表。
DataflowStringParameter

String 类型的数据流参数。
DataflowTimeParameter

Time 类型的数据流参数。 格式 HH:mm:ss 的字符串（例如： 21:45:00 晚上 9：45）。 执行数据流时，使用“自动”类型替代这种类型的参数。
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。

DataflowBooleanParameter

Object

布尔类型的数据流参数。

名称 类型 说明
defaultValue

boolean

如果在执行数据流时未提供参数，则参数将刷新的值。
description

string

参数的说明。
isRequired

boolean

指示参数是否是必需的。
name

string

参数的名称。
type string:

Boolean

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

DataflowDateParameter

Object

Date 类型的数据流参数。 格式 yyyy-MM-dd 的字符串（例如： 2025-09-15 2025 年 9 月 15 日日期）。 执行数据流时，使用“自动”类型替代这种类型的参数。

名称 类型 说明
defaultValue

string

如果在执行数据流时未提供参数，则参数将刷新的值。
description

string

参数的说明。
isRequired

boolean

指示参数是否是必需的。
name

string

参数的名称。
type string:

Date

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

DataflowDateTimeParameter

Object

DateTime 类型的数据流参数。 格式 yyyy-MM-ddTHH:mm:ss.xxxZ 的字符串 （示例： 2025-09-15T21:45:00.000Z） 。

名称 类型 说明
defaultValue

string (date-time)

如果在执行数据流时未提供参数，则参数将刷新的值。
description

string

参数的说明。
isRequired

boolean

指示参数是否是必需的。
name

string

参数的名称。
type string:

DateTime

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

DataflowDateTimeZoneParameter

Object

DateTimeZone 类型的数据流参数。 格式 yyyy-MM-ddTHH:mm:sszzz 的字符串 （示例： 2025-09-15T21:45:00+02:00） 。 执行数据流时，使用“自动”类型替代这种类型的参数。

名称 类型 说明
defaultValue

string

如果在执行数据流时未提供参数，则参数将刷新的值。
description

string

参数的说明。
isRequired

boolean

指示参数是否是必需的。
name

string

参数的名称。
type string:

DateTimeZone

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

DataflowDurationParameter

Object

持续时间类型的数据流参数。 格式 \Pd\DTH\Hm\Ms\S 的字符串（例如： P5DT14H35M30S 5 天、14 小时、35 分 30 秒）。 执行数据流时，使用“自动”类型替代这种类型的参数。

名称 类型 说明
defaultValue

string

如果在执行数据流时未提供参数，则参数将刷新的值。
description

string

参数的说明。
isRequired

boolean

指示参数是否是必需的。
name

string

参数的名称。
type string:

Duration

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

DataflowIntegerParameter

Object

Long 类型的数据流参数。

名称 类型 说明
defaultValue

integer (int64)

如果在执行数据流时未提供参数，则参数将刷新的值。
description

string

参数的说明。
isRequired

boolean

指示参数是否是必需的。
name

string

参数的名称。
type string:

Integer

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

DataflowNumberParameter

Object

双精度类型的数据流参数。

名称 类型 说明
defaultValue

number (double)

如果在执行数据流时未提供参数，则参数将刷新的值。
description

string

参数的说明。
isRequired

boolean

指示参数是否是必需的。
name

string

参数的名称。
type string:

Number

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

DataflowParameters

Object

数据流参数的列表。

名称 类型 说明
continuationToken

string

下一个结果集批处理的令牌。 如果没有更多记录，则会从响应中删除该记录。
continuationUri

string

下一个结果集批处理的 URI。 如果没有更多记录，则会从响应中删除该记录。
value DataflowParameter[]:

数据流中定义的参数列表。

DataflowStringParameter

Object

String 类型的数据流参数。

名称 类型 说明
defaultValue

string

如果在执行数据流时未提供参数，则参数将刷新的值。
description

string

参数的说明。
isRequired

boolean

指示参数是否是必需的。
name

string

参数的名称。
type string:

String

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

DataflowTimeParameter

Object

Time 类型的数据流参数。 格式 HH:mm:ss 的字符串（例如： 21:45:00 晚上 9：45）。 执行数据流时，使用“自动”类型替代这种类型的参数。

名称 类型 说明
defaultValue

string

如果在执行数据流时未提供参数，则参数将刷新的值。
description

string

参数的说明。
isRequired

boolean

指示参数是否是必需的。
name

string

参数的名称。
type string:

Time

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

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

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