Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az network application-gateway private-link

Manage private link of an application gateway.

Commands

Name	Description	Type	Status
az network application-gateway private-link add	Add a new private link with a default IP configuration and associate it with an existing frontend IP.	Core	Preview
az network application-gateway private-link ip-config	Manage IP configuration of a private link to configure its capability.	Core	Preview
az network application-gateway private-link ip-config add	Add an IP configuration to a private link to scale up its capability.	Core	Preview
az network application-gateway private-link ip-config list	List all the IP configurations of a private link.	Core	Preview
az network application-gateway private-link ip-config remove	Remove an IP configuration from a private link to scale down its capability.	Core	Preview
az network application-gateway private-link ip-config show	Show an IP configuration of a private link.	Core	Preview
az network application-gateway private-link ip-config wait	Place the CLI in a waiting state until a condition is met.	Core	Preview
az network application-gateway private-link list	List all the private links.	Core	Preview
az network application-gateway private-link remove	Remove a private link and clear association with Frontend IP. The subnet associate with a private link might need to clear manually.	Core	Preview
az network application-gateway private-link show	Show a private link.	Core	Preview
az network application-gateway private-link wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az network application-gateway private-link add

Edit

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add a new private link with a default IP configuration and associate it with an existing frontend IP.

az network application-gateway private-link add --frontend-ip
 --gateway-name
 --name
 --resource-group
 --subnet
 [--acquire-policy-token]
 [--change-reference]
 [--ip-address]
 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
 [--primary {0, 1, f, false, n, no, t, true, y, yes}]
 [--subnet-prefix]

Examples

Add one private link.

az network application-gateway private-link add -g MyResourceGroup --gateway-name MyGateway --name MyPrivateLink --frontend-ip MyFrontendIP --subnet MySubnet --subnet-prefix MyPrefix

Required Parameters

--frontend-ip

Frontend IP that the private link will associate to.

--gateway-name

Name of the application gateway.

--name -n

Name of the private link configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subnet

Name or ID of a subnet within the same vnet of an application gateway.

Property	Value
Parameter group:	Properties Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--ip-address

Static private IP address of a subnet for private link. If omitting, a dynamic one will be created.

Property	Value
Parameter group:	Properties Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--primary

Whether the IP configuration is primary or not.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--subnet-prefix

CIDR prefix to use when creating a new subnet.

Property	Value
Parameter group:	Properties Arguments

az network application-gateway private-link list

Edit

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all the private links.

az network application-gateway private-link list --gateway-name
 --resource-group

Examples

List all the private links.

az network application-gateway private-link list -g MyResourceGroup --gateway-name MyGateway

Required Parameters

--gateway-name

Name of the application gateway.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az network application-gateway private-link remove

Edit

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove a private link and clear association with Frontend IP. The subnet associate with a private link might need to clear manually.

az network application-gateway private-link remove --gateway-name
 --name
 --resource-group
 [--acquire-policy-token]
 [--change-reference]
 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
 [--yes]

Examples

Remove a private link.

az network application-gateway private-link remove -g MyResourceGroup --gateway-name MyGateway --name MyPrivateLink --yes

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the private link configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

az network application-gateway private-link show

Edit

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show a private link.

az network application-gateway private-link show --gateway-name
 --name
 --resource-group

Examples

Show a private link.

az network application-gateway private-link show -n MyPrivateLink -g MyResourceGroup --gateway-name MyGateway

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the private link configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az network application-gateway private-link wait

Edit

Place the CLI in a waiting state until a condition is met.

az network application-gateway private-link wait [--acquire-policy-token]
 [--change-reference]
 [--created]
 [--custom]
 [--deleted]
 [--exists]
 [--gateway-name]
 [--ids]
 [--interval]
 [--resource-group]
 [--subscription]
 [--timeout]
 [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--gateway-name

Name of the application gateway.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Feedback

Was this page helpful?

URL: https://learn.microsoft.com/en-us/cli/azure/network/application-gateway/private-link?view=azure-cli-latest

⇱ az network application-gateway private-link | Microsoft Learn

az network application-gateway private-link

Commands

az network application-gateway private-link add

Examples

Required Parameters

Optional Parameters

az network application-gateway private-link list

Examples

Required Parameters

az network application-gateway private-link remove

Examples

Required Parameters

Optional Parameters

az network application-gateway private-link show

Examples

Required Parameters

az network application-gateway private-link wait

Optional Parameters

Feedback