az network application-gateway private-link

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Manage Private Link of an Application Gateway.

Commands

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.
az network application-gateway private-link ip-config	Manage IP configuration of a Private Link to configure its capability.
az network application-gateway private-link ip-config add	Add an IP configuration to a Private Link to scale up its capability.
az network application-gateway private-link ip-config list	List all the IP configuration of a Private Link.
az network application-gateway private-link ip-config remove	Remove an IP configuration from a Private Link to scale down its capability.
az network application-gateway private-link ip-config show	Show an IP configuration of a Private Link.
az network application-gateway private-link ip-config wait	Place the CLI in a waiting state until the condition of corresponding application gateway is met.
az network application-gateway private-link list	List all the Private Link.
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.
az network application-gateway private-link show	Show a Private Link.
az network application-gateway private-link wait	Place the CLI in a waiting state until the condition of corresponding application gateway is met.

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.

az network application-gateway private-link add --frontend-ip
                                                --name
                                                --subnet
                                                [--gateway-name]
                                                [--ids]
                                                [--ip-address]
                                                [--no-wait]
                                                [--primary {false, true}]
                                                [--resource-group]
                                                [--subnet-prefix]

Required Parameters

--frontend-ip

The frontend IP which the Private Link will associate to.

--name -n

The name of Private Link.

--subnet

The name or an existing ID of a subnet within the same vnet of an application gateway.

Optional Parameters

--gateway-name

Name of the application gateway.

--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.

--ip-address

The static private IP address of a subnet for Private Link. If omitting, a dynamic one will be created.

--no-wait

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

--primary

Whether the IP configuration is primary or not.

accepted values: false, true

--resource-group -g

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

--subnet-prefix

The CIDR prefix to use when creating a new subnet.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network application-gateway private-link list

List all the Private Link.

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

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>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

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.

az network application-gateway private-link remove --name
                                                   [--gateway-name]
                                                   [--ids]
                                                   [--no-wait]
                                                   [--resource-group]
                                                   [--yes]

Required Parameters

--name -n

The name of Private Link.

Optional Parameters

--gateway-name

Name of the application gateway.

--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.

--no-wait

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

--resource-group -g

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

--yes -y

Do not prompt for confirmation.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network application-gateway private-link show

Show a Private Link.

az network application-gateway private-link show --name
                                                 [--gateway-name]
                                                 [--ids]
                                                 [--resource-group]

Required Parameters

--name -n

The name of Private Link.

Optional Parameters

--gateway-name

Name of the application gateway.

--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.

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network application-gateway private-link wait

Place the CLI in a waiting state until the condition of corresponding application gateway is met.

az network application-gateway private-link wait [--created]
                                                 [--custom]
                                                 [--deleted]
                                                 [--exists]
                                                 [--gateway-name]
                                                 [--ids]
                                                 [--interval]
                                                 [--resource-group]
                                                 [--timeout]
                                                 [--updated]

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--gateway-name

Name of the application gateway.

--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.

--interval

Polling interval in seconds.

default value: 30

--resource-group -g

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

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.