gateway

Manage gateways (on-premises, VNet, members, role assignments)

Authentication scope: fabric

list

List all gateways

fabio gateway list

Read-only · Returns list

show

Show details of a gateway

fabio gateway show --gateway <value>

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID

Read-only · Returns object

create

Create a new gateway (VirtualNetwork type)

fabio gateway create --name <value> --capacity-id <value> --subscription-id <value> --resource-group <value> --vnet-name <value> --subnet <value>

Flag	Type	Required	Description
--name	string	Yes	Display name (max 200 characters)
--capacity-id	string	Yes	Capacity ID for the gateway
--subscription-id	string	Yes	Azure subscription ID containing the virtual network
--resource-group	string	Yes	Resource group name containing the virtual network
--vnet-name	string	Yes	Virtual network name
--subnet	string	Yes	Subnet name (must be delegated to Microsoft.PowerPlatform/vnetaccesslinks)
--inactivity-minutes	string	No	Minutes of inactivity before auto-sleep (30, 60, 90, 120, 150, 240, 360, 480, 720, 1440)
--member-count	string	No	Fixed number of gateway members (1-9). Cannot be used together with –max-member-gateway-count/–min-member-gateway-count. Defaults to 1 when none of the member-count flags are provided
--max-member-gateway-count	string	No	Maximum number of gateway members (1-9, value range). Requires –min-member-gateway-count; cannot be used with –member-count
--min-member-gateway-count	string	No	Minimum number of gateway members (1-9, value range). Requires –max-member-gateway-count; cannot be used with –member-count

Examples

fabio gateway create --name "data-gateway" --capacity $CAP --subscription $SUB --resource-group $RG --vnet myVNet --subnet data-subnet

fabio gateway create --name "data-gateway" --capacity $CAP --subscription $SUB --resource-group $RG --vnet myVNet --subnet data-subnet --max-member-gateway-count 5 --min-member-gateway-count 1

Mutates state · Returns object

create-streaming

Create a new streaming virtual network gateway

fabio gateway create-streaming --name <value> --subscription-id <value> --resource-group <value> --vnet-name <value> --subnet <value>

Flag	Type	Required	Description
--name	string	Yes	Display name (max 200 characters)
--subscription-id	string	Yes	Azure subscription ID containing the virtual network
--resource-group	string	Yes	Resource group name containing the virtual network
--vnet-name	string	Yes	Virtual network name
--subnet	string	Yes	Subnet name (must be delegated to Microsoft.PowerPlatform/vnetaccesslinks)

Examples

fabio gateway create-streaming --name "streaming-gateway" --subscription-id $SUB --resource-group $RG --vnet-name myVNet --subnet streaming-subnet

Mutates state · Returns object

update

Update gateway properties

fabio gateway update --gateway <value>

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID
--name	string	No	New display name
--allow-cloud-connection-refresh	enum	No	Allow cloud connection refresh One of: true, false.
--allow-custom-connectors	enum	No	Allow custom connectors One of: true, false.
--load-balancing	string	No	Load balancing setting (e.g., Failover, RoundRobin)
--member-count	string	No	Fixed number of gateway members (1-9, VirtualNetwork gateways only). Cannot be used together with –max-member-gateway-count/–min-member-gateway-count
--max-member-gateway-count	string	No	Maximum number of gateway members (1-9, value range). Requires –min-member-gateway-count; cannot be used with –member-count
--min-member-gateway-count	string	No	Minimum number of gateway members (1-9, value range). Requires –max-member-gateway-count; cannot be used with –member-count

Examples

fabio gateway update --gateway $GATEWAY_ID --load-balancing RoundRobin

fabio gateway update --gateway $GATEWAY_ID --max-member-gateway-count 5 --min-member-gateway-count 1

Mutates state · Returns object

delete

Delete a gateway

fabio gateway delete --gateway <value>

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID

Mutates state · Destructive · Returns void

list-members

List members of a gateway

fabio gateway list-members --gateway <value>

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID

Read-only · Returns list

update-member

Update a gateway member

fabio gateway update-member --gateway <value> --member-id <value>

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID
--member-id	string	Yes	Member ID
--display-name	string	No	New display name for the member
--enabled	enum	No	Enable or disable the member One of: true, false.

Mutates state · Returns object

delete-member

Delete a gateway member

fabio gateway delete-member --gateway <value> --member-id <value>

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID
--member-id	string	Yes	Member ID

Mutates state · Destructive · Returns void

list-role-assignments

List role assignments for a gateway

fabio gateway list-role-assignments --gateway <value>

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID

Read-only · Returns list

add-role-assignment

Add a role assignment to a gateway

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

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID
--principal-id	string	Yes	Principal ID (user/group/service principal)
--principal-type	string	Yes	Principal type (User, Group, ServicePrincipal)
--role	enum	Yes	Role (Admin, ConnectionCreator, ConnectionCreatorWithResharing)

Mutates state · Returns object

show-role-assignment

Show a specific role assignment

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

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID
--assignment-id	string	Yes	Role assignment ID

Read-only · Returns object

update-role-assignment

Update a role assignment

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

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID
--assignment-id	string	Yes	Role assignment ID
--role	string	Yes	New role (Admin, ConnectionCreator, ConnectionCreatorWithResharing)

Mutates state · Returns object

delete-role-assignment

Delete a role assignment

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

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID
--assignment-id	string	Yes	Role assignment ID

Mutates state · Destructive · Returns void

check-status

Check the status of a gateway (VNet only)

fabio gateway check-status --gateway <value>

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID

Read-only · Returns object

check-member-status

Check the status of a gateway member (on-premises only)

fabio gateway check-member-status --gateway <value> --member-id <value>

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID
--member-id	string	Yes	Gateway member ID

Read-only · Returns object

restart

Restart a gateway (VNet only, LRO)

fabio gateway restart --gateway <value>

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID

Mutates state · Long-running operation · Returns void

shutdown

Shut down a gateway (VNet only, LRO)

fabio gateway shutdown --gateway <value>

Flag	Type	Required	Description
--gateway	string	Yes	Gateway ID

Mutates state · Long-running operation · Returns void