opensource/sim
3
0
Fork 0
mirror of https://github.com/simstudioai/sim.git synced 2026-09-24 15:45:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(integrations): add Azure Data Explorer (#6701)

Browse Source 
* feat(integrations): add Azure Data Explorer

Add a 14-operation Azure Data Explorer (Kusto) integration covering KQL
queries, schema and metadata discovery, table management, inline and
query-sourced ingestion, ingestion-failure triage, and arbitrary
management commands.

Authentication uses a Microsoft Entra service principal through an
internal proxy route, since the Kusto token audience is per-cluster and
cannot be expressed as a static-scope OAuth provider.

* fix(azure-data-explorer): only read partial-failure status from the QueryStatus table

Scanning every returned table for Severity and StatusDescription columns
misread an ordinary query as a failed request whenever the user's own
result selected columns of those names — a common shape for a log table.

Failure detection now consults only the table the response's table of
contents names as QueryStatus, and primary-result selection reuses the
same index instead of re-reading it.

* fix(azure-data-explorer): keep the Show Operations and Show Table Details cards from painting empty

check:canvas-sentences flagged the Show Operations sentence: it anchored
`core` on operationId, which is an advanced-mode optional field, so an
untouched card resolved to nothing and painted empty. Show Table Details
had the same shape in milder form — table is optional there, since
omitting it describes every table, leaving a dangling preposition.

Both now lead with literal copy and treat their field as an optional
refinement. Also simplifies the primary-table condition to a single
`!= null` check.

* fix(azure-data-explorer): authenticate sovereign clusters against their own Entra authority

The cluster allowlist accepted Azure China and US Government hosts, but
every token request went to login.microsoftonline.com. Those clouds are
isolated instances with their own Entra endpoints, so a sovereign cluster
passed URI validation and then could never obtain a token.

Each Kusto service domain is now declared alongside the authority that
issues tokens for it, so the two cannot drift apart, and the authority is
part of the token cache key.

* improvement(azure-data-explorer): warn that ingest-from-query matches columns by position

Kusto aligns an ingested query result to the target table on column type
and order, never on column name, so a query projecting the right columns
in the wrong order lands data in the wrong columns without erroring.

Surfaces that in the tool description and param the model reads, in the
wand prompt that generates the query, in the rollup skill's steps, and in
the docs. Also verifies the target schema first rather than after.

* chore(azure-data-explorer): drop the unsourced kustomfa host from the cluster allowlist

Every other entry traces to a Microsoft reference — the Kusto
connection-string doc, the national-cloud endpoint tables, and the Fabric
KQL-database REST reference. kustomfa.windows.net does not, and the
connection-string doc states the trust boundary as hostnames ending in
kusto.windows.net.

An allowlist should only hold hosts we can justify, so this drops it and
records the sourcing standard for anything added later.

* fix(azure-data-explorer): handle commas inside quoted properties and empty extent IDs

Two defects in the shared command helpers:

buildWithClause split the property list on every comma before validating,
so a value that legally contains one — a docstring sentence, or a tags
array with more than one entry — was torn in half and rejected. Splitting
is now quote-aware, and an unterminated quote is rejected outright rather
than swallowing the rest of the clause.

transformColumnListResponse dropped empty strings, but `.ingest inline`
reports "no data shards were generated" as a single record carrying an
empty extent ID. A no-op load therefore looked like a missing column
instead of an empty result. Only non-strings are skipped now.
This commit is contained in:
Waleed
2026-08-14 12:27:13 -07:00
committed by GitHub
parent 1d342722ad
commit a7115e87ee
36 changed files with 4790 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs/components/icons.tsx
+132
View File
@@ -3898,6 +3898,138 @@ export const ClaudeIcon = (props: SVGProps<SVGSVGElement>) => (
</svg>
)
export function AzureDataExplorerIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const wedgeGradient = `adx_wedge_${id}`
const dashLongGradient = `adx_dash_long_${id}`
const dashTopGradient = `adx_dash_top_${id}`
const dashBottomGradient = `adx_dash_bottom_${id}`
return (
<svg
{...props}
width='18'
height='18'
viewBox='0 0 18 18'
fill='none'
xmlns='http://www.w3.org/2000/svg'
>
<path
d='M1.47,1.47,16.53,16.53a.57.57,0,0,0,1-.4V1.07A.57.57,0,0,0,16.93.5H1.87A.57.57,0,0,0,1.47,1.47Z'
fill={`url(#${wedgeGradient})`}
/>
<path d='M5.53,5.53l6.94,6.94,5-5V1.07A.57.57,0,0,0,16.93.5H10.56Z' fill='#50e6ff' />
<rect
x='-0.38'
y='12.85'
width='9.37'
height='1.7'
rx='0.27'
transform='translate(-8.43 7.06) rotate(-45)'
fill={`url(#${dashLongGradient})`}
/>
<rect
x='0.12'
y='9.23'
width='5.99'
height='1.7'
rx='0.27'
transform='translate(-6.22 5.15) rotate(-45)'
fill={`url(#${dashTopGradient})`}
/>
<rect
x='4.89'
y='14.04'
width='5.99'
height='1.7'
rx='0.27'
transform='translate(-8.22 9.93) rotate(-45)'
fill={`url(#${dashBottomGradient})`}
/>
<rect
x='9.19'
y='4.75'
width='1.7'
height='1.7'
rx='0.38'
transform='translate(-1.02 8.74) rotate(-45)'
fill='#fff'
/>
<rect
x='11.59'
y='2.35'
width='1.7'
height='1.7'
rx='0.38'
transform='translate(1.38 9.73) rotate(-45)'
fill='#fff'
/>
<rect
x='11.59'
y='7.15'
width='1.7'
height='1.7'
rx='0.38'
transform='translate(-2.01 11.14) rotate(-45)'
fill='#fff'
/>
<path
d='M13.91,5.33l.66-.66a.38.38,0,0,1,.54,0l.66.66a.38.38,0,0,1,0,.54l-.66.66a.38.38,0,0,1-.54,0l-.66-.66a.38.38,0,0,1,0-.54'
fill='#fff'
/>
<defs>
<linearGradient
id={wedgeGradient}
x1='1.3'
y1='8.6'
x2='17.5'
y2='8.6'
gradientUnits='userSpaceOnUse'
>
<stop offset='0.1' stopColor='#54aef0' />
<stop offset='1' stopColor='#1988d9' />
</linearGradient>
<linearGradient
id={dashLongGradient}
x1='0.5'
y1='13.7'
x2='8.11'
y2='13.7'
gradientTransform='translate(10.95 0.97) rotate(45)'
gradientUnits='userSpaceOnUse'
>
<stop offset='0' stopColor='#b3b2b3' />
<stop offset='1' stopColor='#979797' />
</linearGradient>
<linearGradient
id={dashTopGradient}
x1='0.5'
y1='10.08'
x2='5.72'
y2='10.08'
gradientTransform='translate(8.04 0.75) rotate(45)'
gradientUnits='userSpaceOnUse'
>
<stop offset='0' stopColor='#b3b2b3' />
<stop offset='1' stopColor='#979797' />
</linearGradient>
<linearGradient
id={dashBottomGradient}
x1='5.28'
y1='14.89'
x2='10.49'
y2='14.89'
gradientTransform='translate(12.84 -1.21) rotate(45)'
gradientUnits='userSpaceOnUse'
>
<stop offset='0' stopColor='#b3b2b3' />
<stop offset='1' stopColor='#979797' />
</linearGradient>
</defs>
</svg>
)
}
export function AzureIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const gradient0 = `azure_paint0_${id}`
apps/docs/components/ui/icon-mapping.ts
+2
View File
@@ -22,6 +22,7 @@ import {
AshbyIcon,
AthenaIcon,
AttioIcon,
AzureDataExplorerIcon,
AzureIcon,
BoxCompanyIcon,
BrainIcon,
@@ -281,6 +282,7 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
ashby: AshbyIcon,
athena: AthenaIcon,
attio: AttioIcon,
azure_data_explorer: AzureDataExplorerIcon,
azure_devops: AzureIcon,
box: BoxCompanyIcon,
brandfetch: BrandfetchIcon,
apps/docs/content/docs/en/integrations/azure_data_explorer.mdx
+497
View File
@@ -0,0 +1,497 @@
---
title: Azure Data Explorer
description: Query and manage Azure Data Explorer (Kusto) clusters with KQL
---
import { BlockInfoCard } from "@/components/ui/block-info-card"
<BlockInfoCard
type="azure_data_explorer"
color="#FFFFFF"
/>
{/* MANUAL-CONTENT-START:intro */}
[Azure Data Explorer](https://azure.microsoft.com/products/data-explorer) is Microsoft's analytics service for very large volumes of machine-generated data — logs, metrics, traces, telemetry, and IoT events. It is built for questions asked over billions of rows: you write a query, and it comes back in seconds. The same engine powers Fabric Eventhouse, Azure Monitor, and Application Insights.
You query it with **KQL** (Kusto Query Language), a pipeline language that reads left to right. Start with a table, then pipe the rows through operators:
```kusto
StormEvents
| where StartTime > ago(7d) and State == "FLORIDA"
| summarize Events = count() by EventType
| top 10 by Events
```
Azure Data Explorer also has a second command family: **management commands**, which all start with a dot (`.show tables`, `.create table`, `.ingest inline`). Queries read data; management commands inspect and change the cluster itself.
In Sim, this integration gives your agents both halves:
- **Ask questions of your telemetry** — turn a plain-English question into KQL, run it, and answer with real numbers instead of a guess
- **Discover the data model first** — list databases, tables, and stored functions, read a table's schema, and check its size and row count, so a generated query references columns that actually exist and you know what it will scan
- **Push rows in** — send small batches straight into a table, or materialize a query result into a rollup table with `.set-or-append`
- **Manage tables** — create a table from a column schema, or drop one you no longer need
- **Debug the pipeline** — list ingestion failures with their error codes and root causes, and check the state of a long-running operation
- **Run any management command** — the escape hatch for policies, mappings, and anything else on the control plane
Authentication uses a **Microsoft Entra service principal** (an app registration with a tenant ID, client ID, and client secret) rather than an interactive sign-in, so scheduled and unattended workflows keep working without anyone logging in. Grant that principal access to the database with `.add database <DATABASE> viewers ('aadapp=<clientId>;<tenantId>')` — use `viewers` for read-only agents, and `ingestors` or `users` only when a workflow needs to write.
A few things worth knowing before you build:
- **Enable Read-only on the Run Query operation** whenever an agent writes its own KQL. It sends the `x-ms-readonly` header, and the cluster then refuses anything that would change data — a cheap guardrail against a generated query doing more than you intended.
- **Results are capped at 10,000 rows.** Every result reports `rowCount`, `totalRowCount`, and `truncated`, so a query that returned more than the cap says so rather than quietly looking complete. Aggregate with `summarize` or bound the query with `take` instead of pulling raw rows.
- **Ingest Rows Inline is for small batches.** It is ideal for tens or hundreds of rows from a workflow run. For continuous or high-volume loading, use Azure Data Explorer's queued or streaming ingestion instead.
- **Ingest From Query defaults to `set-or-append`**, which adds to an existing table. `set-or-replace` discards everything already in the target table — pick it only when you mean to rebuild the rollup from scratch. For a large backfill, turn on the background option and poll Show Operations with the operation ID it returns.
- **Ingest From Query matches columns by position, not by name.** Kusto aligns the query result to the target table on column type and order, so a query that projects the right columns in the wrong order ingests data into the wrong columns without erroring. End the query with an explicit `project` in the table's column order, and confirm with Show Table Schema first.
- **Drop Table is permanent.** It deletes the table and its data. Give an agent the `viewers` role rather than `admins` unless a workflow genuinely needs to change schema.
{/* MANUAL-CONTENT-END */}
## Usage Instructions
Run Kusto Query Language queries against Azure Data Explorer and Fabric Eventhouse clusters, discover databases, tables, and schemas, push small batches of rows inline, and run management commands. Authenticates with a Microsoft Entra service principal using client credentials, so no interactive sign-in is needed.
## Actions
### Azure Data Explorer Query
Run a Kusto Query Language (KQL) query against an Azure Data Explorer database and return the primary result table.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `clusterUri` | string | Yes | Cluster URI \(e.g., https://mycluster.eastus.kusto.windows.net\) |
| `tenantId` | string | Yes | Microsoft Entra tenant ID hosting the service principal |
| `clientId` | string | Yes | Microsoft Entra application \(client\) ID |
| `clientSecret` | string | Yes | Microsoft Entra application client secret |
| `resource` | string | No | Token audience override. Defaults to the cluster URI itself |
| `database` | string | Yes | Database to run the query against |
| `query` | string | Yes | KQL query text \(e.g., StormEvents \| where State == "FLORIDA" \| summarize count\(\) by EventType\) |
| `properties` | json | No | Kusto request properties object, e.g. \{"Options":\{"servertimeout":"00:04:00","queryconsistency":"strongconsistency"\}\} |
| `readOnly` | boolean | No | Send x-ms-readonly so the cluster rejects any request that would change data |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tableName` | string | Name Kusto assigned to the returned result table |
| `columns` | array | Column metadata for the result table |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Kusto scalar type |
| ↳ `dataType` | string | Approximate .NET type |
| `rows` | array | Result rows as positional arrays matching the columns order |
| `records` | array | Result rows keyed by column name |
| `rowCount` | number | Rows carried in this result, after the row cap |
| `totalRowCount` | number | Rows Kusto returned, before the row cap was applied |
| `truncated` | boolean | Whether rows were dropped to stay within the row cap — narrow the query if true |
### Azure Data Explorer Management Command
Run an Azure Data Explorer management command (a control command starting with ".") such as .show, .create, .alter, or .drop. Write commands change cluster state permanently; use the Query operation for reads.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `clusterUri` | string | Yes | Cluster URI \(e.g., https://mycluster.eastus.kusto.windows.net\) |
| `tenantId` | string | Yes | Microsoft Entra tenant ID hosting the service principal |
| `clientId` | string | Yes | Microsoft Entra application \(client\) ID |
| `clientSecret` | string | Yes | Microsoft Entra application client secret |
| `resource` | string | No | Token audience override. Defaults to the cluster URI itself |
| `command` | string | Yes | Management command text, starting with "." \(e.g., .show table Events details\) |
| `database` | string | No | Database context for the command. Required for all commands except cluster-level ones such as .show databases |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tableName` | string | Name Kusto assigned to the returned result table |
| `columns` | array | Column metadata for the result table |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Kusto scalar type |
| ↳ `dataType` | string | Approximate .NET type |
| `rows` | array | Result rows as positional arrays matching the columns order |
| `records` | array | Result rows keyed by column name |
| `rowCount` | number | Rows carried in this result, after the row cap |
| `totalRowCount` | number | Rows Kusto returned, before the row cap was applied |
| `truncated` | boolean | Whether rows were dropped to stay within the row cap — narrow the query if true |
### Azure Data Explorer List Databases
List the databases on an Azure Data Explorer cluster that the service principal can access.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `clusterUri` | string | Yes | Cluster URI \(e.g., https://mycluster.eastus.kusto.windows.net\) |
| `tenantId` | string | Yes | Microsoft Entra tenant ID hosting the service principal |
| `clientId` | string | Yes | Microsoft Entra application \(client\) ID |
| `clientSecret` | string | Yes | Microsoft Entra application client secret |
| `resource` | string | No | Token audience override. Defaults to the cluster URI itself |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tableName` | string | Name Kusto assigned to the returned result table |
| `columns` | array | Column metadata for the result table |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Kusto scalar type |
| ↳ `dataType` | string | Approximate .NET type |
| `rows` | array | Result rows as positional arrays matching the columns order |
| `records` | array | Result rows keyed by column name |
| `rowCount` | number | Rows carried in this result, after the row cap |
| `totalRowCount` | number | Rows Kusto returned, before the row cap was applied |
| `truncated` | boolean | Whether rows were dropped to stay within the row cap — narrow the query if true |
| `databases` | array | Database names, read from the DatabaseName column |
### Azure Data Explorer List Tables
List the tables in an Azure Data Explorer database, with their folder and docstring.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `clusterUri` | string | Yes | Cluster URI \(e.g., https://mycluster.eastus.kusto.windows.net\) |
| `tenantId` | string | Yes | Microsoft Entra tenant ID hosting the service principal |
| `clientId` | string | Yes | Microsoft Entra application \(client\) ID |
| `clientSecret` | string | Yes | Microsoft Entra application client secret |
| `resource` | string | No | Token audience override. Defaults to the cluster URI itself |
| `database` | string | Yes | Database whose tables should be listed |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tableName` | string | Name Kusto assigned to the returned result table |
| `columns` | array | Column metadata for the result table |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Kusto scalar type |
| ↳ `dataType` | string | Approximate .NET type |
| `rows` | array | Result rows as positional arrays matching the columns order |
| `records` | array | Result rows keyed by column name |
| `rowCount` | number | Rows carried in this result, after the row cap |
| `totalRowCount` | number | Rows Kusto returned, before the row cap was applied |
| `truncated` | boolean | Whether rows were dropped to stay within the row cap — narrow the query if true |
| `tables` | array | Table names, read from the TableName column |
### Azure Data Explorer Show Table Schema
Read the column schema of an Azure Data Explorer table in CSL form (e.g., "Timestamp:datetime,Level:string"). Use this before writing a KQL query against an unfamiliar table.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `clusterUri` | string | Yes | Cluster URI \(e.g., https://mycluster.eastus.kusto.windows.net\) |
| `tenantId` | string | Yes | Microsoft Entra tenant ID hosting the service principal |
| `clientId` | string | Yes | Microsoft Entra application \(client\) ID |
| `clientSecret` | string | Yes | Microsoft Entra application client secret |
| `resource` | string | No | Token audience override. Defaults to the cluster URI itself |
| `database` | string | Yes | Database containing the table |
| `table` | string | Yes | Table whose schema should be read |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tableName` | string | Name of the table |
| `schema` | string | Comma-separated CSL column schema \(name:type\) |
| `databaseName` | string | The table's database |
| `folder` | string | The table's folder |
| `docString` | string | The table's docstring |
### Azure Data Explorer Show Database Schema
Read the full schema of an Azure Data Explorer database as a flat list of every table and column, so an agent can discover the data model in one call.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `clusterUri` | string | Yes | Cluster URI \(e.g., https://mycluster.eastus.kusto.windows.net\) |
| `tenantId` | string | Yes | Microsoft Entra tenant ID hosting the service principal |
| `clientId` | string | Yes | Microsoft Entra application \(client\) ID |
| `clientSecret` | string | Yes | Microsoft Entra application client secret |
| `resource` | string | No | Token audience override. Defaults to the cluster URI itself |
| `database` | string | Yes | Database whose schema should be read |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tableName` | string | Name Kusto assigned to the returned result table |
| `columns` | array | Column metadata for the result table |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Kusto scalar type |
| ↳ `dataType` | string | Approximate .NET type |
| `rows` | array | Result rows as positional arrays matching the columns order |
| `records` | array | Result rows keyed by column name |
| `rowCount` | number | Rows carried in this result, after the row cap |
| `totalRowCount` | number | Rows Kusto returned, before the row cap was applied |
| `truncated` | boolean | Whether rows were dropped to stay within the row cap — narrow the query if true |
### Azure Data Explorer Show Table Details
Read size, row count, hot-cache footprint, and effective policies for a table — or for every table in the database when no table is given. Use it to see how much data a table actually holds before querying it.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `clusterUri` | string | Yes | Cluster URI \(e.g., https://mycluster.eastus.kusto.windows.net\) |
| `tenantId` | string | Yes | Microsoft Entra tenant ID hosting the service principal |
| `clientId` | string | Yes | Microsoft Entra application \(client\) ID |
| `clientSecret` | string | Yes | Microsoft Entra application client secret |
| `resource` | string | No | Token audience override. Defaults to the cluster URI itself |
| `database` | string | Yes | Database to read table details from |
| `table` | string | No | Table to describe. Omit to describe every table in the database |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tableName` | string | Name Kusto assigned to the returned result table |
| `columns` | array | Column metadata for the result table |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Kusto scalar type |
| ↳ `dataType` | string | Approximate .NET type |
| `rows` | array | Result rows as positional arrays matching the columns order |
| `records` | array | Result rows keyed by column name |
| `rowCount` | number | Rows carried in this result, after the row cap |
| `totalRowCount` | number | Rows Kusto returned, before the row cap was applied |
| `truncated` | boolean | Whether rows were dropped to stay within the row cap — narrow the query if true |
### Azure Data Explorer List Functions
List the stored functions in an Azure Data Explorer database, with their parameters and bodies, so an agent can reuse existing logic instead of rewriting it.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `clusterUri` | string | Yes | Cluster URI \(e.g., https://mycluster.eastus.kusto.windows.net\) |
| `tenantId` | string | Yes | Microsoft Entra tenant ID hosting the service principal |
| `clientId` | string | Yes | Microsoft Entra application \(client\) ID |
| `clientSecret` | string | Yes | Microsoft Entra application client secret |
| `resource` | string | No | Token audience override. Defaults to the cluster URI itself |
| `database` | string | Yes | Database whose stored functions should be listed |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tableName` | string | Name Kusto assigned to the returned result table |
| `columns` | array | Column metadata for the result table |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Kusto scalar type |
| ↳ `dataType` | string | Approximate .NET type |
| `rows` | array | Result rows as positional arrays matching the columns order |
| `records` | array | Result rows keyed by column name |
| `rowCount` | number | Rows carried in this result, after the row cap |
| `totalRowCount` | number | Rows Kusto returned, before the row cap was applied |
| `truncated` | boolean | Whether rows were dropped to stay within the row cap — narrow the query if true |
| `functions` | array | Stored function names, read from the Name column |
### Azure Data Explorer Ingest Inline
Push rows directly into an Azure Data Explorer table with .ingest inline. Data is parsed as CSV against the table schema unless an ingestion property says otherwise. Intended for small batches — use queued or streaming ingestion for production volumes.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `clusterUri` | string | Yes | Cluster URI \(e.g., https://mycluster.eastus.kusto.windows.net\) |
| `tenantId` | string | Yes | Microsoft Entra tenant ID hosting the service principal |
| `clientId` | string | Yes | Microsoft Entra application \(client\) ID |
| `clientSecret` | string | Yes | Microsoft Entra application client secret |
| `resource` | string | No | Token audience override. Defaults to the cluster URI itself |
| `database` | string | Yes | Database containing the target table |
| `table` | string | Yes | Table to ingest into. Its schema is the assumed schema for the data |
| `data` | string | Yes | Rows to ingest, one record per line, parsed as CSV by default \(e.g., "Shoes,1000\\nWide Shoes,50"\) |
| `ingestionProperties` | string | No | Ingestion properties clause contents, e.g. format="json", ingestionMappingReference="mymapping" |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tableName` | string | Name Kusto assigned to the returned result table |
| `columns` | array | Column metadata for the result table |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Kusto scalar type |
| ↳ `dataType` | string | Approximate .NET type |
| `rows` | array | Result rows as positional arrays matching the columns order |
| `records` | array | Result rows keyed by column name |
| `rowCount` | number | Rows carried in this result, after the row cap |
| `totalRowCount` | number | Rows Kusto returned, before the row cap was applied |
| `truncated` | boolean | Whether rows were dropped to stay within the row cap — narrow the query if true |
| `extentIds` | array | Extent IDs created by the ingestion — one per data shard. A single empty or zero-valued ID means no data shard was generated |
### Azure Data Explorer Ingest From Query
Materialize the result of a KQL query into a table with .set, .append, .set-or-append, or .set-or-replace. Use this to build rollup or summary tables instead of pushing rows from a workflow. Kusto matches the query result to the target table by column type and position, NOT by column name, so project the columns in exactly the table's order or the data lands in the wrong columns.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `clusterUri` | string | Yes | Cluster URI \(e.g., https://mycluster.eastus.kusto.windows.net\) |
| `tenantId` | string | Yes | Microsoft Entra tenant ID hosting the service principal |
| `clientId` | string | Yes | Microsoft Entra application \(client\) ID |
| `clientSecret` | string | Yes | Microsoft Entra application client secret |
| `resource` | string | No | Token audience override. Defaults to the cluster URI itself |
| `database` | string | Yes | Database containing the target table |
| `table` | string | Yes | Table to ingest the query result into |
| `mode` | string | No | set \(create, fail if it exists\), append \(add to an existing table\), set-or-append \(default\), or set-or-replace \(replace all data\) |
| `sourceQuery` | string | Yes | KQL query whose result becomes the ingested data \(e.g., LogsTable \| where Level == "Error" \| where Timestamp &gt; ago\(1h\)\). Project the columns in the target table\'s order — matching is positional, not by name |
| `async` | boolean | No | Return immediately with an OperationId and keep ingesting in the background. Check progress with Show Operations |
| `ingestionProperties` | string | No | Optional ingestion properties clause contents, e.g. distributed=true, tags=\"\[''daily''\]\" |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tableName` | string | Name Kusto assigned to the returned result table |
| `columns` | array | Column metadata for the result table |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Kusto scalar type |
| ↳ `dataType` | string | Approximate .NET type |
| `rows` | array | Result rows as positional arrays matching the columns order |
| `records` | array | Result rows keyed by column name |
| `rowCount` | number | Rows carried in this result, after the row cap |
| `totalRowCount` | number | Rows Kusto returned, before the row cap was applied |
| `truncated` | boolean | Whether rows were dropped to stay within the row cap — narrow the query if true |
### Azure Data Explorer Create Table
Create a table in an Azure Data Explorer database from a CSL column schema. Succeeds without changing anything if a table of the same name already exists.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `clusterUri` | string | Yes | Cluster URI \(e.g., https://mycluster.eastus.kusto.windows.net\) |
| `tenantId` | string | Yes | Microsoft Entra tenant ID hosting the service principal |
| `clientId` | string | Yes | Microsoft Entra application \(client\) ID |
| `clientSecret` | string | Yes | Microsoft Entra application client secret |
| `resource` | string | No | Token audience override. Defaults to the cluster URI itself |
| `database` | string | Yes | Database to create the table in |
| `table` | string | Yes | Name of the table to create |
| `columnSchema` | string | Yes | Comma-separated CSL column schema \(e.g., Timestamp:datetime, Level:string, Count:long\) |
| `tableProperties` | string | No | Optional table properties clause contents, e.g. docstring="Raw logs", folder="Ingest" |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tableName` | string | Name Kusto assigned to the returned result table |
| `columns` | array | Column metadata for the result table |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Kusto scalar type |
| ↳ `dataType` | string | Approximate .NET type |
| `rows` | array | Result rows as positional arrays matching the columns order |
| `records` | array | Result rows keyed by column name |
| `rowCount` | number | Rows carried in this result, after the row cap |
| `totalRowCount` | number | Rows Kusto returned, before the row cap was applied |
| `truncated` | boolean | Whether rows were dropped to stay within the row cap — narrow the query if true |
### Azure Data Explorer Drop Table
Drop a table from an Azure Data Explorer database. This permanently deletes the table and its data, and returns the tables that remain.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `clusterUri` | string | Yes | Cluster URI \(e.g., https://mycluster.eastus.kusto.windows.net\) |
| `tenantId` | string | Yes | Microsoft Entra tenant ID hosting the service principal |
| `clientId` | string | Yes | Microsoft Entra application \(client\) ID |
| `clientSecret` | string | Yes | Microsoft Entra application client secret |
| `resource` | string | No | Token audience override. Defaults to the cluster URI itself |
| `database` | string | Yes | Database containing the table |
| `table` | string | Yes | Name of the table to drop |
| `ifExists` | boolean | No | Succeed instead of failing when the table does not exist |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tableName` | string | Name Kusto assigned to the returned result table |
| `columns` | array | Column metadata for the result table |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Kusto scalar type |
| ↳ `dataType` | string | Approximate .NET type |
| `rows` | array | Result rows as positional arrays matching the columns order |
| `records` | array | Result rows keyed by column name |
| `rowCount` | number | Rows carried in this result, after the row cap |
| `totalRowCount` | number | Rows Kusto returned, before the row cap was applied |
| `truncated` | boolean | Whether rows were dropped to stay within the row cap — narrow the query if true |
| `tables` | array | Tables remaining in the database, read from the TableName column |
### Azure Data Explorer Show Ingestion Failures
List ingestion failures recorded for a database, with the failing table, error code, root cause detail, and whether the failure is permanent or transient. Failures are retained for 14 days.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `clusterUri` | string | Yes | Cluster URI \(e.g., https://mycluster.eastus.kusto.windows.net\) |
| `tenantId` | string | Yes | Microsoft Entra tenant ID hosting the service principal |
| `clientId` | string | Yes | Microsoft Entra application \(client\) ID |
| `clientSecret` | string | Yes | Microsoft Entra application client secret |
| `resource` | string | No | Token audience override. Defaults to the cluster URI itself |
| `database` | string | Yes | Database whose ingestion failures should be listed |
| `operationId` | string | No | Limit results to a single ingestion operation ID |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tableName` | string | Name Kusto assigned to the returned result table |
| `columns` | array | Column metadata for the result table |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Kusto scalar type |
| ↳ `dataType` | string | Approximate .NET type |
| `rows` | array | Result rows as positional arrays matching the columns order |
| `records` | array | Result rows keyed by column name |
| `rowCount` | number | Rows carried in this result, after the row cap |
| `totalRowCount` | number | Rows Kusto returned, before the row cap was applied |
| `truncated` | boolean | Whether rows were dropped to stay within the row cap — narrow the query if true |
### Azure Data Explorer Show Operations
Check the state of administrative operations on a cluster, such as an async ingestion. Given an operation ID it returns that operation latest update; with no ID it returns the operations from the last two weeks.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `clusterUri` | string | Yes | Cluster URI \(e.g., https://mycluster.eastus.kusto.windows.net\) |
| `tenantId` | string | Yes | Microsoft Entra tenant ID hosting the service principal |
| `clientId` | string | Yes | Microsoft Entra application \(client\) ID |
| `clientSecret` | string | Yes | Microsoft Entra application client secret |
| `resource` | string | No | Token audience override. Defaults to the cluster URI itself |
| `database` | string | No | Database context for the command |
| `operationId` | string | No | Operation ID to check, e.g. the ID returned by an async ingestion |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `tableName` | string | Name Kusto assigned to the returned result table |
| `columns` | array | Column metadata for the result table |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Kusto scalar type |
| ↳ `dataType` | string | Approximate .NET type |
| `rows` | array | Result rows as positional arrays matching the columns order |
| `records` | array | Result rows keyed by column name |
| `rowCount` | number | Rows carried in this result, after the row cap |
| `totalRowCount` | number | Rows Kusto returned, before the row cap was applied |
| `truncated` | boolean | Whether rows were dropped to stay within the row cap — narrow the query if true |
apps/docs/content/docs/en/integrations/meta.json
+1
View File
@@ -22,6 +22,7 @@
"atlassian-service-account",
"attio",
"attio-service-account",
"azure_data_explorer",
"azure_devops",
"box",
"box-service-account",
apps/docs/content/docs/en/integrations/table.mdx
+1
View File
@@ -226,6 +226,7 @@ Query rows from a table with filtering, sorting, and pagination
| `totalCount` | number | Total rows matching filter |
| `limit` | number | Limit used in query |
| `offset` | number | Offset used in query |
| `nextCursor` | string | Non-null when more rows match past this page. A page can end early at the byte budget, so this — not a short rowCount — is what says whether more remain. To page, advance offset by rowCount and stop when this is null. |
### Get Row