connection

Manage connections (cloud, on-premises, virtual network)

Authentication scope: fabric

list

List all connections you have permission to access

fabio connection list

Output fields: id, displayName, connectivityType, connectionType

Read-only · Returns list

show

Show details of a specific connection

fabio connection show --id <value>

Flag	Type	Required	Description
--id	string	Yes	Connection ID

Read-only · Returns object

create

Create a new connection

fabio connection create --name <value> --connectivity-type <value> --connection-type <value> --parameters <value> --credential-type <value>

Flag	Type	Required	Description
--name	string	Yes	Display name for the connection
--connectivity-type	enum	Yes	Connectivity type One of: ShareableCloud, OnPremises, VirtualNetworkGateway, StreamingVirtualNetworkGateway, PersonalCloud.
--connection-type	string	Yes	Connection type path (e.g., Web, SQL, GitHubSourceControl)
--creation-method	string	No	Creation method (connectionDetails.creationMethod). If omitted, fabio auto-resolves it from the connection type via supportedConnectionTypes (most types differ, e.g. SQL→Sql, EventHub→EventHub.Contents). Specify explicitly only for types with multiple methods (e.g. AzureDataExplorer, Spark)
--parameters	string	Yes	Connection parameters as JSON (e.g., ‘{“server”:“host”,“database”:“db”}’)
--gateway-id	string	No	Gateway ID through which the connection is made (required when --connectivity-type is VirtualNetworkGateway or StreamingVirtualNetworkGateway)
--credential-type	enum	Yes	Credential type One of: Basic, OAuth2, Key, Anonymous, ServicePrincipal, SharedAccessSignature, WorkspaceIdentity, KeyPair.
--credentials	string	No	Credentials as JSON (format depends on credential type)
--privacy-level	enum	No	Privacy level One of: None, Public, Organizational, Private.
--skip-test-connection	bool	No	Skip connection test during creation
--allow-code-first-artifacts	bool	No	Allow this connection to be used by code-first artifacts such as Notebooks (allowUsageInUserControlledCode). Can ONLY be set at creation time; cannot be changed later
--allow-gateway-usage	bool	No	Allow this connection to be used with on-premises or virtual-network data gateways (allowConnectionUsageInGateway)

Examples

fabio connection create --name "AzureSQL-Prod" --connectivity-type ShareableCloud --type Sql --parameters '{"server":"myserver.database.windows.net","database":"mydb"}' --credential-type Basic --credentials '{"username":"admin","password":"***"}'

fabio connection create --name "ContosoStreamingVNGConn" --connectivity-type StreamingVirtualNetworkGateway --gateway-id $GATEWAY_ID --type Sql --parameters '{"server":"contoso.database.windows.net","database":"sales"}' --credential-type Basic --credentials '{"username":"admin","password":"***"}'

Output fields: id, displayName

Mutates state · Returns object

update

Update a connection’s name, credentials, or privacy level

fabio connection update --id <value>

Flag	Type	Required	Description
--id	string	Yes	Connection ID
--name	string	No	New display name
--privacy-level	enum	No	New privacy level One of: None, Public, Organizational, Private.
--credential-type	enum	No	New credential type One of: Basic, OAuth2, Key, Anonymous, ServicePrincipal, SharedAccessSignature, WorkspaceIdentity, KeyPair.
--credentials	string	No	New credentials as JSON

Mutates state · Returns object

delete

Delete a connection

fabio connection delete --id <value>

Flag	Type	Required	Description
--id	string	Yes	Connection ID

Mutates state · Destructive · Returns void

list-supported-types

List supported connection types (gateway types catalog)

fabio connection list-supported-types

Examples

fabio connection list-supported-types -o table

Read-only · Returns list

list-role-assignments

List role assignments for a connection

fabio connection list-role-assignments --id <value>

Flag	Type	Required	Description
--id	string	Yes	Connection ID

Read-only · Returns list

add-role-assignment

Add a role assignment to a connection

fabio connection add-role-assignment --id <value> --principal-id <value> --principal-type <value> --role <value>

Flag	Type	Required	Description
--id	string	Yes	Connection ID
--principal-id	string	Yes	Principal ID (user, group, or service principal)
--principal-type	enum	Yes	Principal type One of: User, Group, ServicePrincipal.
--role	enum	Yes	Role to assign One of: Owner, User, UserWithReshare.

Mutates state · Returns object

show-role-assignment

Show a specific role assignment for a connection

fabio connection show-role-assignment --id <value> --assignment-id <value>

Flag	Type	Required	Description
--id	string	Yes	Connection ID
--assignment-id	string	Yes	Role assignment ID

Read-only · Returns object

update-role-assignment

Update a role assignment for a connection

fabio connection update-role-assignment --id <value> --assignment-id <value> --role <value>

Flag	Type	Required	Description
--id	string	Yes	Connection ID
--assignment-id	string	Yes	Role assignment ID
--role	enum	Yes	New role One of: Owner, User, UserWithReshare.

Mutates state · Returns object

delete-role-assignment

Delete a role assignment from a connection

fabio connection delete-role-assignment --id <value> --assignment-id <value>

Flag	Type	Required	Description
--id	string	Yes	Connection ID
--assignment-id	string	Yes	Role assignment ID

Mutates state · Destructive · Returns void

test-connection

Test a connection (not supported for StreamingVirtualNetworkGateway connections)

fabio connection test-connection --id <value>

Flag	Type	Required	Description
--id	string	Yes	Connection ID

Read-only · Returns object

find-stale

Find stale connections (never bound to an item, or whose credentials haven’t been used recently) — a governance aid for reducing connection sprawl. Read-only: reports candidates for review, does not delete

fabio connection find-stale

Flag	Type	Required	Description
--unused-days	integer	No	Flag connections whose credentials have not been used in at least this many days (never-bound connections are always flagged)
--created-after	string	No	Only assess connections created on or after this UTC date (YYYY-MM-DD). Connections created before connection-recency GA (~March 2026) report NULL recency even when actively used, so the default cutoff avoids false positives. Pass an earlier date only if you understand the NULL-recency caveat

Read-only · Returns list

find-duplicates

Find duplicate connections — multiple connections that reach the same target (same type, path, connectivity type, and gateway). Reports the redundant connections (keeping the most-recently-used one) as candidates for consolidation. Read-only

fabio connection find-duplicates

Flag	Type	Required	Description
--match-credential-type	bool	No	Also require the credential type to match when grouping duplicates (by default, connections that differ only in credential type are still considered duplicates of the same target)

Read-only · Returns list

find-single-owner

Find connections whose only Owner is a single individual user — an orphan risk if that user leaves the organization. Prefer adding a Microsoft Entra group as a second owner. Read-only

fabio connection find-single-owner

Read-only · Returns list