Gateway Examples¶
This page demonstrates how to manage on-premises and virtual network (VNet) data gateways in Microsoft Fabric using the CLI.
Resource Type
Type: .Gateway
To explore all gateway commands and their parameters, run:
Navigation¶
Navigate to the gateways collection using absolute path:
Navigate to a specific gateway using relative path:
Gateway Management¶
Create Gateway¶
Create a gateway synchronously. Use optional parameters with -P as needed; defaults apply if unspecified — see config set.
VNet Gateway Prerequisites
Before creating a VNet Gateway, ensure all requirements are met:
- Feature is supported in your region
- Subnet follows all requirements and is properly delegated
- Proper permissions on Azure subscription and VNet
- See VNet Gateway Documentation for complete requirements
Create Basic VNet Gateway¶
Create a VNet gateway with required parameters only.
fab create .gateways/basic-vnet-gateway.Gateway -P capacity=mycapacityname,virtualNetworkName=west-us-2-fabric-test-vnet,subnetName=vnet-gateway
Create VNet Gateway with Custom Configuration¶
Create a VNet gateway with additional configuration parameters.
fab create .gateways/advanced-vnet-gateway.Gateway -P capacity=production-capacity,resourceGroupName=fabric-rg,subscriptionId=25bdf70e-a1b2-4c3d-8e9f-123456789abc,virtualNetworkName=prod-fabric-vnet,subnetName=prod-gateway-subnet,inactivityMinutesBeforeSleep=60,numberOfMemberGateways=2
Check Gateway Existence¶
Check if a specific gateway exists and is accessible.
Get Gateway¶
Get Gateway Details¶
Retrieve full gateway details.
Export Gateway Details¶
Query and export gateway properties to a local directory.
List Gateways¶
Display existing gateways in a simple format.¶
Show gateways with detailed information.¶
Update Gateway¶
Update the display name of a gateway for better identification.
Remove Gateway¶
Gateway Deletion Impact
Removing a gateway will affect all connections and data sources that depend on it. Ensure dependent resources are updated or migrated before deletion.
Remove a gateway with interactive confirmation¶
Remove a gateway without confirmation prompts.¶
Get Gateway Permissions¶
Get Gateway Permission Details¶
Query Gateway Permission Principals¶
Extract principal information using JMESPath query.
Export Gateway Permission Query¶
Save gateway permission query results to a local directory.
Export to Lakehouse from Gateway Context¶
Navigate to gateway and export permissions to Lakehouse.
fab cd .gateways/prod-gateway.Gateway
fab acl get . -q "[*].principal" -o /ws1.Workspace/lh1.Lakehouse/Files