Skip to content

eventstream

Manage eventstreams (real-time data ingestion)

Authentication scope: fabric

List eventstreams in a workspace

Terminal window
fabio eventstream list --workspace <value>
Flag Type Required Description
--workspace string Yes Workspace ID

Read-only · Returns list

Show details of an eventstream

Terminal window
fabio eventstream show --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID

Read-only · Returns object

Create a new eventstream

Terminal window
fabio eventstream create --workspace <value> --name <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--name string Yes Eventstream display name
--description string No Optional description
--sensitivity-label string No Sensitivity label ID to apply on creation

Examples

Terminal window
fabio eventstream create --workspace $WS --name "SensorIngestion"

Mutates state · Returns object

Update eventstream properties (name and/or description)

Terminal window
fabio eventstream update --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--name string No New display name
--description string No New description

Mutates state · Returns object

Delete an eventstream

Terminal window
fabio eventstream delete --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--hard-delete bool No Permanently delete (cannot be recovered)

Mutates state · Destructive · Returns void

Get the definition of an eventstream

Terminal window
fabio eventstream get-definition --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--decode bool No Decode base64 payloads inline (adds decodedPayload field)

Read-only · Long-running operation · Returns object

Update the definition of an eventstream

Terminal window
fabio eventstream update-definition --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--file string No Definition file path (reads file content)
--content string No Definition content (inline)

Mutates state · Long-running operation · Returns void

Get the topology of an eventstream

Terminal window
fabio eventstream get-topology --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID

Read-only · Returns object

Pause the entire eventstream

Terminal window
fabio eventstream pause --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID

Mutates state · Returns object

Resume the entire eventstream

Terminal window
fabio eventstream resume --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--start-type string No Start type: Now (default), WhenLastStopped, or CustomTime
--custom-start-time string No Custom UTC start time (YYYY-MM-DDTHH:mm:ssZ); required for --start-type CustomTime

Mutates state · Returns object

Get details of a destination

Terminal window
fabio eventstream get-destination --workspace <value> --id <value> --destination-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--destination-id string Yes Destination ID

Read-only · Returns object

Get the connection of a destination

Terminal window
fabio eventstream get-destination-connection --workspace <value> --id <value> --destination-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--destination-id string Yes Destination ID

Read-only · Returns object

Pause a destination

Terminal window
fabio eventstream pause-destination --workspace <value> --id <value> --destination-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--destination-id string Yes Destination ID

Mutates state · Returns object

Resume a destination

Terminal window
fabio eventstream resume-destination --workspace <value> --id <value> --destination-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--destination-id string Yes Destination ID
--start-type string No Start type: Now (default), WhenLastStopped, or CustomTime
--custom-start-time string No Custom UTC start time (YYYY-MM-DDTHH:mm:ssZ); required for --start-type CustomTime

Mutates state · Returns object

Get details of a source

Terminal window
fabio eventstream get-source --workspace <value> --id <value> --source-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--source-id string Yes Source ID

Read-only · Returns object

Get the connection of a source

Terminal window
fabio eventstream get-source-connection --workspace <value> --id <value> --source-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--source-id string Yes Source ID

Examples

Terminal window
fabio eventstream get-source-connection --workspace $WS --id $ES --source-id $SRC

Read-only · Returns object

Pause a source

Terminal window
fabio eventstream pause-source --workspace <value> --id <value> --source-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--source-id string Yes Source ID

Mutates state · Returns object

Resume a source

Terminal window
fabio eventstream resume-source --workspace <value> --id <value> --source-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--source-id string Yes Source ID
--start-type string No Start type: Now (default), WhenLastStopped, or CustomTime
--custom-start-time string No Custom UTC start time (YYYY-MM-DDTHH:mm:ssZ); required for --start-type CustomTime

Mutates state · Returns object

Add a source to an eventstream (fetches current definition, merges, and updates)

Terminal window
fabio eventstream add-source --workspace <value> --id <value> --name <value> --source-type <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--name string Yes Source name (unique within the eventstream)
--source-type string Yes Source type (e.g., CustomEndpoint, AzureEventHub, SampleData)
--properties string No Source properties as JSON string (default: {})

Examples

Terminal window
fabio eventstream add-source --workspace $WS --id $ES --name "app-source" --source-type CustomEndpoint

Mutates state · Returns object

Add a destination to an eventstream (fetches current definition, merges, and updates)

Terminal window
fabio eventstream add-destination --workspace <value> --id <value> --name <value> --destination-type <value> --input-node <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--name string Yes Destination name (unique within the eventstream)
--destination-type string Yes Destination type (e.g., Eventhouse, Lakehouse, CustomEndpoint, Activator)
--properties string No Destination properties as JSON string
--input-node string Yes Input node name (the stream or operator this destination reads from)

Examples

Terminal window
fabio eventstream add-destination --workspace $WS --id $ES --name "kql-sink" --destination-type Eventhouse --input-node "app-source-stream" --properties '{"dataIngestionMode":"DirectIngestion","workspaceId":"'$WS'","itemId":"'$KDB'","tableName":"SensorEvents","connectionName":"es-conn-1","mappingRuleName":"JsonMapping"}'

Mutates state · Returns object

Add a sample data source to an eventstream (high-level helper)

Terminal window
fabio eventstream add-sample-source --workspace <value> --id <value> --name <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--name string Yes Source name (unique within the eventstream)
--sample-type string No Sample dataset: Bicycles, YellowTaxi, StockMarket, Buses (default: Bicycles)

Examples

Terminal window
fabio eventstream add-sample-source --workspace $WS --id $ES --name "test-data"

Mutates state · Returns object

Add a derived stream (filtered/transformed) between existing nodes

Terminal window
fabio eventstream add-derived-stream --workspace <value> --id <value> --name <value> --input-node <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--name string Yes Derived stream name (unique within the eventstream)
--input-node string Yes Input node name (the source or stream to derive from)
--properties string No Stream properties as JSON string (filter/transform config)

Examples

Terminal window
fabio eventstream add-derived-stream --workspace $WS --id $ES --name "high-temp-stream" --input-node "app-source-stream"

Mutates state · Returns object

Add an event-processor operator (Filter/ManageFields/Aggregate/GroupBy/Join/Union/Expand) node

Terminal window
fabio eventstream add-operator --workspace <value> --id <value> --name <value> --type <value> --input-node <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Eventstream ID
--name string Yes Operator name (unique within the eventstream)
--type string Yes Operator type: Filter, ManageFields, Aggregate, GroupBy, Join, Union, Expand
--input-node string Yes Input node name (the source, stream, or operator to transform)
--properties string No Operator properties as JSON string (operator-specific, e.g. Filter → {“conditions”:[…]})

Mutates state · Returns object

Validate an eventstream definition (client-side checks, no API call)

Terminal window
fabio eventstream validate
Flag Type Required Description
--workspace string No Workspace ID (used to fetch definition from server if –file not provided)
--id string No Eventstream ID (used to fetch definition from server if –file not provided)
--file string No Path to a local eventstream definition JSON file

Examples

Terminal window
fabio eventstream validate --file my-eventstream-def.json
Terminal window
fabio eventstream validate --workspace $WS --id $ES

Read-only · Returns object

List available eventstream component types (sources, destinations, operators)

Terminal window
fabio eventstream list-components
Flag Type Required Description
--category enum No Filter by category: source, destination, operator, all (default: all)

Examples

Terminal window
fabio eventstream list-components --category source
Terminal window
fabio eventstream list-components --category destination

Read-only · Returns list