แชร์ผ่าน

Items - Get Eventstream Definition

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

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

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

สิทธิ์

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

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

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

ข้อจำกัด

API นี้ถูกบล็อกสําหรับเหตุการณ์สตรีมที่มีป้ายชื่อระดับความลับที่เข้ารหัสลับไว้

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

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

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

อิน เทอร์ เฟซ

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

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

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

string (uuid)

ID เหตุการณ์
workspaceId
 path True

string (uuid)

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

string

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

การตอบสนอง

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

EventstreamDefinitionResponse

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

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

ส่วนหัว

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

ErrorResponse

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

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

ตัวอย่าง

Get an eventstream definition example

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

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

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

รหัสสถานะ:
200 
{
  "definition": {
    "parts": [
      {
        "path": "eventstream.json",
        "payload": "SSdkIGxpa2UgdG8gdGVsbCBh..IGpva2UgZm9yIHlvdS4K",
        "payloadType": "InlineBase64"
      },
      {
        "path": "eventstreamProperties.json",
        "payload": "ewogICJyZXRlbnRpb25UaW1l..V2ZWwiOiAiTG93Igp9",
        "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

คำจำกัดความ

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

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

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

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

ออบเจ็กต์ข้อกําหนดสาธารณะของเหตุการณ์
EventstreamDefinitionPart

ออบเจ็กต์ส่วนของข้อกําหนดเหตุการณ์
EventstreamDefinitionResponse

การตอบสนองข้อกําหนดสาธารณะของเหตุการณ์
PayloadType

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

ErrorRelatedResource

ออบเจ็กต์

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

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

string

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

string

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

ErrorResponse

ออบเจ็กต์

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

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

string

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

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string

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

ErrorResponseDetails

ออบเจ็กต์

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

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

string

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

string

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

ErrorRelatedResource

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

EventstreamDefinition

ออบเจ็กต์

ออบเจ็กต์ข้อกําหนดสาธารณะของเหตุการณ์

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

string

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

EventstreamDefinitionPart[]

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

EventstreamDefinitionPart

ออบเจ็กต์

ออบเจ็กต์ส่วนของข้อกําหนดเหตุการณ์

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

string

เส้นทางของส่วนเหตุการณ์
payload

string

ส่วนเหตุการณ์กระแสข้อมูล
payloadType

PayloadType

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

EventstreamDefinitionResponse

ออบเจ็กต์

การตอบสนองข้อกําหนดสาธารณะของเหตุการณ์

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

EventstreamDefinition

ออบเจ็กต์ข้อกําหนดสาธารณะของเหตุการณ์

PayloadType

การแจงนับ

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

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

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