az network application-gateway private-link ip-config

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

Manage IP configuration of a private link to configure its capability.

Commands

Name	Description	Type	Status
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 ip-config add

Preview

Command group 'az network application-gateway private-link ip-config' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add an IP configuration to a private link to scale up its capability.

az network application-gateway private-link ip-config add --gateway-name
                                                          --name
                                                          --private-link
                                                          --resource-group
                                                          [--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}]

Examples

Add an IP configuration to a private link.

az network application-gateway private-link ip-config add -n MyIPConfig -g MyResourceGroup  --gateway-name MyGateway --private-link MyPrivateLink --primary true

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the private IP for private link.

--private-link

Name of private link.

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

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network application-gateway private-link ip-config list

Preview

Command group 'az network application-gateway private-link ip-config' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all the IP configurations of a private link.

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

Examples

List all the IP configurations of a private link.

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

Required Parameters

--gateway-name

Name of the application gateway.

--private-link

Name of private link.

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network application-gateway private-link ip-config remove

Preview

Command group 'az network application-gateway private-link ip-config' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove an IP configuration from a private link to scale down its capability.

az network application-gateway private-link ip-config remove --gateway-name
                                                             --name
                                                             --private-link
                                                             --resource-group
                                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                             [--yes]

Examples

Remove an IP configuration from a private link.

az network application-gateway private-link ip-config remove -n MyIPConfig -g MyResourceGroup --gateway-name MyGateway --private-link MyPrivateLink --yes

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the private IP for private link.

--private-link

Name of private link.

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

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network application-gateway private-link ip-config show

Preview

Command group 'az network application-gateway private-link ip-config' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show an IP configuration of a private link.

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

Examples

Show an IP configuration of a private link.

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

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the private IP for private link.

--private-link

Name of private link.

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network application-gateway private-link ip-config wait

Preview

Command group 'az network application-gateway private-link ip-config' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az network application-gateway private-link ip-config wait [--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.

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False