eventstream
Manage eventstreams (real-time data ingestion)
Authentication scope: fabric
List eventstreams in a workspace
fabio eventstream list --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
Read-only · Returns list
Show details of an eventstream
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
Section titled “create”Create a new eventstream
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
fabio eventstream create --workspace $WS --name "SensorIngestion"Mutates state · Returns object
update
Section titled “update”Update eventstream properties (name and/or description)
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
Section titled “delete”Delete an eventstream
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-definition
Section titled “get-definition”Get the definition of an eventstream
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-definition
Section titled “update-definition”Update the definition of an eventstream
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-topology
Section titled “get-topology”Get the topology of an eventstream
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
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
Section titled “resume”Resume the entire eventstream
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-destination
Section titled “get-destination”Get details of a destination
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-destination-connection
Section titled “get-destination-connection”Get the connection of a destination
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-destination
Section titled “pause-destination”Pause a destination
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-destination
Section titled “resume-destination”Resume a destination
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-source
Section titled “get-source”Get details of a source
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-source-connection
Section titled “get-source-connection”Get the connection of a source
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
fabio eventstream get-source-connection --workspace $WS --id $ES --source-id $SRCRead-only · Returns object
pause-source
Section titled “pause-source”Pause a source
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-source
Section titled “resume-source”Resume a source
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-source
Section titled “add-source”Add a source to an eventstream (fetches current definition, merges, and updates)
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
fabio eventstream add-source --workspace $WS --id $ES --name "app-source" --source-type CustomEndpointMutates state · Returns object
add-destination
Section titled “add-destination”Add a destination to an eventstream (fetches current definition, merges, and updates)
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
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-sample-source
Section titled “add-sample-source”Add a sample data source to an eventstream (high-level helper)
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
fabio eventstream add-sample-source --workspace $WS --id $ES --name "test-data"Mutates state · Returns object
add-derived-stream
Section titled “add-derived-stream”Add a derived stream (filtered/transformed) between existing nodes
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
fabio eventstream add-derived-stream --workspace $WS --id $ES --name "high-temp-stream" --input-node "app-source-stream"Mutates state · Returns object
add-operator
Section titled “add-operator”Add an event-processor operator (Filter/ManageFields/Aggregate/GroupBy/Join/Union/Expand) node
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
Section titled “validate”Validate an eventstream definition (client-side checks, no API call)
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
fabio eventstream validate --file my-eventstream-def.jsonfabio eventstream validate --workspace $WS --id $ESRead-only · Returns object
list-components
Section titled “list-components”List available eventstream component types (sources, destinations, operators)
fabio eventstream list-components| Flag | Type | Required | Description |
|---|---|---|---|
--category |
enum |
No | Filter by category: source, destination, operator, all (default: all) |
Examples
fabio eventstream list-components --category sourcefabio eventstream list-components --category destinationRead-only · Returns list
