แชร์ผ่าน

Items - Get Data Pipeline Definition

บริการ:
DataPipeline
เวอร์ชัน API:
v1

ส่งกลับข้อกําหนดสาธารณะของไปป์ไลน์ข้อมูลที่ระบุ
API นี้สนับสนุน การดําเนินการที่ใช้เวลานาน (LRO)

เมื่อคุณได้รับคําจํากัดความสาธารณะของ DataPipeline ป้ายชื่อระดับความลับไม่ได้เป็นส่วนหนึ่งของข้อกําหนด

สิทธิ์

ผู้เรียกต้องมีสิทธิ์ ในการอ่านและเขียน สําหรับไปป์ไลน์ข้อมูล

จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์

DataPipeline.ReadWrite.All หรือ Item.ReadWrite.All

ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra

API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้

เอกลักษณ์ สนับสนุน
ผู้ใช้ ใช่
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ ใช่

อิน เทอร์ เฟซ

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/getDefinition
ด้วยพารามิเตอร์ที่เลือกได้: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataPipelines/{dataPipelineId}/getDefinition?format={format}

พารามิเตอร์ URI

ชื่อ ใน จำเป็น พิมพ์ คำอธิบาย
dataPipelineId
 path True

string (uuid)

ID ไปป์ไลน์ข้อมูล
workspaceId
 path True

string (uuid)

ID พื้นที่ทํางาน
format
 query

string

รูปแบบของข้อกําหนดสาธารณะของไปป์ไลน์ข้อมูล

การตอบสนอง

ชื่อ พิมพ์ คำอธิบาย
200 OK

DataPipelineDefinitionResponse

คําขอเสร็จสมบูรณ์
202 Accepted

คําขอได้รับการยอมรับ กําลังดําเนินการเรียกข้อกําหนด

ส่วนหัว

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

รหัสข้อผิดพลาดทั่วไป:

  • OperationNotSupportedForItem - การดําเนินการไม่ได้รับการสนับสนุนสําหรับรายการที่ร้องขอ

ตัวอย่าง

Get a data pipeline public definition example

คำขอตัวอย่าง

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/dataPipelines/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

คำตอบตัวอย่าง

รหัสสถานะ:
200 
{
  "definition": {
    "parts": [
      {
        "path": "pipeline-content.json",
        "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbXQogIH0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
รหัสสถานะ:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

คำจำกัดความ

ชื่อ คำอธิบาย
DataPipelineDefinition

ออบเจ็กต์นิยามสาธารณะของไปป์ไลน์ข้อมูล
DataPipelineDefinitionPart

ออบเจ็กต์ส่วนของข้อกําหนดไปป์ไลน์ข้อมูล
DataPipelineDefinitionResponse

การตอบสนองข้อกําหนดสาธารณะของไปป์ไลน์ข้อมูล
ErrorRelatedResource

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse

การตอบสนองข้อผิดพลาด
ErrorResponseDetails

รายละเอียดการตอบสนองข้อผิดพลาด
PayloadType

ชนิดของส่วนข้อกําหนดส่วนข้อมูล อาจมีการเพิ่มชนิดของส่วนข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป

DataPipelineDefinition

ออบเจ็กต์

ออบเจ็กต์นิยามสาธารณะของไปป์ไลน์ข้อมูล

ชื่อ พิมพ์ คำอธิบาย
format

string

รูปแบบของข้อกําหนดหน่วยข้อมูล
parts

DataPipelineDefinitionPart[]

รายการของส่วนข้อกําหนด

DataPipelineDefinitionPart

ออบเจ็กต์

ออบเจ็กต์ส่วนของข้อกําหนดไปป์ไลน์ข้อมูล

ชื่อ พิมพ์ คำอธิบาย
path

string

เส้นทางส่วนของไปป์ไลน์ข้อมูล
payload

string

ส่วนข้อมูลของไปป์ไลน์ส่วน
payloadType

PayloadType

ชนิดของส่วนข้อมูล

DataPipelineDefinitionResponse

ออบเจ็กต์

การตอบสนองข้อกําหนดสาธารณะของไปป์ไลน์ข้อมูล

ชื่อ พิมพ์ คำอธิบาย
definition

DataPipelineDefinition

ออบเจ็กต์นิยามสาธารณะของไปป์ไลน์ข้อมูล

ErrorRelatedResource

ออบเจ็กต์

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
resourceId

string

ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType

string

ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

ออบเจ็กต์

การตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails

ErrorResponseDetails[]

รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId

string

รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

ออบเจ็กต์

รายละเอียดการตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

PayloadType

การแจงนับ

ชนิดของส่วนข้อกําหนดส่วนข้อมูล อาจมีการเพิ่มชนิดของส่วนข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป

ค่า คำอธิบาย
InlineBase64

ฐานแบบอินไลน์ 64