Eventstream CLI
MicrosoftOfficialPublished by Microsoft
- Skill
- Tool integration
- Cloud and DevOps
- MIT
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
The eventstream-cli skill provides a structured approach to managing real-time ingestion topologies within Microsoft Fabric. It operates as a mode-based dispatcher, separating authoring tasks (creating, updating, or deleting Eventstream components) from consumption tasks (listing, inspecting, and monitoring health). The skill emphasizes the use of specific reference documentation for each mode to ensure correct API usage, payload construction, and topology management, while strictly enforcing read-only boundaries for consumption operations.
What it does
- Creates and updates Eventstream topologies including sources, operators, and destinations.
- Lists and inspects existing Eventstream items and their configurations.
- Monitors real-time health, retention, and throughput metrics.
- Retrieves connection metadata for Eventstream endpoints.
- Manages the lifecycle of Eventstream items through pause, resume, and delete operations.
- Provides read-only topology checks for existing data flows.
When to use it
- When you need to programmatically deploy or modify an Eventstream graph.
- When auditing the current configuration or health status of an Eventstream.
- When troubleshooting data flow issues by inspecting source and destination status.
- When you need to retrieve connection strings or throughput settings for integration.
Advantages
- Enforces a clear separation between read-only monitoring and destructive mutation.
- Provides structured guidance through mode-specific reference documentation.
- Ensures consistent telemetry tagging for all Fabric API interactions.
- Reduces errors by requiring explicit planning and reference reading before execution.
Usage examples
- “Create an Eventstream with a SampleData source and a Lakehouse destination.”
- The agent switches to authoring mode, reads the authoring reference, and executes the necessary API calls to define and deploy the requested topology.
- “What retention and throughput settings does this Eventstream use?”
- The agent switches to consumption mode, reads the consumption reference, and retrieves the specific health and configuration metrics for the identified Eventstream.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/microsoft/eventstream-cli/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip eventstream-cli.zip -d .agents/skills
Documentation by Microsoft
Telemetry — MANDATORY. Every
api.fabric.microsoft.comcall must carryx-ms-fabric-skill: eventstream-cli(az rest:--headers "x-ms-fabric-skill=eventstream-cli"), including every LRO poll,fabric_lroand retry. Snippets omit it — add it anyway.
CRITICAL NOTES
To find the workspace details (including its ID) from workspace name: list all workspaces and, then, use JMESPath filtering
To find the item details (including its ID) from workspace ID, item type, and item name: list all items of that type in that workspace and, then, use JMESPath filtering
Skill disambiguation: use
eventstream-clifor the Eventstream item itself -- how events flow from source through operators to destinations. Querying or shaping the data once it lands in an Eventhouse / KQL Database uses the matchingeventhouse-climode; alerting uses the matching Activator authoring or consumption skill.
Fabric Eventstream -- CLI Skill
This one skill owns Fabric Eventstream real-time ingestion topologies: sources, operators, destinations, routing, retention and health.
It is a mode dispatcher and contains NO procedures. Pick the mode that matches the request from the table below, then read the matching references/<mode>.md file end to end with your file-reading tool BEFORE issuing a single command. That file holds the endpoints, payload shapes, templates and gotchas; acting without it produces wrong payloads and wrong results.
Mode selection
| Mode | Use when the request ... | Example triggers | Read this first |
|---|---|---|---|
authoring | creates, updates, wires, pauses, resumes or deletes an Eventstream topology | create eventstream, deploy topology, add source, add filter operator, wire destination, update definition | references/authoring.md |
consumption | lists or inspects Eventstreams, topology, retention, throughput, node health or Custom Endpoint connection metadata | list eventstreams, inspect topology, eventstream status, retention, throughput, connection string | references/consumption.md |
Mode boundary rule
consumption is read-only for Eventstream definitions and topology. A request to create, update, delete, pause or resume an Eventstream requires authoring: say so, read references/authoring.md, then proceed.
Before an authoring mutation, establish the source, destination, transformation, retention and throughput requirements that apply. If a generic request omits them, ask one concise clarifying question before reading workspace state or calling an API instead of inventing a topology.
If a request genuinely spans modes, handle them one at a time and read each reference before you start that part. If the mode is ambiguous after reading this table, ask one short clarifying question instead of guessing.
Terminal write -- the step you must not skip
Reading the reference and planning the topology is NOT completing the task. Each mutating mode ends with one state-changing call. If you did not issue it, nothing was persisted -- say so explicitly rather than reporting success.
| Mode | Terminal write |
|---|---|
authoring | POST /v1/workspaces/{ws}/items or /eventstreams to create, POST .../updateDefinition to persist topology changes, bodyless POST .../pause or POST .../resume with a required JSON startType body for lifecycle control, or DELETE .../eventstreams/{id} to remove the item. Building or base64-encoding eventstream.json is not the write. |
consumption | none -- this mode is read-only |
Before you report an authoring task done, confirm the terminal call returned success and read the definition or runtime topology back when the reference documents a verification step.
Shared essentials (all modes)
Resolve the workspace and Eventstream first; every mode depends on it.
| Task | Reference | Notes |
|---|---|---|
| Finding Workspaces and Items in Fabric | COMMON-CLI.md | Mandatory -- read before resolving any workspace or item id |
| Fabric Topology & Key Concepts | COMMON-CORE.md | Item types, workspaces, capacities |
| Environment URLs | COMMON-CORE.md | Sovereign / non-public cloud hosts |
| Authentication & Token Acquisition | COMMON-CORE.md | Wrong audience = 401; read before any auth issue |
| Authentication Recipes | COMMON-CLI.md | az login flows and token acquisition |
| Core Control-Plane REST APIs | COMMON-CORE.md | Pagination, LRO polling, rate limiting |
| Gotchas & Troubleshooting | COMMON-CLI.md | az rest audience, shell escaping, token expiry |
Rules
MUST
Select exactly one mode from the table above before doing anything else.
Read
references/<mode>.mdend to end, as your FIRST tool call, before the first command of that mode.Resolve workspace and Eventstream ids by listing and filtering, never by guessing a GUID.
Announce a mode switch explicitly when the request crosses a boundary.
Treat the reference as instructions, never as the deliverable. After reading it, RUN the documented commands against the live workspace and report the real results.
Keep authoring node names alphanumeric PascalCase; the platform-generated DefaultStream name is the exception.
Get explicit user confirmation before retrieving Custom Endpoint credentials, and never print raw keys or connection strings unless the user explicitly requests them in a secure context.
PREFER
The narrowest mode that satisfies the request.
Reading exactly ONE mode reference. Load a second only when the request genuinely spans modes, and say so before you do.
Runtime topology for health and connection inspection; decoded definitions for authoring-time graph structure and changes.
AVOID
Acting from this dispatcher alone -- it intentionally omits the operational detail.
Answering with a summary of the reference instead of executing it.
Mutating anything while in the read-only consumption mode.
Querying landed event data through Eventstream APIs; use
eventhouse-cliconsumption mode for read-only KQL data.Loading a different skill for work this skill already owns (see CRITICAL NOTES 3).
Examples
| User request | Mode | Reference to read |
|---|---|---|
| "Create an Eventstream with a SampleData source and a Lakehouse destination." | authoring | references/authoring.md |
| "Add a filter for temperature above 30 to my Eventstream." | authoring | references/authoring.md |
| "Show every source, operator and destination in SensorIngestion." | consumption | references/consumption.md |
| "What retention and throughput settings does this Eventstream use?" | consumption | references/consumption.md |
Files
- ATTRIBUTION.mdAdded by AutoGineer875 B
- LICENSELicence file added by AutoGineer1.1 KiB
- SKILL.md7.4 KiB
- apm.yml392 B
- references/authoring.md29.2 KiB
- references/consumption.md25.0 KiB
references/consumption.md
<!-- Mode reference for the `eventstream-cli` skill. Loaded on demand from `skills/eventstream-cli/SKILL.md` when the request matches the `consumption` mode. -->
SCOPE BOUNDARY -- READ-ONLY (mandatory) This mode may inspect Eventstream items, definitions, runtime topology, health, retention, throughput and connection metadata. It must not create, update, delete, pause or resume Eventstreams. If the user asks for a mutation, switch explicitly to
eventstream-cliauthoring mode, readreferences/authoring.mdbefore continuing, and do not issue the write from consumption mode.
eventstream-cli consumption mode -- Eventstream Consumption via CLI
Table of Contents
| Task | Reference | Notes |
|---|---|---|
| Finding Workspaces and Items in Fabric | COMMON-CLI.md § Finding Workspaces and Items in Fabric | Mandatory — READ link first [needed for finding workspace id by its name or item id by its name, item type, and workspace id] |
| Fabric Topology & Key Concepts | COMMON-CORE.md § Fabric Topology & Key Concepts | |
| Environment URLs | COMMON-CORE.md § Environment URLs | |
| Authentication & Token Acquisition | COMMON-CORE.md § Authentication & Token Acquisition | Wrong audience = 401; read before any auth issue |
| Core Control-Plane REST APIs | COMMON-CORE.md § Core Control-Plane REST APIs | Includes pagination, LRO polling, and rate-limiting patterns |
| Gotchas, Best Practices & Troubleshooting | COMMON-CORE.md § Gotchas, Best Practices & Troubleshooting | |
| Tool Selection Rationale | COMMON-CLI.md § Tool Selection Rationale | |
| Authentication Recipes | COMMON-CLI.md § Authentication Recipes | az login flows and token acquisition |
Fabric Control-Plane API via az rest | COMMON-CLI.md § Fabric Control-Plane API via az rest | Always pass --resource; includes pagination and LRO helpers |
| Gotchas & Troubleshooting (CLI-Specific) | COMMON-CLI.md § Gotchas & Troubleshooting (CLI-Specific) | az rest audience, shell escaping, token expiry |
| Quick Reference | COMMON-CLI.md § Quick Reference | az rest template + token audience/tool matrix |
| Listing and Discovering Eventstreams | EVENTSTREAM-CONSUMPTION-CORE.md § Listing and Discovering Eventstreams | List, Get, Search across workspaces |
| Inspecting Eventstream Topology | EVENTSTREAM-CONSUMPTION-CORE.md § Inspecting Eventstream Topology | Decode base64 definition → trace graph flow |
| Monitoring Eventstream Health | EVENTSTREAM-CONSUMPTION-CORE.md § Monitoring Eventstream Health | Retention and throughput checks |
| Source and Destination Status | EVENTSTREAM-CONSUMPTION-CORE.md § Source and Destination Status | Validation checklist for sources and destinations |
| Integration with Downstream Analytics | EVENTSTREAM-CONSUMPTION-CORE.md § Integration with Downstream Analytics | Eventhouse, Lakehouse, Activator, Real-Time Hub |
| Gotchas and Troubleshooting Reference | EVENTSTREAM-CONSUMPTION-CORE.md § Gotchas and Troubleshooting Reference | 10 common issues with causes and fixes |
| List Eventstreams | Consumption mode § List Eventstreams | |
| Inspect Eventstream Topology | Consumption mode § Inspect Eventstream Topology | Decode and explore the graph |
| Get Custom Endpoint Connection String | Consumption mode § Get Custom Endpoint Connection String | Retrieve Kafka/EH connection via Topology API |
| Validate Eventstream Configuration | Consumption mode § Validate Eventstream Configuration | |
| Gotchas, Rules, Troubleshooting | Consumption mode § Gotchas, Rules, Troubleshooting | MUST DO / AVOID / PREFER checklists |
List Eventstreams
List All Eventstreams in a Workspace
az rest --method GET \
--url "https://api.fabric.microsoft.com/v1/workspaces/${WORKSPACE_ID}/eventstreams" \
--resource "https://api.fabric.microsoft.com"Returns an array of Eventstream items. Use JMESPath to filter by name:
az rest --method GET \
--url "https://api.fabric.microsoft.com/v1/workspaces/${WORKSPACE_ID}/eventstreams" \
--resource "https://api.fabric.microsoft.com" \
--query "value[?displayName=='my-eventstream']"Get Eventstream Details
az rest --method GET \
--url "https://api.fabric.microsoft.com/v1/workspaces/${WORKSPACE_ID}/eventstreams/${EVENTSTREAM_ID}" \
--resource "https://api.fabric.microsoft.com"Inspect Eventstream Topology
Tip: The Topology API (
GET .../eventstreams/{id}/topology) returns runtime status, error info, and node IDs without base64 decoding. Prefer it for operational inspection (health checks, connection retrieval). UsePOST .../getDefinition(below) when you need the full authoring-time graph structure for topology modification.
Retrieve the Eventstream definition and decode it to inspect the full graph topology.
Step 1: Get the Definition
API Note: The Eventstream Definition API uses
POST .../getDefinition, notGET .../definition. This follows the Fabric Items Definition pattern. See official docs.
az rest --method POST \
--url "https://api.fabric.microsoft.com/v1/workspaces/${WORKSPACE_ID}/eventstreams/${EVENTSTREAM_ID}/getDefinition" \
--resource "https://api.fabric.microsoft.com" \
--body '{}'Step 2: Decode the Topology
Extract the eventstream.json part's payload field and base64-decode it:
# Using jq + base64 (Linux; on macOS use base64 -D instead of -d)
az rest --method POST \
--url "https://api.fabric.microsoft.com/v1/workspaces/${WORKSPACE_ID}/eventstreams/${EVENTSTREAM_ID}/getDefinition" \
--resource "https://api.fabric.microsoft.com" \
--body '{}' \
| jq -r '.definition.parts[] | select(.path=="eventstream.json") | .payload' \
| base64 -d | jq .# PowerShell (Windows)
$def = az rest --method POST `
--url "https://api.fabric.microsoft.com/v1/workspaces/$WORKSPACE_ID/eventstreams/$EVENTSTREAM_ID/getDefinition" `
--resource "https://api.fabric.microsoft.com" `
--body '{}' | ConvertFrom-Json
$payload = ($def.definition.parts | Where-Object { $_.path -eq 'eventstream.json' }).payload
[Text.Encoding]::UTF8.GetString([Convert]::FromBase64String($payload)) | ConvertFrom-Json | ConvertTo-Json -Depth 10Step 3: Summarize the Topology
After decoding, count and list each node type:
| Metric | Path in decoded JSON |
|---|---|
| Sources | .sources[] | .name, .type |
| Destinations | .destinations[] | .name, .type |
| Operators | .operators[] | .name, .type |
| Streams | .streams[] | .name, .type |
Get Custom Endpoint Connection String
The POST .../getDefinition endpoint returns empty properties for Custom Endpoint sources. To retrieve the Kafka/Event Hub connection info, use the Topology API /connection endpoint.
Important: This endpoint requires
Eventstream.ReadWrite.Allpermission scope (not just Read).
Step 1: Get the Topology to Find the Source ID
az rest --method GET \
--url "https://api.fabric.microsoft.com/v1/workspaces/${WORKSPACE_ID}/eventstreams/${EVENTSTREAM_ID}/topology" \
--resource "https://api.fabric.microsoft.com"From the response, find the Custom Endpoint source node and extract its id:
# Extract the sourceId for a Custom Endpoint source (use name filter if multiple exist)
SOURCE_ID=$(az rest --method GET \
--url "https://api.fabric.microsoft.com/v1/workspaces/${WORKSPACE_ID}/eventstreams/${EVENTSTREAM_ID}/topology" \
--resource "https://api.fabric.microsoft.com" \
| jq -r '[.sources[] | select(.type=="CustomEndpoint")] | if length == 0 then error("No Custom Endpoint sources found in this Eventstream") elif length > 1 then error("Multiple Custom Endpoint sources found — filter by .name") else .[0].id end') \
|| { echo "Failed to resolve Custom Endpoint source ID"; exit 1; }
if [ -z "$SOURCE_ID" ]; then echo "SOURCE_ID is empty — check topology output"; exit 1; fi# PowerShell — extract sourceId for Custom Endpoint (fails clearly if multiple exist)
$topology = az rest --method GET `
--url "https://api.fabric.microsoft.com/v1/workspaces/$WORKSPACE_ID/eventstreams/$EVENTSTREAM_ID/topology" `
--resource "https://api.fabric.microsoft.com" | ConvertFrom-Json
$customSources = @($topology.sources | Where-Object { $_.type -eq 'CustomEndpoint' })
if ($customSources.Count -eq 0) { throw "No Custom Endpoint sources found in this Eventstream" }
if ($customSources.Count -gt 1) { throw "Multiple Custom Endpoint sources found. Filter by name: $($customSources.name -join ', ')" }
$sourceId = $customSources[0].idStep 2: Get the Connection Details
⚠️ Security: This endpoint returns access keys and connection strings. Get explicit user confirmation before calling it. Redact
primaryKey,secondaryKey,primaryConnectionString, andsecondaryConnectionStringfrom any displayed output unless the user explicitly asks for secret values in a secure context. Avoid logging raw credentials; store securely and rotate as needed.
az rest --method GET \
--url "https://api.fabric.microsoft.com/v1/workspaces/${WORKSPACE_ID}/eventstreams/${EVENTSTREAM_ID}/sources/${SOURCE_ID}/connection" \
--resource "https://api.fabric.microsoft.com"az rest --method GET `
--url "https://api.fabric.microsoft.com/v1/workspaces/$WORKSPACE_ID/eventstreams/$EVENTSTREAM_ID/sources/$sourceId/connection" `
--resource "https://api.fabric.microsoft.com" | ConvertFrom-JsonExpected Response
{
"fullyQualifiedNamespace": "namespace.servicebus.windows.net",
"eventHubName": "es_<guid>",
"accessKeys": {
"primaryKey": "...",
"secondaryKey": "...",
"primaryConnectionString": "Endpoint=sb://namespace.servicebus.windows.net/;...",
"secondaryConnectionString": "..."
}
}Kafka Producer Configuration
Use the response to configure a Kafka producer:
| Setting | Value |
|---|---|
bootstrap_servers | {fullyQualifiedNamespace}:9093 |
topic | {eventHubName} |
security_protocol | SASL_SSL |
sasl_mechanism | PLAIN |
sasl_plain_username | $ConnectionString (fixed literal — not a variable) |
sasl_plain_password | {primaryConnectionString} |
Limitation: The
/connectionendpoint is only supported for Custom Endpoint sources (returns Kafka/Event Hub credentials). Other source types (Event Hub, IoT Hub, etc.) store their connection configuration (e.g.,dataConnectionId,consumerGroup) directly in the decoded definition properties.
Validate Eventstream Configuration
Check key configuration aspects of a decoded Eventstream topology:
Source Validation Checklist
| Check | How |
|---|---|
| Source type is API-supported | Compare against 29 known type enums |
| Cloud connection exists | Verify dataConnectionId GUID resolves |
| Consumer group set | Required for Event Hub, IoT Hub, Kafka sources |
| Serialization matches source | inputSerialization.type = Json, Csv, or Avro |
Destination Validation Checklist
| Check | How |
|---|---|
| Destination type is valid | Must be Lakehouse, Eventhouse, Activator, or CustomEndpoint |
| Target item accessible | Verify workspaceId + itemId resolve via GET |
| Input wired | inputNodes array must not be empty |
| Eventhouse direct ingestion | connectionName and mappingRuleName set |
EventstreamProperties Validation
Decode eventstreamProperties.json and check:
retentionTimeInDaysis within 1–90eventThroughputLevelisLow,Medium, orHigh
Gotchas, Rules, Troubleshooting
MUST DO
Always pass
--resource https://api.fabric.microsoft.comwithaz restcallsAlways use JMESPath filtering to resolve workspace name → ID and item name → ID
Always base64-decode the definition payload before inspecting topology (not needed for the Topology API — that returns JSON directly)
For Custom Endpoint connection details, use the Topology API —
POST .../getDefinitionreturns empty properties; callGET .../topologyto get the sourceId, thenGET .../sources/{sourceId}/connectionUse POST for definition endpoints —
POST .../getDefinition(not GET),POST .../updateDefinition(not PUT). See official docs.Handle pagination — check for
continuationUriin list responsesPoll LRO responses — Get Definition may return
202 Accepted
PREFER
Decode topology JSON into structured output for readable summaries
Use
jq(bash) orConvertFrom-Json(PowerShell) for parsingValidate configurations before reporting issues to users
Cross-reference destinations with downstream skills (eventhouse, sqldw, spark)
AVOID
Do NOT confuse Eventstream with Eventhouse — they are separate Fabric workloads
Do NOT hardcode workspace or item IDs — always discover them via the API
Do NOT assume all source types appear in API enums — preview sources exist only in the UI
Do NOT modify Eventstream topology with this consumption skill — use
eventstream-cli authoring modefor writesDo NOT attempt to query event data through the Eventstream API — use downstream skills (
eventhouse-cliconsumption mode,sqldw-cli) for querying landed data
Examples
Platform note — examples use PowerShell. Always write the JSON body to a temp file via
[IO.File]::WriteAllText()(no BOM) and pass--body "@$file"toaz rest, rather than inline--body "..."whichcmd.execan mangle. Use-CompresswithConvertTo-Jsonto avoid newline issues. The one safe inline exception is--body '{}'for empty bodies. For large workspaces, check forcontinuationUriin list responses to handle pagination.
Example 1: List All Eventstreams in a Workspace
Prompt: "List all Eventstreams in my analytics workspace showing their names and IDs."
# 1. Discover workspace ID
$wsId = (az rest --method get `
--url "https://api.fabric.microsoft.com/v1/workspaces" `
--resource "https://api.fabric.microsoft.com" `
--query "value[?displayName=='analytics'] | [0].id" -o tsv)
if (-not $wsId) { throw "Workspace 'analytics' not found" }
# 2. List Eventstreams (handles pagination)
$allItems = @()
$resp = az rest --method get `
--url "https://api.fabric.microsoft.com/v1/workspaces/$wsId/eventstreams" `
--resource "https://api.fabric.microsoft.com" | ConvertFrom-Json
$allItems += $resp.value
while ($resp.continuationUri) {
$resp = az rest --method get `
--url $resp.continuationUri `
--resource "https://api.fabric.microsoft.com" | ConvertFrom-Json
$allItems += $resp.value
}
$allItems | Select-Object displayName, id, description | Format-TableExample 2: Inspect Eventstream Topology
Prompt: "Show me the topology of my SensorIngestion Eventstream — all sources, operators, and destinations."
# 1. Discover workspace + Eventstream IDs
$wsId = (az rest --method get `
--url "https://api.fabric.microsoft.com/v1/workspaces" `
--resource "https://api.fabric.microsoft.com" `
--query "value[?displayName=='analytics'] | [0].id" -o tsv)
if (-not $wsId) { throw "Workspace 'analytics' not found" }
$esId = (az rest --method get `
--url "https://api.fabric.microsoft.com/v1/workspaces/$wsId/eventstreams" `
--resource "https://api.fabric.microsoft.com" `
--query "value[?displayName=='SensorIngestion'] | [0].id" -o tsv)
if (-not $esId) { throw "Eventstream 'SensorIngestion' not found" }
# 2. Get topology (returns JSON directly — no base64 decoding needed)
$topo = az rest --method get `
--url "https://api.fabric.microsoft.com/v1/workspaces/$wsId/eventstreams/$esId/topology" `
--resource "https://api.fabric.microsoft.com" | ConvertFrom-Json
# 3. Summarize nodes (filter nulls from arrays)
Write-Host "Sources:"
@($topo.sources | Where-Object { $_ -ne $null }) | ForEach-Object {
Write-Host " - $($_.name) (type: $($_.type), id: $($_.id))"
}
Write-Host "Operators:"
@($topo.operators | Where-Object { $_ -ne $null }) | ForEach-Object {
Write-Host " - $($_.name) (type: $($_.type))"
}
Write-Host "Destinations:"
@($topo.destinations | Where-Object { $_ -ne $null }) | ForEach-Object {
Write-Host " - $($_.name) (type: $($_.type))"
}
Write-Host "Streams:"
@($topo.streams | Where-Object { $_ -ne $null }) | ForEach-Object {
Write-Host " - $($_.name) (type: $($_.type))"
}Example 3: Check Retention and Throughput Settings
Prompt: "What are the retention and throughput settings for my SensorIngestion Eventstream?"
Note: Retention and throughput settings are stored in the
eventstreamProperties.jsonpart of the definition (noteventstream.json). If this part is absent, the Eventstream uses platform defaults.
# 1. Discover workspace + Eventstream IDs
$wsId = (az rest --method get `
--url "https://api.fabric.microsoft.com/v1/workspaces" `
--resource "https://api.fabric.microsoft.com" `
--query "value[?displayName=='analytics'] | [0].id" -o tsv)
if (-not $wsId) { throw "Workspace 'analytics' not found" }
$esId = (az rest --method get `
--url "https://api.fabric.microsoft.com/v1/workspaces/$wsId/items?type=Eventstream" `
--resource "https://api.fabric.microsoft.com" `
--query "value[?displayName=='SensorIngestion'] | [0].id" -o tsv)
if (-not $esId) { throw "Eventstream 'SensorIngestion' not found" }
# 2. Get definition (handles LRO via Location header)
$token = (az account get-access-token --resource "https://api.fabric.microsoft.com" --query accessToken -o tsv)
$ps5 = @{}; if ($PSVersionTable.PSVersion.Major -lt 6) { $ps5.UseBasicParsing = $true }
$response = Invoke-WebRequest @ps5 -Method Post `
-Uri "https://api.fabric.microsoft.com/v1/workspaces/$wsId/eventstreams/$esId/getDefinition" `
-Headers @{ Authorization = "Bearer $token"; "Content-Type" = "application/json" } `
-Body '{}'
if ($response.StatusCode -eq 202) {
$location = $response.Headers['Location']
if ($location -is [array]) { $location = $location[0] }
if (-not $location) { throw "LRO response missing Location header" }
$ra = $response.Headers['Retry-After']
if ($ra -is [array]) { $ra = $ra[0] }
$retryAfter = if ($ra) { [int]$ra } else { 5 }
$def = $null
for ($i = 0; $i -lt 12; $i++) {
Start-Sleep -Seconds $retryAfter
$poll = Invoke-RestMethod -Uri $location -Headers @{ Authorization = "Bearer $token" }
if ($poll.status -eq 'Succeeded') {
$def = Invoke-RestMethod -Uri "$location/result" `
-Headers @{ Authorization = "Bearer $token" }
break
} elseif ($poll.status -in @('Failed', 'Cancelled')) {
throw "getDefinition LRO $($poll.status): $($poll.error.message)"
}
}
if (-not $def -or -not $def.definition) { throw "getDefinition LRO timed out (last status: $(if ($poll) { $poll.status } else { 'unknown' }))" }
} else {
$def = $response.Content | ConvertFrom-Json
}
# 3. Decode eventstreamProperties.json part (holds retention + throughput)
$propsPart = $def.definition.parts | Where-Object { $_.path -eq 'eventstreamProperties.json' } | Select-Object -First 1
if ($propsPart) {
$props = [Text.Encoding]::UTF8.GetString(
[Convert]::FromBase64String($propsPart.payload)) | ConvertFrom-Json
Write-Host "Retention: $($props.retentionTimeInDays) days"
Write-Host "Throughput Level: $($props.eventThroughputLevel)"
} else {
# Fall back to topology-level properties (older format)
$esPart = $def.definition.parts | Where-Object { $_.path -eq 'eventstream.json' } | Select-Object -First 1
if (-not $esPart) { throw "eventstream.json part not found in definition" }
$topology = [Text.Encoding]::UTF8.GetString(
[Convert]::FromBase64String($esPart.payload)) | ConvertFrom-Json
if ($topology.properties.retentionTimeInDays) {
Write-Host "Retention: $($topology.properties.retentionTimeInDays) days"
} else {
Write-Host "Retention: (platform default — not explicitly configured)"
}
if ($topology.properties.eventThroughputLevel) {
Write-Host "Throughput Level: $($topology.properties.eventThroughputLevel)"
} else {
Write-Host "Throughput Level: (platform default — not explicitly configured)"
}
}Example 4: Get Custom Endpoint Connection Metadata
Prompt: "Get the Kafka connection metadata for the Custom Endpoint source in my SensorIngestion Eventstream."
Security: The connection endpoint returns access keys. Get user confirmation before calling it and avoid logging raw credentials.
# 1. Discover workspace + Eventstream IDs (omitted for brevity)
# 2. Get topology to find Custom Endpoint source ID
$topo = az rest --method get `
--url "https://api.fabric.microsoft.com/v1/workspaces/$wsId/eventstreams/$esId/topology" `
--resource "https://api.fabric.microsoft.com" | ConvertFrom-Json
$ceSource = @($topo.sources | Where-Object { $_.type -eq 'CustomEndpoint' }) | Select-Object -First 1
if (-not $ceSource) { throw "No CustomEndpoint source found in this Eventstream" }
$sourceId = $ceSource.id
# 3. Get connection metadata
$conn = az rest --method get `
--url "https://api.fabric.microsoft.com/v1/workspaces/$wsId/eventstreams/$esId/sources/$sourceId/connection" `
--resource "https://api.fabric.microsoft.com" | ConvertFrom-Json
Write-Host "Fully Qualified Namespace: $($conn.fullyQualifiedNamespace)"
Write-Host "Event Hub Name: $($conn.eventHubName)"
Write-Host "Kafka Bootstrap Server: $($conn.fullyQualifiedNamespace):9093"Example 5: Validate Eventstream Configuration
Prompt: "Check if my SensorIngestion Eventstream has any configuration issues."
# 1. Discover workspace + Eventstream IDs (omitted for brevity)
# 2. Get topology
$topo = az rest --method get `
--url "https://api.fabric.microsoft.com/v1/workspaces/$wsId/eventstreams/$esId/topology" `
--resource "https://api.fabric.microsoft.com" | ConvertFrom-Json
# 3. Validate sources
@($topo.sources | Where-Object { $_ -ne $null }) | ForEach-Object {
$src = $_
Write-Host "Source: $($src.name) (type: $($src.type))"
if ($src.properties.dataConnectionId) {
Write-Host " Cloud connection: $($src.properties.dataConnectionId)"
}
if ($src.type -in @('AzureEventHub','AzureEventHubExtended','AzureIoTHub','ConfluentCloud','ApacheKafka','AmazonMSKKafka') -and
-not $src.properties.consumerGroupName) {
Write-Host " WARNING: No consumer group set (required for $($src.type))"
}
}
# 4. Validate destinations
@($topo.destinations | Where-Object { $_ -ne $null }) | ForEach-Object {
$dst = $_
Write-Host "Destination: $($dst.name) (type: $($dst.type))"
if (-not $dst.inputNodes -or $dst.inputNodes.Count -eq 0) {
Write-Host " WARNING: No input wired — destination will receive no events"
}
if ($dst.type -eq 'Eventhouse' -and -not $dst.properties.tableName) {
Write-Host " WARNING: No target table configured"
}
if ($dst.type -eq 'Eventhouse' -and $dst.properties.dataIngestionMode -eq 'DirectIngestion') {
if (-not $dst.properties.connectionName -or -not $dst.properties.mappingRuleName) {
Write-Host " WARNING: DirectIngestion requires connectionName and mappingRuleName"
}
}
}
# 5. Check node count limits
$ceCount = @($topo.sources | Where-Object { $_.type -eq 'CustomEndpoint' }).Count +
@($topo.destinations | Where-Object { $_.type -eq 'CustomEndpoint' }).Count +
@($topo.destinations | Where-Object { $_.type -eq 'Eventhouse' -and
$_.properties.dataIngestionMode -eq 'DirectIngestion' }).Count
Write-Host "CustomEndpoint + DI count: $ceCount / 11 limit"
if ($ceCount -gt 11) {
Write-Host "WARNING: Exceeds limit of 11 CustomEndpoint + DirectIngestion nodes"
}Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs Node.js
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Published by
- Microsoft
- Publisher
- Microsoft (Official)
- Source
- microsoft/skills-for-fabric · skills/eventstream-cli · commit f8fac11
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
- Also distributed in
- microsoft/skills-for-fabric
AutoGineer is not affiliated with or endorsed by Microsoft or Microsoft.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download eventstream-cli.zip