Announcing REST APIs for Fabric Eventstream

• Announcements
• Fabric Public APIs
• Real-Time Intelligence

• November 25, 2024 by Alex Lin 47,945 Views

We’re excited to announce the REST APIs for Fabric Eventstream! These new APIs are designed to automate your development workflows for Eventstream, making it easier and faster for your team to build robust streaming solutions. With the Eventstream REST API, you can now programmatically create, manage, and update Eventstream items, reducing manual work and the potential for errors. This enhances productivity, minimizes costs, and helps your team focus on building complex streaming solutions efficiently.

For a complete overview of Microsoft Fabric REST APIs, you can visit Using the Microsoft Fabric REST APIs.

Supported Eventstream APIs

An Eventstream item is composed of several key components: sources, destinations, operators, and streams. The Eventstream REST API currently supports three definition-based operations, giving you full control to manage every component of an Eventstream item.

• Create Eventstream item with definition – Define and create a new Eventstream item with a complete topology, including sources, destinations, operators, and streams.
• Get Eventstream item definition – Retrieve the full definition of an Eventstream item, including detailed topology information.
• Update Eventstream item definition – Edit the topology of an existing Eventstream item.

In addition to these definition-based operations, Eventstream also supports basic CRUD (Create, Read, Update, Delete) operations, allowing for efficient management of Eventstream items within your workspace.

• Create Eventstream: Initialize a new Eventstream item.
• Delete Eventstream: Remove an existing Eventstream item.
• Get Eventstream: Retrieve details of a specific Eventstream item.
• List Eventstreams: Access a list of Eventstream items within a workspace.
• Update Eventstream: Edit the metadata of an Eventstream item.

For more information, please refer to Fabric REST APIs for Eventstream.

Example of the Create Eventstream Definition API

Here’s a quick overview of the Create Eventstream with Definition API, along with example request and response, to help you get hands-on with the Eventstream REST API.

Request

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items

Body

// Example of payload content decoded from Base64
{
  "sources": [
    {
      "name": "AzureEventHubSource",
      "type": "AzureEventHub",
      "properties":
      {
        "dataConnectionId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
        "consumerGroupName": "$Default",
        "inputSerialization":
        {
          "type": "Json",
          "properties":
          {
            "encoding": "UTF8"
          }
        }
      }
    }
  ],
  "destinations": [
    {
      "name": "EventhouseDestination",
      "type": "Eventhouse",
      "properties":
      {
        "dataIngestionMode": "ProcessedIngestion",
        "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
        "itemId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
        "databaseName": "myeventhouse",
        "tableName": "mytable",
        "inputSerialization":
        {
          "type": "Json",
          "properties":
          {
            "encoding": "UTF8"
          }
        }
      },
      "inputNodes": []
    }
  ],
  "streams": [],
  "operators": [],
  "compatibilityLevel": "1.0"
}

Response

{
  "202":
  {
    "headers":
    {
      "Location": "https://api.fabric.microsoft.com/v1/operations/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
      "x-ms-operation-id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
      "Retry-After": 30
    }
  }
}

With Eventstream REST API, you can effortlessly build and deploy Eventstream items within your CI/CD pipeline and seamlessly integrate Eventstream into your applications. We look forward to how you’ll leverage these powerful APIs to drive real-time intelligence across your business processes.

Get started today and unlock the full potential of Fabric Eventstream!