az network application-gateway private-link
Manage private link of an application gateway.
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 |
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 that the private link will associate to.
Name of the application gateway.
Name of the private link configuration.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of a subnet within the same vnet of an application gateway.
Static private IP address of a subnet for private link. If omitting, a dynamic one will be created.
Do not wait for the long-running operation to finish.
Whether the IP configuration is primary or not.
CIDR prefix to use when creating a new subnet.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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
Name of the application gateway.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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
Name of the application gateway.
Name of the private link configuration.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Do not wait for the long-running operation to finish.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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
Name of the application gateway.
Name of the private link configuration.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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]
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Name of the application gateway.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: