Items - Update Dataflow Definition

서비스:: Dataflow

API 버전:: v1

지정된 데이터 흐름에 대한 정의를 재정의합니다.
이 API는 LRO(장기 실행 작업)지원합니다.

데이터 흐름의 정의를 업데이트해도 해당 민감도 레이블에는 영향을 주지 않습니다.

권한

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

필요한 위임된 범위

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

Microsoft Entra 지원 식별자

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

아이덴티티	지원
사용자	예
서비스 주체 및 관리 ID	예

인터페이스

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/updateDefinition

선택적 매개 변수:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/updateDefinition?updateMetadata={updateMetadata}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
dataflowId	path	True	string (uuid)	데이터 흐름 ID입니다.
workspaceId	path	True	string (uuid)	작업 영역 ID입니다.
updateMetadata	query		boolean	true로 설정하고 .platform 파일이 정의의 일부로 제공되면 .platform 파일의 메타데이터를 사용하여 항목의 메타데이터가 업데이트됩니다.

요청 본문

Name	필수	형식	Description
definition	True	DataflowDefinition	데이터 흐름 공용 정의 개체입니다. 데이터 흐름 정의의 구조에 대한 자세한 내용은 이 문서를 참조하세요.

응답

Name	형식	Description
200 OK		요청이 성공적으로 완료되었습니다.
202 Accepted		요청이 수락되었습니다. 업데이트 정의가 진행 중입니다. 헤더 Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	서비스 속도 제한을 초과했습니다. 서버는 클라이언트가 `Retry-After` 추가 요청을 보내기 전에 대기해야 하는 시간을 초 단위로 나타내는 헤더를 반환합니다. 헤더 Retry-After: integer
Other Status Codes	ErrorResponse	일반적인 오류 코드: OperationNotSupportedForItem - 요청된 항목에 대해 지원되지 않는 작업입니다. CorruptedPayload - 제공된 페이로드가 손상되었습니다.

예제

Update a Dataflow public definition example

샘플 요청

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataflows/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "queryMetadata.json",
        "payload": "ewogICJmb3JtYXRWZXJzaW9uIjogIjIwMjUwMiIsCiAgImNvbXB1dGVFbmdpbmVTZXR0aW5ncyI6IHt9LAogICJuYW1lIjogIlRlc3REYXRhZmxvdyIsCiAgInF1ZXJ5R3JvdXBzIjogW10sCiAgImRvY3VtZW50TG9jYWxlIjogImVuLVVTIiwKICAicXVlcmllc01ldGFkYXRhIjogewogICAgInF1ZXJ5IjogewogICAgICAicXVlcnlJZCI6ICJiZTE3MjEwZi01YWNhLTQyMWEtOGMwYS1iZjYzMTQ4N2JiOGUiLAogICAgICAicXVlcnlOYW1lIjogIlF1ZXJ5IgogICAgfQogIH0sCiAgImNvbm5lY3Rpb25zIjogW10KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "mashup.pq",
        "payload": "W1N0YWdpbmdEZWZpbml0aW9uID0gW0tpbmQgPSAiRmFzdENvcHkiXV0Kc2VjdGlvbiBTZWN0aW9uMTsKc2hhcmVkIFF1ZXJ5ID0gbGV0CiAgU291cmNlID0gVGFibGUuRnJvbVJvd3MoSnNvbi5Eb2N1bWVudChCaW5hcnkuRGVjb21wcmVzcyhCaW5hcnkuRnJvbVRleHQoImk0NVdNbFRTVVhMT3p5bk56VE9LUjdDTmdleFluV2dsSXlSWkl5UlpJNlhZV0FBPSIsIEJpbmFyeUVuY29kaW5nLkJhc2U2NCksIENvbXByZXNzaW9uLkRlZmxhdGUpKSwgbGV0IF90ID0gKCh0eXBlIG51bGxhYmxlIHRleHQpIG1ldGEgW1NlcmlhbGl6ZWQuVGV4dCA9IHRydWVdKSBpbiB0eXBlIHRhYmxlIFtDb2x1bW4xID0gX3QsIENvbHVtbjIgPSBfdCwgQ29sdW1uMyA9IF90XSksCiAgIyJDaGFuZ2VkIGNvbHVtbiB0eXBlIiA9IFRhYmxlLlRyYW5zZm9ybUNvbHVtblR5cGVzKFNvdXJjZSwge3siQ29sdW1uMSIsIEludDY0LlR5cGV9LCB7IkNvbHVtbjIiLCB0eXBlIHRleHR9LCB7IkNvbHVtbjMiLCB0eXBlIHRleHR9fSkKaW4KICAjIkNoYW5nZWQgY29sdW1uIHR5cGUiOwo=",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkRhdGFmbG93IiwKICAgICJkaXNwbGF5TmFtZSI6ICJUZXN0RGF0YWZsb3ciCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiZjU4ZDJmODMtYTMwMC1iMTM1LTQ3ODgtMDU5NjgzY2Q1NzFjIgogIH0KfQ==",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

샘플 응답

상태 코드:: 200

상태 코드:: 202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

정의

Name	Description
DataflowDefinition	데이터 흐름 공용 정의 개체입니다. 데이터 흐름 정의의 구조에 대한 자세한 내용은 이 문서를 참조하세요.
DataflowDefinitionPart	데이터 흐름 정의 파트 개체입니다.
ErrorRelatedResource	오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse	오류 응답입니다.
ErrorResponseDetails	오류 응답 세부 정보입니다.
PayloadType	정의 파트 페이로드의 형식입니다. 추가 페이로드 유형은 시간이 지남에 따라 추가될 수 있습니다.
UpdateDataflowDefinitionRequest	데이터 흐름 공용 정의 요청 페이로드를 업데이트합니다.

DataflowDefinition

Object

데이터 흐름 공용 정의 개체입니다. 데이터 흐름 정의의 구조에 대한 자세한 내용은 이 문서를 참조하세요.

Name	형식	Description
format	string	데이터 흐름 정의의 형식입니다.
parts	DataflowDefinitionPart[]	정의 부분 목록입니다.

DataflowDefinitionPart

Object

데이터 흐름 정의 파트 개체입니다.

Name	형식	Description
path	string	데이터 흐름 공용 정의 파트 경로입니다.
payload	string	데이터 흐름 공용 정의 파트 페이로드입니다.
payloadType	PayloadType	페이로드 형식입니다.

ErrorRelatedResource

Object

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

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

ErrorResponse

Object

오류 응답입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
isRetriable	boolean	true이면 요청을 다시 시도 할 수 있습니다. 응답 헤더를 `Retry-After` 사용하여 가능한 경우 지연을 확인합니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
moreDetails	ErrorResponseDetails[]	추가 오류 세부 정보 목록입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.
requestId	string (uuid)	오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

Object

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

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

PayloadType

열거형

정의 파트 페이로드의 형식입니다. 추가 페이로드 유형은 시간이 지남에 따라 추가될 수 있습니다.

값	Description
InlineBase64	인라인 베이스 64.

UpdateDataflowDefinitionRequest

Object

데이터 흐름 공용 정의 요청 페이로드를 업데이트합니다.

Name	형식	Description
definition	DataflowDefinition	데이터 흐름 공용 정의 개체입니다. 데이터 흐름 정의의 구조에 대한 자세한 내용은 이 문서를 참조하세요.