Edit

Share via

Eventstream - GitHub integration

The following article details the file structure for Eventstream once they're synced to a GitHub or Azure Devops Repository.

Folder structure

Once a workspace is synced to a repo, you see a top level folder for the workspace and a subfolder for each item that was synced. Each subfolder is formatted with Item Name.Item Type

Within the folder for the eventstream, you see have the following files:

  • Platform: Defines fabric platform values such as Display Name and Description.
  • Properties: Defines item specific values.

Here's an example of what the folder structure looks like:

Repo

  • Workspace A
    • Item_A.Eventstream
      • .platform
      • EventstreamProperties.json
  • Workspace B
    • Item_C.Eventstream
      • .platform
      • EventstreamProperties.json

Eventstream files

The following files are contained in an eventstream folder:

  • .platform

    The file uses the following schema to define an eventstream:

    {
  "$schema": "https://developer.microsoft.com/json-schemas/fabric/gitIntegration/platformProperties/2.0.0/schema.json",
  "metadata": {
    "type": "Eventstream",
    "displayName": "",
    "description": ""
  },
  "config": {
    "version": "2.0",
    "logicalId": ""
  }
}

  • EventstreamProperties.json

    The file allows you to configure platform-level settings for the eventstream item. Here's a sample file:

    {
    "sources": [
        {
            "name": "AzureEventHubSource",
            "type": "AzureEventHub",
            "properties": {
                "dataConnectionId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
                "consumerGroupName": "$Default",
                "inputSerialization": {
                    "type": "Json",
                    "properties": {
                        "encoding": "UTF8"
                    }
                }
            }
        },
        {
            "name": "AzureIoTHubSource",
            "type": "AzureIoTHub",
            "properties": {
                "dataConnectionId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
                "consumerGroupName": "$Default",
                "inputSerialization": {
                    "type": "Json",
                    "properties": {
                        "encoding": "UTF8"
                    }
                }
            }
        }
    ],
    "destinations": [
        {
            "name": "CustomEndpointDestination",
            "type": "CustomEndpoint",
            "properties": {},
            "inputNodes": [
                {
                    "name": "myEventstream-stream"
                }
            ]
        },
        {
            "name": "LakehouseDestination",
            "type": "Lakehouse",
            "properties": {
                "workspaceId": "00000000-0000-0000-0000-000000000000",
                "itemId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
                "schema": "dbo",
                "deltaTable": "deltaTable",
                "minimumRows": 100000,
                "maximumDurationInSeconds": 120,
                "inputSerialization": {
                    "type": "Json",
                    "properties": {
                        "encoding": "UTF8"
                    }
                }
            },
            "inputNodes": [
                {
                    "name": "myEventstream-stream"
                }
            ]
        }
    ],
    "streams": [
        {
            "name": "myEventstream-stream",
            "type": "DefaultStream",
            "properties": {},
            "inputNodes": [
                {
                    "name": "sourceName"
                }
            ]
        },
        {
            "name": "DerivedStreamName",
            "type": "DerivedStream",
            "properties": {
                "inputSerialization": {
                    "type": "Json",
                    "properties": {
                        "encoding": "UTF8"
                    }
                }
            },
            "inputNodes": [
                {
                    "name": "FilterName"
                }
            ]
        }
    ],
    "operators": [
        {
            "name": "FilterName",
            "type": "Filter",
            "inputNodes": [
                {
                    "name": "myEventstream-stream"
                }
            ],
            "properties": {
                "conditions": [
                    {
                        "column": {
                            "node": null,
                            "columnName": "BikepointID",
                            "columnPath": null,
                            "expressionType": "ColumnReference"
                        },
                        "operatorType": "NotEquals",
                        "value": {
                            "dataType": "Nvarchar(max)",
                            "value": "0",
                            "expressionType": "Literal"
                        }
                    }
                ]
            }
        }
    ],
    "compatibilityLevel": "1.0"
}

For a complete sample with all types of sources, destinations, and operators, see eventstream-definition.json.

Related content