sql-endpoint

Manage SQL endpoints (analytics endpoints for lakehouses)

Authentication scope: fabric

`list`

List SQL endpoints in a workspace

fabio sql-endpoint list --workspace <value>

Flag	Type	Required	Description
`--workspace`	`string`	Yes	Workspace ID

Examples

fabio sql-endpoint list --workspace $WS -o table

Read-only · Returns list

`show`

Show details of a SQL endpoint

fabio sql-endpoint show --workspace <value> --id <value>

Flag	Type	Required	Description
`--workspace`	`string`	Yes	Workspace ID
`--id`	`string`	Yes	SQL endpoint ID

Read-only · Returns object

`connection-string`

Get the SQL connection string for a SQL endpoint

fabio sql-endpoint connection-string --workspace <value> --id <value>

Flag	Type	Required	Description
`--workspace`	`string`	Yes	Workspace ID
`--id`	`string`	Yes	SQL endpoint ID
`--guest-tenant-id`	`string`	No	Guest tenant ID (if different from the SQL endpoint’s tenant)
`--private-link-type`	`string`	No	Private link type: `None` or `Workspace`

Examples

fabio sql-endpoint connection-string --workspace $WS --id $SQLEP

Read-only · Returns object

`query`

Execute a SQL query against a SQL endpoint

fabio sql-endpoint query --workspace <value> --id <value>

Flag	Type	Required	Description
`--workspace`	`string`	Yes	Workspace ID
`--id`	`string`	Yes	SQL endpoint ID
`--sql`	`string`	No	SQL query text, @file path, or omit for stdin

Examples

fabio sql-endpoint query --workspace $WS --id $ID --sql "SELECT TOP 10 * FROM dbo.my_table"

fabio sql-endpoint query --workspace $WS --id $ID --sql @query.sql

echo "SELECT 1" | fabio sql-endpoint query --workspace $WS --id $ID

fabio sql-endpoint query --workspace $WS --id $SQLEP --sql "SELECT TOP 10 * FROM dbo.sales ORDER BY order_date DESC"

Read-only · Returns list

`plan`

Capture the estimated execution plan (SHOWPLAN_XML) without executing the query

fabio sql-endpoint plan --workspace <value> --id <value>

Flag	Type	Required	Description
`--workspace`	`string`	Yes	Workspace ID
`--id`	`string`	Yes	SQL endpoint ID
`--sql`	`string`	No	SQL query to plan (prefix with @ to read from file, omit to read from stdin)

Read-only · Returns object

`refresh-metadata`

Refresh metadata for all tables in a SQL endpoint (LRO)

fabio sql-endpoint refresh-metadata --workspace <value> --id <value>

Flag	Type	Required	Description
`--workspace`	`string`	Yes	Workspace ID
`--id`	`string`	Yes	SQL endpoint ID

Mutates state · Returns list

`get-audit-settings`

Get SQL audit settings for the endpoint

fabio sql-endpoint get-audit-settings --workspace <value> --id <value>

Flag	Type	Required	Description
`--workspace`	`string`	Yes	Workspace ID
`--id`	`string`	Yes	SQL endpoint ID

Read-only · Returns object

`update-audit-settings`

Update SQL audit settings for the endpoint

fabio sql-endpoint update-audit-settings --workspace <value> --id <value>

Flag	Type	Required	Description
`--workspace`	`string`	Yes	Workspace ID
`--id`	`string`	Yes	SQL endpoint ID
`--state`	`string`	No	Audit state: Enabled or Disabled
`--retention-days`	`string`	No	Retention days (0 = indefinite)
`--audit-actions`	`string`	No	Audit actions and groups (comma-separated)
`--predicate-expression`	`string`	No	Predicate expression for filtering audit logs

Mutates state · Returns object

`set-audit-actions`

Set audit actions and groups for the endpoint

fabio sql-endpoint set-audit-actions --workspace <value> --id <value>

Flag	Type	Required	Description
`--workspace`	`string`	Yes	Workspace ID
`--id`	`string`	Yes	SQL endpoint ID
`--actions`	`string`	No	Audit actions and groups (comma-separated)

Mutates state · Returns object

`queries-running`

List currently running queries on a SQL endpoint

fabio sql-endpoint queries-running --workspace <value> --id <value>

Flag	Type	Required	Description
`--workspace`	`string`	Yes	Workspace ID
`--id`	`string`	Yes	SQL endpoint ID

Read-only · Returns object

`queries-frequent`

List frequently-run queries (from queryinsights.frequently_run_queries)

fabio sql-endpoint queries-frequent --workspace <value> --id <value>

Flag	Type	Required	Description
`--workspace`	`string`	Yes	Workspace ID
`--id`	`string`	Yes	SQL endpoint ID
`--top`	`string`	No	Maximum rows to return (default: 100)

Read-only · Returns object

`queries-long-running`

List long-running queries (from queryinsights.long_running_queries)

fabio sql-endpoint queries-long-running --workspace <value> --id <value>

Flag	Type	Required	Description
`--workspace`	`string`	Yes	Workspace ID
`--id`	`string`	Yes	SQL endpoint ID
`--top`	`string`	No	Maximum rows to return (default: 100)

Read-only · Returns object

`queries-history`

List completed query history (from queryinsights.exec_requests_history)

fabio sql-endpoint queries-history --workspace <value> --id <value>

Flag	Type	Required	Description
`--workspace`	`string`	Yes	Workspace ID
`--id`	`string`	Yes	SQL endpoint ID
`--top`	`string`	No	Maximum rows to return (default: 100)
`--label`	`string`	No	Filter to queries tagged with this OPTION (LABEL = ‘…’) value

Read-only · Returns object

`pool-insights`

Report SQL pool state changes and sustained pressure events (from queryinsights.sql_pool_insights)

fabio sql-endpoint pool-insights --workspace <value> --id <value>

Flag	Type	Required	Description
`--workspace`	`string`	Yes	Workspace ID
`--id`	`string`	Yes	SQL endpoint ID
`--top`	`string`	No	Maximum rows to return (default: 100)

Read-only · Returns object