Items - Get Eventstream Definition

Layanan:: Eventstream

Versi API:: v1

Mengembalikan definisi publik eventstream yang ditentukan.
API ini mendukung operasi jangka panjang (LRO).

Ketika Anda mendapatkan definisi publik eventstream, label sensitivitas bukan bagian dari definisi.

Hak akses

Pemanggil harus memiliki izin baca dan tulis untuk eventstream.

Cakupan yang Didelegasikan yang Diperlukan

Eventstream.ReadWrite.All atau Item.ReadWrite.All

Keterbatasan

API ini diblokir untuk eventstream dengan label sensitivitas terenkripsi.

Identitas yang didukung oleh Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas	Dukungan
Pengguna	Ya
Prinsipal Layanan dan Identitas Terkelola	Ya

Antarmuka

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/getDefinition

Dengan parameter opsional:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/eventstreams/{eventstreamId}/getDefinition?format={format}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
eventstreamId	path	True	string (uuid)	ID dari eventstream.
workspaceId	path	True	string (uuid)	ID ruangkerja.
format	query		string	Format dari definisi publik eventstream.

Respons

Nama	Jenis	Deskripsi
200 OK	EventstreamDefinitionResponse	Permintaan berhasil diselesaikan.
202 Accepted		Permintaan diterima. Mengambil definisi sedang berlangsung. Header Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Batas tarif layanan terlampaui. Server mengembalikan header yang `Retry-After` menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan. Header Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: OperationNotSupportedForItem - Operasi tidak didukung untuk item yang diminta.

Contoh

Get an eventstream definition example

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 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"
      }
    ]
  }
}

Kode status:: 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

Definisi

Nama	Deskripsi
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
EventstreamDefinition	Objek definisi publik eventstream. Lihat artikel ini untuk detail selengkapnya tentang struktur definisi Eventstream.
EventstreamDefinitionPart	Objek bagian definisi eventstream.
EventstreamDefinitionResponse	Respons definisi publik eventstream.
PayloadType	Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya yang terlibat dalam kesalahan.
resourceType	string	Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
isRetriable	boolean	Jika benar, permintaan dapat dicoba kembali. `Retry-After` Gunakan header respons untuk menentukan penundaan, jika tersedia.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string (uuid)	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

EventstreamDefinition

Objek

Objek definisi publik eventstream. Lihat artikel ini untuk detail selengkapnya tentang struktur definisi Eventstream.

Nama	Jenis	Deskripsi
format	string	Format definisi eventstream.
parts	EventstreamDefinitionPart[]	Daftar bagian definisi.

EventstreamDefinitionPart

Objek

Objek bagian definisi eventstream.

Nama	Jenis	Deskripsi
path	string	Jalur bagian eventstream.
payload	string	Payload bagian eventstream.
payloadType	PayloadType	Jenis payload.

EventstreamDefinitionResponse

Objek

Respons definisi publik eventstream.

Nama	Jenis	Deskripsi
definition	EventstreamDefinition	Objek definisi publik eventstream. Lihat artikel ini untuk detail selengkapnya tentang struktur definisi Eventstream.

PayloadType

Enumerasi

Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
InlineBase64	Dasar Sebaris 64.