Share via


az network application-gateway frontend-port

Manage frontend ports of an application gateway.

Commands

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

Create a frontend port.

Core GA
az network application-gateway frontend-port delete

Delete a frontend port.

Core GA
az network application-gateway frontend-port list

List frontend ports.

Core GA
az network application-gateway frontend-port show

Get the details of a frontend port.

Core GA
az network application-gateway frontend-port update

Update a frontend port.

Core GA
az network application-gateway frontend-port wait

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

Core GA

az network application-gateway frontend-port create

Create a frontend port.

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

Examples

Create a frontend port.

az network application-gateway frontend-port create -g MyResourceGroup --gateway-name MyAppGateway -n MyFrontendPort --port 8080

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the frontend port.

--resource-group -g

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

Optional Parameters

--no-wait

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

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

Number of the port.

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.

az network application-gateway frontend-port delete

Delete a frontend port.

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

Examples

Delete a frontend port.

az network application-gateway frontend-port delete -g MyResourceGroup --gateway-name MyAppGateway -n MyFrontendPort

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the frontend port.

--resource-group -g

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

Optional Parameters

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
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.

az network application-gateway frontend-port list

List frontend ports.

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

Examples

List frontend ports.

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

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

az network application-gateway frontend-port show

Get the details of a frontend port.

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

Examples

Get the details of a frontend port.

az network application-gateway frontend-port show -g MyResourceGroup --gateway-name MyAppGateway -n MyFrontendPort

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the frontend port.

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

az network application-gateway frontend-port update

Update a frontend port.

az network application-gateway frontend-port 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}]
                                                    [--port]
                                                    [--remove]
                                                    [--set]

Examples

Update a frontend port to use a different port.

az network application-gateway frontend-port update -g MyResourceGroup --gateway-name MyAppGateway -n MyFrontendPort --port 8081

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the frontend port.

--resource-group -g

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

Optional Parameters

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

--force-string

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

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

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

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

Number of the port.

--remove

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

--set

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

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.

az network application-gateway frontend-port wait

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

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

Optional Parameters

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