az network application-gateway private-link

  • Reference

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
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
                                                [--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]

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

--ip-address

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.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--primary

Whether the IP configuration is primary or not.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--subnet-prefix

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

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

List all the private links.

az network application-gateway private-link list -g MyResourceGroup --gateway-name MyGateway
--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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

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
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--yes]

Remove a private link.

az network application-gateway private-link remove -g MyResourceGroup --gateway-name MyGateway --name MyPrivateLink --yes
--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>.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--yes -y

Do not prompt for confirmation.

default value: False
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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

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

Show a private link.

az network application-gateway private-link show -n MyPrivateLink -g MyResourceGroup --gateway-name MyGateway
--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>.

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

Edit

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

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

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

default value: False
--custom

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

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--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>.

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.