Items - Discover Dataflow Parameters

서비스:: Dataflow

API 버전:: v1

지정된 데이터 흐름에 정의된 모든 매개 변수를 검색합니다.

Permissions

호출자에게 데이터 흐름에 대한 읽기 권한이 있어야 합니다.

필요한 위임된 범위

Dataflow.Read.All 또는 Dataflow.ReadWrite.All 또는 Item.Read.All 또는 Item.ReadWrite.All

Microsoft Entra 지원 식별자

이 API는 이 섹션에 나열된 Microsoft ID 지원합니다.

아이덴티티	Support
사용자	Yes
서비스 주체 및 관리 ID	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 매개 변수

Name	In(다음 안에)	필수	형식	Description
dataflowId	path	True	string (uuid)	데이터 흐름 ID입니다.
workspaceId	path	True	string (uuid)	작업 영역 ID입니다.
continuationToken	query		string	결과의 다음 페이지를 검색하기 위한 토큰입니다.

응답

Name	형식	Description
200 OK	DataflowParameters	요청이 성공적으로 완료되었습니다.
Other Status Codes	ErrorResponse	일반적인 오류 코드: ItemNotFound - 요청된 항목을 찾을 수 없습니다. DataflowNotParametricError - 요청된 데이터 흐름이 매개 변수가 아닙니다.

Name

형식

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

정의

Name	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	문자열 형식의 데이터 흐름 매개 변수입니다.
DataflowTimeParameter	Time 형식의 데이터 흐름 매개 변수입니다. 형식 `HH:mm:ss` 의 문자열(예: `21:45:00` 오후 9시 45분). 데이터 흐름을 실행할 때 "자동" 형식을 사용하여 이 유형의 매개 변수를 재정의합니다.
ErrorRelatedResource	오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse	오류 응답입니다.
ErrorResponseDetails	오류 응답 세부 정보입니다.

DataflowBooleanParameter

Object

부울 형식의 데이터 흐름 매개 변수입니다.

Name	형식	Description
defaultValue	boolean	데이터 흐름을 실행할 때 매개 변수가 제공되지 않으면 매개 변수를 새로 고칠 값입니다.
description	string	매개 변수에 대한 설명입니다.
isRequired	boolean	매개 변수가 필요한지 여부를 나타냅니다.
name	string	매개 변수의 이름입니다.
type	string: Boolean	매개 변수의 형식입니다. 시간이 지남에 따라 추가 형식 형식을 추가할 수 있습니다.

DataflowDateParameter

Object

Date 형식의 데이터 흐름 매개 변수입니다. 형식 yyyy-MM-dd 의 문자열(예: 2025-09-15 2025년 9월 15일 날짜) 데이터 흐름을 실행할 때 "자동" 형식을 사용하여 이 유형의 매개 변수를 재정의합니다.

Name	형식	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)입니다.

Name	형식	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)입니다. 데이터 흐름을 실행할 때 "자동" 형식을 사용하여 이 유형의 매개 변수를 재정의합니다.

Name	형식	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초) 데이터 흐름을 실행할 때 "자동" 형식을 사용하여 이 유형의 매개 변수를 재정의합니다.

Name	형식	Description
defaultValue	string	데이터 흐름을 실행할 때 매개 변수가 제공되지 않으면 매개 변수를 새로 고칠 값입니다.
description	string	매개 변수에 대한 설명입니다.
isRequired	boolean	매개 변수가 필요한지 여부를 나타냅니다.
name	string	매개 변수의 이름입니다.
type	string: Duration	매개 변수의 형식입니다. 시간이 지남에 따라 추가 형식 형식을 추가할 수 있습니다.

DataflowIntegerParameter

Object

Long 형식의 데이터 흐름 매개 변수입니다.

Name	형식	Description
defaultValue	integer (int64)	데이터 흐름을 실행할 때 매개 변수가 제공되지 않으면 매개 변수를 새로 고칠 값입니다.
description	string	매개 변수에 대한 설명입니다.
isRequired	boolean	매개 변수가 필요한지 여부를 나타냅니다.
name	string	매개 변수의 이름입니다.
type	string: Integer	매개 변수의 형식입니다. 시간이 지남에 따라 추가 형식 형식을 추가할 수 있습니다.

DataflowNumberParameter

Object

double 형식의 데이터 흐름 매개 변수입니다.

Name	형식	Description
defaultValue	number (double)	데이터 흐름을 실행할 때 매개 변수가 제공되지 않으면 매개 변수를 새로 고칠 값입니다.
description	string	매개 변수에 대한 설명입니다.
isRequired	boolean	매개 변수가 필요한지 여부를 나타냅니다.
name	string	매개 변수의 이름입니다.
type	string: Number	매개 변수의 형식입니다. 시간이 지남에 따라 추가 형식 형식을 추가할 수 있습니다.

DataflowParameters

Object

데이터 흐름 매개 변수 목록입니다.

Name	형식	Description
continuationToken	string	다음 결과 집합 일괄 처리에 대한 토큰입니다. 레코드가 더 이상 없으면 응답에서 제거됩니다.
continuationUri	string	다음 결과 집합 일괄 처리의 URI입니다. 레코드가 더 이상 없으면 응답에서 제거됩니다.
value	DataflowParameter[]: DataflowBooleanParameter[] DataflowDateParameter[] DataflowDateTimeParameter[] DataflowDateTimeZoneParameter[] DataflowDurationParameter[] DataflowIntegerParameter[] DataflowNumberParameter[] DataflowStringParameter[] DataflowTimeParameter[]	데이터 흐름에 정의된 매개 변수 목록입니다.

DataflowStringParameter

Object

문자열 형식의 데이터 흐름 매개 변수입니다.

Name	형식	Description
defaultValue	string	데이터 흐름을 실행할 때 매개 변수가 제공되지 않으면 매개 변수를 새로 고칠 값입니다.
description	string	매개 변수에 대한 설명입니다.
isRequired	boolean	매개 변수가 필요한지 여부를 나타냅니다.
name	string	매개 변수의 이름입니다.
type	string: String	매개 변수의 형식입니다. 시간이 지남에 따라 추가 형식 형식을 추가할 수 있습니다.

DataflowTimeParameter

Object

Time 형식의 데이터 흐름 매개 변수입니다. 형식 HH:mm:ss 의 문자열(예: 21:45:00 오후 9시 45분). 데이터 흐름을 실행할 때 "자동" 형식을 사용하여 이 유형의 매개 변수를 재정의합니다.

Name	형식	Description
defaultValue	string	데이터 흐름을 실행할 때 매개 변수가 제공되지 않으면 매개 변수를 새로 고칠 값입니다.
description	string	매개 변수에 대한 설명입니다.
isRequired	boolean	매개 변수가 필요한지 여부를 나타냅니다.
name	string	매개 변수의 이름입니다.
type	string: Time	매개 변수의 형식입니다. 시간이 지남에 따라 추가 형식 형식을 추가할 수 있습니다.

ErrorRelatedResource

Object

오류 관련 리소스 세부 정보 개체입니다.

Name	형식	Description
resourceId	string	오류와 관련된 리소스 ID입니다.
resourceType	string	오류와 관련된 리소스의 형식입니다.

ErrorResponse

Object

오류 응답입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
moreDetails	ErrorResponseDetails[]	추가 오류 세부 정보 목록입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.
requestId	string	오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

Object

오류 응답 세부 정보입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.

다음을 통해 공유

Items - Discover Dataflow Parameters

Permissions

필요한 위임된 범위

Microsoft Entra 지원 식별자

인터페이스

URI 매개 변수

응답

예제

Get Dataflow Parameters example

샘플 요청

샘플 응답

정의

DataflowBooleanParameter

DataflowDateParameter

DataflowDateTimeParameter

DataflowDateTimeZoneParameter

DataflowDurationParameter

DataflowIntegerParameter

DataflowNumberParameter

DataflowParameters

DataflowStringParameter

DataflowTimeParameter

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails