Share via

az network application-gateway frontend-ip

Manage frontend IP addresses of an application gateway.

Commands

Name Description Type Status
az network application-gateway frontend-ip create

Create a frontend IP address.

 Core GA
az network application-gateway frontend-ip delete

Delete a frontend IP address.

 Core GA
az network application-gateway frontend-ip list

List frontend IP addresses.

 Core GA
az network application-gateway frontend-ip show

Get the details of a frontend IP address.

 Core GA
az network application-gateway frontend-ip update

Update a frontend IP address.

 Core GA
az network application-gateway frontend-ip wait

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

 Core GA

az network application-gateway frontend-ip create

Edit

Create a frontend IP address.

az network application-gateway frontend-ip create --gateway-name
                                                  --name
                                                  --resource-group
                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--private-ip-address]
                                                  [--public-ip-address]
                                                  [--subnet]
                                                  [--vnet-name]

Examples

Create a frontend IP address.

az network application-gateway frontend-ip create -g MyResourceGroup --gateway-name MyAppGateway -n MyFrontendIp --public-ip-address MyPublicIpAddress

Create a frontend IP address with subnet.

az network application-gateway frontend-ip create --gateway-name MyAppGateway --name MyFrontendIp --private-ip-address 10.10.10.50 --resource-group MyResourceGroup --subnet MySubnet --vnet-name MyVnet

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the frontend IP 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.

--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
--private-ip-address

Static private IP address to use.

--public-ip-address

Name or ID of the public IP address.

--subnet

Name or ID of the subnet. If using Name, you need to provide --vnet-name as well.

--vnet-name

Name of the virtual network corresponding to the subnet.

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 frontend-ip delete

Edit

Delete a frontend IP address.

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

Examples

Delete a frontend IP address.

az network application-gateway frontend-ip delete -g MyResourceGroup --gateway-name MyAppGateway -n MyFrontendIp

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the frontend IP 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.

--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
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 frontend-ip list

Edit

List frontend IP addresses.

az network application-gateway frontend-ip list --gateway-name
                                                --resource-group

Examples

List frontend IP addresses.

az network application-gateway frontend-ip list -g MyResourceGroup --gateway-name MyAppGateway

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.

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 frontend-ip show

Edit

Get the details of a frontend IP address.

az network application-gateway frontend-ip show --gateway-name
                                                --name
                                                --resource-group

Examples

Get the details of a frontend IP address.

az network application-gateway frontend-ip show -g MyResourceGroup --gateway-name MyAppGateway -n MyFrontendIp

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the frontend IP 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.

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 frontend-ip update

Edit

Update a frontend IP address.

az network application-gateway frontend-ip update --gateway-name
                                                  --name
                                                  --resource-group
                                                  [--add]
                                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--private-ip-address]
                                                  [--remove]
                                                  [--set]
                                                  [--subnet]
                                                  [--vnet-name]

Examples

Update a frontend IP address.

az network application-gateway frontend-ip update --gateway-name MyAppGateway --name MyFrontendIp --private-ip-address 10.10.10.50 --resource-group MyResourceGroup

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the frontend IP 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.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
--private-ip-address

Static private IP address to use.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--subnet

Name or ID of the subnet. If using Name, you need to provide --vnet-name as well.

--vnet-name

Name of the virtual network corresponding to the subnet.

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 frontend-ip wait

Edit

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

az network application-gateway frontend-ip 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