Aracılığıyla paylaş


Olay Akışı REST API'si

Microsoft Fabric REST API'leri, Yapı yordamlarını ve işlemlerini otomatikleştirmenize olanak tanıyarak kuruluşunuzun görevleri daha verimli ve doğru bir şekilde tamamlamasına yardımcı olur. Bu iş akışlarını otomatikleştirerek hataları azaltabilir, üretkenliği artırabilir ve operasyonlarınızda maliyet tasarrufu sağlayabilirsiniz.

Fabric'de bir öğe, belirli bir deneyim içindeki yetenekler kümesini temsil eder. Örneğin Eventstream, Gerçek Zamanlı Zeka deneyiminin altındaki bir öğedir. Kumaş'taki her öğe, öğenin yapısını, biçimini ve anahtar bileşenlerini özetleyen bir nesne olan bir öğe tanımı ile tanımlanır.

Bu makalede, Doku çalışma alanınızda Eventstream öğeleri oluşturmak ve yönetmek için Microsoft Fabric REST API'lerini kullanma hakkında kapsamlı bir kılavuz sunulmaktadır. Her Eventstream API işlemi için ayrıntılı belirtimlerin yanı sıra API çağrılarınızı ayarlama ve yapılandırma yönergelerini bulabilirsiniz.

Microsoft Fabric REST API'lerine tam bir genel bakış için şu adresi ziyaret edin: Microsoft Fabric REST API'lerini kullanma

Desteklenen Olay Akışı API'leri

Eventstream şu anda aşağıdaki tanım tabanlı API'leri destekler:

API'ler Açıklama
Tanım ile Eventstream öğesi oluşturma Kaynak, hedefler, işleçler ve akışlar gibi topolojisi hakkında ayrıntılı bilgiler içeren bir Olay Akışı öğesi oluşturmak için kullanın.
Olay Akışı öğe tanımını alma Kaynak, hedefler, işleçler ve akışlar gibi topolojisi hakkında ayrıntılı bilgiler içeren bir Olay Akışı öğesi tanımı almak için kullanın.
Olay Akışı öğe tanımını güncelleştirme Kaynak, hedefler, işleçler ve akışlar gibi bir Eventstream öğesi tanımını güncelleştirmek veya düzenlemek için kullanın.

CRUD işlemlerini kullanarak Eventstream öğelerinizi yönetmek için Doku REST API'leri - Eventstream adresini ziyaret edin. Bu API'ler aşağıdaki işlemleri destekler:

  • Olay Akışı Oluşturma
  • Olay Akışını Sil
  • Etkinlik Akışını Al
  • Olay Akışlarını Listeleme
  • Olay Akışını Güncelleştirme

Eventstream API'sini çağırma

1. Adım: Fabric'e Kimlik Doğrulaması

Doku API'leriyle çalışmak için önce Doku hizmeti için bir Microsoft Entra belirteci almanız ve ardından bu belirteci API çağrısının yetkilendirme üst bilgisinde kullanmanız gerekir. Microsoft Entra belirtecini almak için iki seçenek vardır.

Seçenek 1: MSAL.NET kullanarak jeton alma

Uygulamanızın hizmet sorumlusu kullanarak Doku API'lerine erişmesi gerekiyorsa, erişim belirteci almak için MSAL.NET kitaplığını kullanabilirsiniz. Fabric API hızlı başlangıcını izleyerek, MSAL.Net kitaplığını kullanarak Azure AD belirteci alan bir C# konsol uygulaması oluşturun, ardından C# HttpClient kullanarak Liste çalışma alanları API'sini çağırın.

Seçenek 2: Fabric Portal kullanarak belirteç alma

Fabric API'lerini doğrulamak ve test etmek için Azure AD belirtecinizi kullanabilirsiniz. Test etmek istediğiniz Kiracı için Doku Portalı'nda oturum açın ve tarayıcının geliştirici moduna girmek için F12 tuşuna basın. Konsolda şunu çalıştırın:

powerBIAccessToken

Belirteci kopyalayıp uygulamanıza yapıştırın.

Uyarı

Oluşturduğunuz olay akışında bulut bağlantısı kullanan kaynaklar varsa, kullandığınız kimliğin belirteci alabilmesi için, ister hizmet sorumlusu ister kullanıcı olsun, bu bulut bağlantısına erişim iznine sahip olduğundan emin olun.

2. Adım: JSON'da Olay Akışı gövdesine hazırlanma

API isteğinde base64'e dönüştürülecek bir JSON yükü oluşturun. Eventstream öğe tanımı graf benzeri bir yapıyı izler ve aşağıdaki bileşenlerden oluşur:

Alan Açıklama
Kaynak İşleme için Eventstream'e alınabilen veri kaynakları. Desteklenen veri kaynakları arasında Azure akış kaynakları, üçüncü taraf akış kaynakları, veritabanı CDC'si (veri yakalamayı değiştirme), Azure Blob Depolama olayları ve Doku sistemi olayları yer alır.
Hedef Lakehouse, Eventhouse, Activator ve diğerleri gibi işlenen verilerin yönlendirilebildiği Fabric içindeki uç noktalar.
Operatörler Filter, Aggregate, Group By ve Join gibi gerçek zamanlı veri akışlarını işleyen olay işlemcileri.
Akışlar Gerçek zamanlı Hub'da abonelik ve analiz için kullanılabilir veri akışları. İki tür akış vardır: varsayılan akışlar ve türetilmiş akışlar.

Olay Akışı gövdenizi tanımlamaya yardımcı olması için GitHub'daki API şablonlarını kullanın.

Her API özelliğiyle ilgili ayrıntılar için bu Swagger belgesine başvurabilirsiniz ve ayrıca bir Eventstream API yükü tanımlama konusunda size yol gösterir.

Eventhouse Doğrudan Alma Modu

Eventhouse doğrudan alma modunu Eventstream API yükünüzde hedef olarak kullanırken şu yönergeleri izleyin:

1. Gerekli Özellikleri Belirtin

JSON gövdesinde aşağıdaki özelliklerin doğru ayarlandığından emin olun:

  • connectionName – Eventhouse bağlantısının adı.
  • mappingRuleName – Hedef tablo için veri alma eşleme kuralı.

Doğru connectionNamebulmak için:

  1. Eventhouse KQL veritabanınıza Fabric'de gidin.
  2. Veri akışları'na tıklayın.
  3. İstenen connectionNameöğesini kopyalayın.

mappingRuleName için, alma eşlemeleri oluşturma konusunda ayrıntılı yönergeleri ingestionMappingReference ile eşleme bölümünde bulabilirsiniz.

2. Hizmet Sorumlusu İzinlerini Yapılandırma

Bir hizmet sorumlusu kullanarak kimlik doğrulaması yaparsanız, aşağıdakilere sahip olmalıdır:

  • Veritabanı görüntüleyici izinleri.
  • Tablo alma izinleri.

Bu izinleri iki yolla vekleyebilirsiniz:

Kullanıcı arabiriminde aşağıdaki KQL komutlarını kullanarak bu izinleri verin:

.add database ['yourDatabase'] viewers (@'aadapp=<clientid>;<tenantid>')
.add table yourTable ingestors (@'aadapp=<id>;<directoryid>')

Hizmet sorumlusu değerlerinizle clientid ve tenantid değerlerini değiştirin.

Bu komutlar hizmet sorumlusuna gerekli veri düzlemi izinlerini verir ve Eventhouse'un bağlantıyı oluşturmasına ve Eventstream'den veri çekmesine olanak sağlar. Daha fazla bilgi için bkz . Güvenlik rollerine genel bakış

Kusto kullanıcı arabirimi aracılığıyla Veritabanı ve Tablo izni verme işleminin ekran görüntüsü.

Eventstream öğesi tanımlama hakkında daha fazla ayrıntı için olay akışı öğesi tanımı bölümüne bakın.

JSON'da Eventstream tanımı örneği:

{
  "sources": [
    {
      "name": "SqlServerOnVmDbCdc",
      "type": "SQLServerOnVMDBCDC",
      "properties":
      {
        "dataConnectionId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
        "tableName": ""
      }
    }
  ],
  "destinations": [
    {
      "name": "Lakehouse",
      "type": "Lakehouse",
      "properties":
      {
        "workspaceId": "bbbb1111-cc22-3333-44dd-555555eeeeee",
        "itemId": "cccc2222-dd33-4444-55ee-666666ffffff",
        "schema": "",
        "deltaTable": "newTable",
        "minimumRows": 100000,
        "maximumDurationInSeconds": 120,
        "inputSerialization":
        {
          "type": "Json",
          "properties":
          {
            "encoding": "UTF8"
          }
        }
      },
      "inputNodes": [{"name": "derivedStream"}]
    }
  ],
  "streams": [
    {
      "name": "myEventstream-stream",
      "type": "DefaultStream",
      "properties":
      {},
      "inputNodes": [{"name": "SqlServerOnVmDbCdc"}]
    },
    {
      "name": "derivedStream",
      "type": "DerivedStream",
      "properties":
      {
        "inputSerialization":
        {
          "type": "Json",
          "properties":
          {
            "encoding": "UTF8"
          }
        }
      },
      "inputNodes": [{"name": "GroupBy"}]
    }
  ],
  "operators": [
    {
      "name": "GroupBy",
      "type": "GroupBy",
      "inputNodes": [{"name": "myEventstream-stream"}],
      "properties":
      {
        "aggregations": [
          {
            "aggregateFunction": "Average",
            "column":
            {
              "expressionType": "ColumnReference",
              "node": null,
              "columnName": "payload",
              "columnPathSegments": [{"field": "ts_ms"}]
            },
            "alias": "AVG_ts_ms"
          }
        ],
        "groupBy": [],
        "window":
        {
          "type": "Tumbling",
          "properties":
          {
            "duration":
            {
              "value": 5,
              "unit": "Minute"
            },
            "offset":
            {
              "value": 1,
              "unit": "Minute"
            }
          }
        }
      }
    }
  ],
  "compatibilityLevel": "1.1"
}

3. Adım: Eventstream JSON'un base64 dizesini oluşturma

Olay Akışı JSON'unu base64 dizesine dönüştürmek için Base64 Kodlama ve Kod Çözme gibi bir araç kullanın.

Eventstream JSON'yi base64 dizesine kodlamanın ekran görüntüsü.

4. Adım: API istek gövdesini oluşturma

Önceki adımda API isteği gövdesinin içeriği olarak Base64 ile kodlanmış Eventstream JSON kullanın.

Aşağıda Base64 ile kodlanmış dizeye sahip bir yük örneği verilmiştir:

{
 "definition": {
  "parts": [
   {
    "path": "eventstream.json",
    "payload": "ewogICJzb3VyY2VzIjogWwogICAgewogICAgICAibmFtZSI6ICJTcWxTZXJ2ZXJPblZtRGJDZGMiLAogICAgICAidHlwZSI6ICJTUUxTZXJ2ZXJPblZNREJDREMiLAogICAgICAicHJvcGVydGllcyI6CiAgICAgIHsKICAgICAgICAiZGF0YUNvbm5lY3Rpb25JZCI6ICJhYWFhYWFhYS0wMDAwLTExMTEtMjIyMi1iYmJiYmJiYmJiYmIiLAogICAgICAgICJ0YWJsZU5hbWUiOiAiIgogICAgICB9CiAgICB9CiAgXSwKICAiZGVzdGluYXRpb25zIjogWwogICAgewogICAgICAibmFtZSI6ICJMYWtlaG91c2UiLAogICAgICAidHlwZSI6ICJMYWtlaG91c2UiLAogICAgICAicHJvcGVydGllcyI6CiAgICAgIHsKICAgICAgICAid29ya3NwYWNlSWQiOiAiYmJiYjExMTEtY2MyMi0zMzMzLTQ0ZGQtNTU1NTU1ZWVlZWVlIiwKICAgICAgICAiaXRlbUlkIjogImNjY2MyMjIyLWRkMzMtNDQ0NC01NWVlLTY2NjY2NmZmZmZmZiIsCiAgICAgICAgInNjaGVtYSI6ICIiLAogICAgICAgICJkZWx0YVRhYmxlIjogIm5ld1RhYmxlIiwKICAgICAgICAibWluaW11bVJvd3MiOiAxMDAwMDAsCiAgICAgICAgIm1heGltdW1EdXJhdGlvbkluU2Vjb25kcyI6IDEyMCwKICAgICAgICAiaW5wdXRTZXJpYWxpemF0aW9uIjoKICAgICAgICB7CiAgICAgICAgICAidHlwZSI6ICJKc29uIiwKICAgICAgICAgICJwcm9wZXJ0aWVzIjoKICAgICAgICAgIHsKICAgICAgICAgICAgImVuY29kaW5nIjogIlVURjgiCiAgICAgICAgICB9CiAgICAgICAgfQogICAgICB9LAogICAgICAiaW5wdXROb2RlcyI6IFt7Im5hbWUiOiAiZGVyaXZlZFN0cmVhbSJ9XQogICAgfQogIF0sCiAgInN0cmVhbXMiOiBbCiAgICB7CiAgICAgICJuYW1lIjogIm15RXZlbnRzdHJlYW0tc3RyZWFtIiwKICAgICAgInR5cGUiOiAiRGVmYXVsdFN0cmVhbSIsCiAgICAgICJwcm9wZXJ0aWVzIjoKICAgICAge30sCiAgICAgICJpbnB1dE5vZGVzIjogW3sibmFtZSI6ICJTcWxTZXJ2ZXJPblZtRGJDZGMifV0KICAgIH0sCiAgICB7CiAgICAgICJuYW1lIjogImRlcml2ZWRTdHJlYW0iLAogICAgICAidHlwZSI6ICJEZXJpdmVkU3RyZWFtIiwKICAgICAgInByb3BlcnRpZXMiOgogICAgICB7CiAgICAgICAgImlucHV0U2VyaWFsaXphdGlvbiI6CiAgICAgICAgewogICAgICAgICAgInR5cGUiOiAiSnNvbiIsCiAgICAgICAgICAicHJvcGVydGllcyI6CiAgICAgICAgICB7CiAgICAgICAgICAgICJlbmNvZGluZyI6ICJVVEY4IgogICAgICAgICAgfQogICAgICAgIH0KICAgICAgfSwKICAgICAgImlucHV0Tm9kZXMiOiBbeyJuYW1lIjogIkdyb3VwQnkifV0KICAgIH0KICBdLAogICJvcGVyYXRvcnMiOiBbCiAgICB7CiAgICAgICJuYW1lIjogIkdyb3VwQnkiLAogICAgICAidHlwZSI6ICJHcm91cEJ5IiwKICAgICAgImlucHV0Tm9kZXMiOiBbeyJuYW1lIjogIm15RXZlbnRzdHJlYW0tc3RyZWFtIn1dLAogICAgICAicHJvcGVydGllcyI6CiAgICAgIHsKICAgICAgICAiYWdncmVnYXRpb25zIjogWwogICAgICAgICAgewogICAgICAgICAgICAiYWdncmVnYXRlRnVuY3Rpb24iOiAiQXZlcmFnZSIsCiAgICAgICAgICAgICJjb2x1bW4iOgogICAgICAgICAgICB7CiAgICAgICAgICAgICAgImV4cHJlc3Npb25UeXBlIjogIkNvbHVtblJlZmVyZW5jZSIsCiAgICAgICAgICAgICAgIm5vZGUiOiBudWxsLAogICAgICAgICAgICAgICJjb2x1bW5OYW1lIjogInBheWxvYWQiLAogICAgICAgICAgICAgICJjb2x1bW5QYXRoU2VnbWVudHMiOiBbeyJmaWVsZCI6ICJ0c19tcyJ9XQogICAgICAgICAgICB9LAogICAgICAgICAgICAiYWxpYXMiOiAiQVZHX3RzX21zIgogICAgICAgICAgfQogICAgICAgIF0sCiAgICAgICAgImdyb3VwQnkiOiBbXSwKICAgICAgICAid2luZG93IjoKICAgICAgICB7CiAgICAgICAgICAidHlwZSI6ICJUdW1ibGluZyIsCiAgICAgICAgICAicHJvcGVydGllcyI6CiAgICAgICAgICB7CiAgICAgICAgICAgICJkdXJhdGlvbiI6CiAgICAgICAgICAgIHsKICAgICAgICAgICAgICAidmFsdWUiOiA1LAogICAgICAgICAgICAgICJ1bml0IjogIk1pbnV0ZSIKICAgICAgICAgICAgfSwKICAgICAgICAgICAgIm9mZnNldCI6CiAgICAgICAgICAgIHsKICAgICAgICAgICAgICAidmFsdWUiOiAxLAogICAgICAgICAgICAgICJ1bml0IjogIk1pbnV0ZSIKICAgICAgICAgICAgfQogICAgICAgICAgfQogICAgICAgIH0KICAgICAgfQogICAgfQogIF0sCiAgImNvbXBhdGliaWxpdHlMZXZlbCI6ICIxLjEiCn0=",
    "payloadType": "InlineBase64"
   },
   {
    "path": ".platform",
    "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIkV2ZW50c3RyZWFtIiwKICAgICJkaXNwbGF5TmFtZSI6ICJhbGV4LWVzMSIKICB9LAogICJjb25maWciOiB7CiAgICAidmVyc2lvbiI6ICIyLjAiLAogICAgImxvZ2ljYWxJZCI6ICIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiCiAgfQp9",
    "payloadType": "InlineBase64"
   }
  ]
 }
}

5. Adım: API kullanarak Eventstream öğesi oluşturma

Uygulamanızda, yükte Base64 ile kodlanmış dize ile bir Eventstream öğesi oluşturma isteği gönderin.

PowerShell Örneği:

$evenstreamAPI = "https://api.fabric.microsoft.com/v1/workspaces/$workspaceId/items" 

## Invoke the API to create the Eventstream
Invoke-RestMethod -Headers $headerParams -Method POST -Uri $evenstreamAPI -Body ($body) -ContentType "application/json"

Olay akışı öğe tanımı

Eventstream öğe tanımı dört bileşenden oluşan graf benzeri bir yapıya sahiptir: kaynaklar, hedefler, işleçler ve akışlar.

Kaynaklar

API gövdesinde bir Eventstream kaynağı tanımlamak için, her alanın ve özelliğin tabloya göre doğru belirtildiğinden emin olun.

Alan Tür Açıklama Gereksinim İzin Verilen Değerler / Biçim
id Dize (UUID) Sistem tarafından oluşturulan kaynağın benzersiz tanımlayıcısı. CREATE'de isteğe bağlı, UPDATE'te gereklidir UUID biçimi
name Dize Kaynağı Eventstream içinde tanımlamak için kullanılan benzersiz bir ad. Zorunlu Geçerli herhangi bir dize
type Dize (sabit listesi) Kaynak türünü belirtir. Önceden tanımlanmış değerlerden biriyle eşleşmelidir. Zorunlu AmazonKinesis, AmazonMSKKafka, ApacheKafka, AzureCosmosDBCDC, AzureBlobStorageEvents, AzureEventHub, AzureIoTHub, AzureSQLDBCDC, AzureSQLMIDBCDC, ConfluentCloud, CustomEndpoint, FabricCapacityUtilizationEvents, GooglePubSub, MySQLCDC, PostgreSQLCDC, SampleData, FabricWorkspaceItemEvents, FabricJobEvents, FabricOneLakeEvents
properties Nesne Seçili kaynak türüne özgü diğer ayarlar. Zorunlu Tür örneği AzureEventHub : dataConnectionId,consumerGroupName,inputSerialization

API gövdesinde Eventstream kaynağı örneği:

{
  "sources": [
    {
      "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "name": "AzureEventHubSource",
      "type": "AzureEventHub",
      "properties":
      {
        "dataConnectionId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
        "consumerGroupName": "$Default",
        "inputSerialization":
        {
          "type": "Json",
          "properties":
          {
            "encoding": "UTF8"
          }
        }
      }
    }
  ]
}

Gidilecek Yerler

API gövdesinde bir Eventstream hedefi tanımlamak için, her alanın ve özelliğin tabloya göre doğru belirtildiğinden emin olun.

Alan Tür Açıklama Gereksinim İzin Verilen Değerler / Biçim
id Dize (UUID) Sistem tarafından oluşturulan hedefin benzersiz tanımlayıcısı. CREATE'de isteğe bağlı, UPDATE'te gereklidir UUID biçimi
name Dize Eventstream içinde tanımlanması için kullanılan hedefe ait benzersiz bir ad. Zorunlu Geçerli herhangi bir dize
type Dize (sabit listesi) Hedef türünü belirtir. Önceden tanımlanmış değerlerden biriyle eşleşmelidir. Zorunlu "Activator", "CustomEndpoint", "Eventhouse", "Lakehouse"
properties Nesne Seçili hedef türüne özgü diğer ayarlar. Zorunlu Tür örneği Eventhouse : "dataIngestionMode", "workspaceId", "itemId", "databaseName"
inputNodes Dizi Eventstream adınız veya işleç adınız gibi hedef için giriş düğümlerine başvuru. Zorunlu Örnek: eventstream-1

Eventhouse doğrudan alma modu hedefini kullanıyorsanız, connectionName ve mappingRuleName özelliklerinin doğru belirtildiğinden emin olun. Doğru connectionNameöğesini bulmak için Eventhouse KQL veritabanınıza gidin, Veri akışları'nı seçin ve istediğiniz connectionNameöğesini kopyalayın. Ayrıştırma eşlemeleri oluşturma hakkında ayrıntılı yönergeler için bkz. ingestionMappingReference ile eşleme.


API gövdesinde Eventstream kaynağı örneği:

{
  "destinations": [
    {
      "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "name": "EventhouseDestination",
      "type": "Eventhouse",
      "properties":
      {
        "dataIngestionMode": "ProcessedIngestion",
        "workspaceId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
        "itemId": "cccc2222-dd33-4444-55ee-666666ffffff",
        "databaseName": "myeventhouse",
        "tableName": "mytable",
        "inputSerialization":
        {
          "type": "Json",
          "properties":
          {
            "encoding": "UTF8"
          }
        }
      },
      "inputNodes": [{"name": "eventstream-1"}]
    }
  ]
}

İşleçler

API gövdesinde bir Eventstream işleci tanımlamak için, her alan ve özelliğin tabloya göre doğru belirtildiğinden emin olun.

Alan Tür Açıklama Gereksinim İzin Verilen Değerler / Biçim
name Dize Operatör için benzersiz bir ad. Zorunlu Geçerli herhangi bir dize
type Dize (sabit listesi) İşleç türünü belirtir. Önceden tanımlanmış değerlerden biriyle eşleşmelidir. Zorunlu "Filter", "Join", "ManageFields", , "Aggregate", "GroupBy", "Union", "Expand"
properties Nesne Seçili işleç türüne özgü diğer ayarlar. Zorunlu Tür örneği Filter : "conditions"
inputNodes Dizi İşlecin giriş düğümlerine yapılan başvuruların listesi. Zorunlu Örnek: eventstream-1
inputSchemas Dizi İşlecin giriş düğümlerine yapılan başvuruların listesi. İsteğe bağlı Tür örneği Filter : "schema"

API gövdesinde Eventstream işleci örneği:

{
  "operators": [
    {
      "name": "FilterName",
      "type": "Filter",
      "inputNodes": [{"name": "eventstream-1"}],
      "properties":
      {
        "conditions": [
          {
            "column":
            {
              "node": "nodeName",
              "columnName": "columnName",
              "columnPath": ["path","to","column"]
            },
            "operator": "Equals",
            "value":
            {
              "dataType": "nvarchar(max)",
              "value": "stringValue"
            }
          }
        ]
      }
    }
  ]
}

Akışlar

API gövdesinde bir akış tanımlamak için, her alanın ve özelliğin tabloya göre doğru belirtildiğinden emin olun.

Alan Tür Açıklama Gereksinim İzin Verilen Değerler / Biçim
id Dize (UUID) Akışın sistem tarafından oluşturulan benzersiz tanımlayıcısı. İsteğe bağlı UUID biçimi
name Dize Akış için benzersiz bir ad. Zorunlu Geçerli herhangi bir dize
type Dize (sabit listesi) Akış türünü belirtir. Önceden tanımlanmış değerlerden biriyle eşleşmelidir. Zorunlu "DefaultStream", "DerivedStream"
properties Nesne Seçili akış türüne özgü diğer ayarlar. Zorunlu Tür örneği Filter : "conditions"
inputNodes Dizi Akışın giriş düğümlerine yapılan referansların listesi. İsteğe bağlı Örnek: [], "eventstream-1"

API gövdesinde akış örneği:

{
  "streams": [
    {
      "name": "myEventstream-stream",
      "type": "DefaultStream",
      "properties":
      {},
      "inputNodes": [{"name": "sourceName"}]
    },
    {
      "name": "DerivedStreamName",
      "type": "DerivedStream",
      "properties":
      {
        "inputSerialization":
        {
          "type": "Json",
          "properties":
          {
            "encoding": "UTF8"
          }
        }
      },
      "inputNodes": [{"name": "FilterName"}]
    }
  ]
}