Connection Examples¶
This page demonstrates how to manage data connections in Microsoft Fabric using the CLI. Connections provide secure access to external data sources and enable data integration across various platforms.
Resource Type
Type: .Connection
To explore all connection commands and their parameters, run:
Navigation¶
Navigate to the connections collection using absolute path.
Navigate to a specific connection using relative path.
Connection Management¶
Create Connection¶
Create Basic SQL Connection¶
Create a connection to SQL database with required parameters only.
fab create .connections/conn.Connection -P connectionDetails.type=SQL,connectionDetails.parameters.server=<server>,connectionDetails.parameters.database=sales,credentialDetails.type=Basic,credentialDetails.username=<username>,credentialDetails.password=<password>
Create Connection with Gateway¶
Create a connection that uses a specific gateway for secure access.
fab create .connections/conn.Connection -P gateway=MyVnetGateway.Gateway,connectionDetails.type=SQL,connectionDetails.parameters.server=<server>,connectionDetails.parameters.database=sales,credentialDetails.type=Basic,credentialDetails.username=<username>,credentialDetails.password=<password>
Create Connection with All Parameters¶
Create a connection with comprehensive configuration including privacy level and encryption settings.
fab create .connections/conn.Connection -P privacyLevel=Private,connectionDetails.creationMethod=SQL,gatewayId=852aee7c-d056-48dc-891f-9d7110a01b88,connectionDetails.type=SQL,connectionDetails.parameters.server=<server>,connectionDetails.parameters.database=sales,credentialDetails.type=Basic,credentialDetails.username=<username>,credentialDetails.password=<password>,credentialDetails.connectionEncryption=NotEncrypted,credentialDetails.skipTestConnection=False
Check Connection Existence¶
Check if a specific connection exists and is accessible.
Get Connection¶
Get Connection Details¶
Retrieve full connection details.
Export Connection Details¶
Query and export connection properties to a local directory.
List Connections¶
Display all available connections in simple format.
List Connections with Details¶
Show connections with detailed information including connection type, parameters, and configuration.
Update Connection¶
Change Privacy Level¶
Update the privacy level setting for a connection.
Update Password¶
Change the authentication password for a connection.
Change Gateway¶
Update the gateway used by a connection.
Remove Connection¶
Remove a connection with interactive confirmation¶
Remove a connection without confirmation prompts¶
Get Connection Permissions¶
Retrieve full connection permission details.
Query Connection Permission Principals¶
Extract principal information using JMESPath query.
Export Connection Permission Query¶
Save connection permission query results to a local directory.
Export to Lakehouse from Connection Context¶
Navigate to connection and export permissions to Lakehouse.
fab cd .connections/conn.Connection
fab acl get . -q [*].principal -o /ws1.Workspace/lh1.Lakehouse/Files
List Connection Permissions¶
Display permissions assigned to a connection.
List Detailed Connection Permissions¶
Show connection permissions with detailed information including roles and principal details.