Items - Discover Dataflow Parameters

服務:: Dataflow

API 版本:: v1

擷取指定資料流程中定義的所有引數。

權限

呼叫端必須具有資料流的讀取許可權。

必要的委派範圍

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

Microsoft Entra 支援的身份識別

此 API 支援本節中列出的Microsoft 身分識別。

身份	Support
User	Yes
服務主體和受控識別	Yes

介面

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 參數

名稱	位於	必要	類型	Description
dataflowId	path	True	string (uuid)	資料流程ID。
workspaceId	path	True	string (uuid)	工作區識別碼。
continuationToken	query		string	用來擷取下一頁結果的令牌。

回應

名稱	類型	Description
200 OK	DataflowParameters	請求已成功完成。
Other Status Codes	ErrorResponse	常見的錯誤碼： ItemNotFound - 找不到要求的專案 DataflowNotParametricError - 要求的資料流程不是參數化的

名稱

類型

Description

200 OK

DataflowParameters

請求已成功完成。

Other Status Codes

ErrorResponse

常見的錯誤碼：

ItemNotFound - 找不到要求的專案
DataflowNotParametricError - 要求的資料流程不是參數化的

範例

Get Dataflow Parameters example

範例要求

HTTP

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"
    }
  ]
}

定義

名稱	Description
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	類型為 Duration 的資料流程參數。格式 `\Pd\DTH\Hm\Ms\S` 中的字串（例如： `P5DT14H35M30S` 5 天 14 小時 35 分 30 秒）。使用「自動」型別，在執行資料流程時覆寫此型別的引數。
DataflowIntegerParameter	類型為 Long 的資料流程參數。
DataflowNumberParameter	類型為 double 的資料流程參數。
DataflowParameters	資料流程參數清單。
DataflowStringParameter	類型為 String 的資料流程參數。
DataflowTimeParameter	類型為 Time 的資料流程參數。格式 `HH:mm:ss` 中的字串（例如： `21:45:00` 晚上 9：45）。使用「自動」型別，在執行資料流程時覆寫此型別的引數。
ErrorRelatedResource	錯誤相關的資源詳細資料物件。
ErrorResponse	錯誤回應。
ErrorResponseDetails	錯誤回應詳細數據。

DataflowBooleanParameter

Object

布林類型的資料流程參數。

名稱	類型	Description
defaultValue	boolean	如果執行資料流程時未提供任何參數，則會重新整理參數的值。
description	string	參數的描述。
isRequired	boolean	指出參數是否為必要。
name	string	參數的名稱。
type	string: Boolean	參數的類型。隨著時間的推移，可能會添加其他類型類型。

DataflowDateParameter

Object

Date型別的資料流程引數。格式 yyyy-MM-dd 中的字串（例如： 2025-09-15 日期 2025 年 9 月 15 日）。使用「自動」型別，在執行資料流程時覆寫此型別的引數。

名稱	類型	Description
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）。

名稱	類型	Description
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）。使用「自動」型別，在執行資料流程時覆寫此型別的引數。

名稱	類型	Description
defaultValue	string	如果執行資料流程時未提供任何參數，則會重新整理參數的值。
description	string	參數的描述。
isRequired	boolean	指出參數是否為必要。
name	string	參數的名稱。
type	string: DateTimeZone	參數的類型。隨著時間的推移，可能會添加其他類型類型。

DataflowDurationParameter

Object

類型為 Duration 的資料流程參數。格式 \Pd\DTH\Hm\Ms\S 中的字串（例如： P5DT14H35M30S 5 天 14 小時 35 分 30 秒）。使用「自動」型別，在執行資料流程時覆寫此型別的引數。

名稱	類型	Description
defaultValue	string	如果執行資料流程時未提供任何參數，則會重新整理參數的值。
description	string	參數的描述。
isRequired	boolean	指出參數是否為必要。
name	string	參數的名稱。
type	string: Duration	參數的類型。隨著時間的推移，可能會添加其他類型類型。

DataflowIntegerParameter

Object

類型為 Long 的資料流程參數。

名稱	類型	Description
defaultValue	integer (int64)	如果執行資料流程時未提供任何參數，則會重新整理參數的值。
description	string	參數的描述。
isRequired	boolean	指出參數是否為必要。
name	string	參數的名稱。
type	string: Integer	參數的類型。隨著時間的推移，可能會添加其他類型類型。

DataflowNumberParameter

Object

類型為 double 的資料流程參數。

名稱	類型	Description
defaultValue	number (double)	如果執行資料流程時未提供任何參數，則會重新整理參數的值。
description	string	參數的描述。
isRequired	boolean	指出參數是否為必要。
name	string	參數的名稱。
type	string: Number	參數的類型。隨著時間的推移，可能會添加其他類型類型。

DataflowParameters

Object

資料流程參數清單。

名稱	類型	Description
continuationToken	string	下一個結果集批次的令牌。如果沒有其他記錄，則會從回應中移除。
continuationUri	string	下一個結果集批次的 URI。如果沒有其他記錄，則會從回應中移除。
value	DataflowParameter[]: DataflowBooleanParameter[] DataflowDateParameter[] DataflowDateTimeParameter[] DataflowDateTimeZoneParameter[] DataflowDurationParameter[] DataflowIntegerParameter[] DataflowNumberParameter[] DataflowStringParameter[] DataflowTimeParameter[]	資料流中定義的引數清單。

DataflowStringParameter

Object

類型為 String 的資料流程參數。

名稱	類型	Description
defaultValue	string	如果執行資料流時未提供任何引數，則會重新整理引數的值。
description	string	參數的描述。
isRequired	boolean	指出參數是否為必要。
name	string	參數的名稱。
type	string: String	參數的類型。隨著時間的推移，可能會添加其他類型類型。

DataflowTimeParameter

Object

類型為 Time 的資料流程參數。格式 HH:mm:ss 中的字串（例如： 21:45:00 晚上 9：45）。使用「自動」型別，在執行資料流程時覆寫此型別的引數。

名稱	類型	Description
defaultValue	string	如果執行資料流程時未提供任何參數，則會重新整理參數的值。
description	string	參數的描述。
isRequired	boolean	指出參數是否為必要。
name	string	參數的名稱。
type	string: Time	參數的類型。隨著時間的推移，可能會添加其他類型類型。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱	類型	Description
resourceId	string	發生錯誤的資源識別碼。
resourceType	string	發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
moreDetails	ErrorResponseDetails[]	其他錯誤詳細數據的清單。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。
requestId	string	與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。

共用方式為

Items - Discover Dataflow Parameters

權限

必要的委派範圍

Microsoft Entra 支援的身份識別

介面

URI 參數

回應

範例

Get Dataflow Parameters example

範例要求

範例回覆

定義

DataflowBooleanParameter

DataflowDateParameter

DataflowDateTimeParameter

DataflowDateTimeZoneParameter

DataflowDurationParameter

DataflowIntegerParameter

DataflowNumberParameter

DataflowParameters

DataflowStringParameter

DataflowTimeParameter

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails