Items - Get Eventstream Definition

Hizmet:: Eventstream

API Sürümü:: v1

Belirtilen olay akışı genel tanımını döndürür.
Bu API, uzun süre çalışan işlemleri (LRO)destekler.

Olay akışı genel tanımı aldığınızda duyarlılık etiketi tanımın bir parçası değildir.

İzinler

Çağıranın olay akışı için okuma ve yazma izinlerine sahip olması gerekir.

Gerekli Temsilci Kapsamları

Eventstream.ReadWrite.All veya Item.ReadWrite.All

Sınırlamalar

Bu API, şifrelenmiş duyarlılık etiketine sahip bir olay akışı için engellenir.

Microsoft Entra destekli kimlikler

Bu API, bu bölümde listelenen Microsoft kimliklerini destekler.

Kimlik	Destek
Kullanıcı	Evet
Hizmet sorumlusu ve yönetilen kimlikler	Evet

Arayüz

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
eventstreamId	path	True	string (uuid)	Olay akışı kimliği.
workspaceId	path	True	string (uuid)	Çalışma alanı kimliği.
format	query		string	Olay akışı genel tanımının biçimi.

Yanıtlar

Name	Tür	Description
200 OK	EventstreamDefinitionResponse	İstek başarıyla tamamlandı.
202 Accepted		İstek kabul edildi. Tanımı alma işlemi devam ediyor. Üst Bilgiler Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Hizmet fiyatı sınırı aşıldı. Sunucu, istemcinin ek istek göndermeden önce ne kadar beklemesi gerektiğini saniye cinsinden belirten bir `Retry-After` üst bilgi döndürür. Üst Bilgiler Retry-After: integer
Other Status Codes	ErrorResponse	Yaygın hata kodları: OperationNotSupportedForItem - İstenen öğe için işlem desteklenmiyor.

Örnekler

Get an eventstream definition example

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 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"
      }
    ]
  }
}

Durum kodu:: 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

Tanımlar

Name	Description
ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse	Hata yanıtı.
ErrorResponseDetails	Hata yanıtı ayrıntıları.
EventstreamDefinition	Eventstream ortak tanım nesnesi. Eventstream tanımının yapısı hakkında daha fazla bilgi için bu makaleye bakın.
EventstreamDefinitionPart	Olay akışı tanımı parça nesnesi.
EventstreamDefinitionResponse	Olay akışı genel tanım yanıtı.
PayloadType	Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.

ErrorRelatedResource

Nesne

Hatayla ilgili kaynak ayrıntıları nesnesi.

Name	Tür	Description
resourceId	string	Hataya dahil olan kaynak kimliği.
resourceType	string	Hataya dahil olan kaynağın türü.

ErrorResponse

Nesne

Hata yanıtı.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
isRetriable	boolean	True olduğunda istek yeniden denenebilir. Varsa gecikmeyi `Retry-After` belirlemek için yanıt üst bilgisini kullanın.
message	string	Hatanın okunabilir bir gösterimi.
moreDetails	ErrorResponseDetails[]	Ek hata ayrıntılarının listesi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.
requestId	string (uuid)	Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Nesne

Hata yanıtı ayrıntıları.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message	string	Hatanın okunabilir bir gösterimi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.

EventstreamDefinition

Nesne

Eventstream ortak tanım nesnesi. Eventstream tanımının yapısı hakkında daha fazla bilgi için bu makaleye bakın.

Name	Tür	Description
format	string	Olay akışı tanımının biçimi.
parts	EventstreamDefinitionPart[]	Tanım bölümlerinin listesi.

EventstreamDefinitionPart

Nesne

Olay akışı tanımı parça nesnesi.

Name	Tür	Description
path	string	Olay akışı bölüm yolu.
payload	string	Olay akışı bölümü yükü.
payloadType	PayloadType	Yük türü.

EventstreamDefinitionResponse

Nesne

Olay akışı genel tanım yanıtı.

Name	Tür	Description
definition	EventstreamDefinition	Eventstream ortak tanım nesnesi. Eventstream tanımının yapısı hakkında daha fazla bilgi için bu makaleye bakın.

PayloadType

Numaralandırma

Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.

Değer	Description
InlineBase64	Satır içi Temel 64.