az network application-gateway settings

  • Reference

Manage settings of an application gateway.

Commands

Name Description Type Status
az network application-gateway settings create

Create settings.

 Core GA
az network application-gateway settings delete

Delete settings.

 Core GA
az network application-gateway settings list

List settings.

 Core GA
az network application-gateway settings show

Get the details of settings.

 Core GA
az network application-gateway settings update

Update settings.

 Core GA
az network application-gateway settings wait

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

 Core GA

az network application-gateway settings create

Edit

Create settings.

az network application-gateway settings create --gateway-name
                                               --name
                                               --port
                                               --resource-group
                                               [--backend-pool-host-name {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--host-name]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--probe]
                                               [--protocol {Http, Https, Tcp, Tls}]
                                               [--root-certs]
                                               [--timeout]

Examples

Create settings.

az network application-gateway settings create -g MyResourceGroup --gateway-name MyAppGateway -n MySettings --port 80 --protocol Http --timeout 30

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the backend settings.

--port

Number of the destination port on the backend.

--resource-group -g

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

Optional Parameters

--backend-pool-host-name

Whether to use host name of the backend server as the host header.

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

Host header sent to the backend servers.

--no-wait

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

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

Name or ID of the probe to associate with the settings.

--protocol

Protocol used to communicate with the backend.

accepted values: Http, Https, Tcp, Tls
default value: Tcp
--root-certs

Space-separated list of trusted root certificates (Names and IDs) to associate with the HTTP settings. --host-name or --backend-pool-host-name is required when this field is set. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--timeout

Request timeout in seconds.

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

Edit

Delete settings.

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

Examples

Delete settings.

az network application-gateway settings delete -g MyResourceGroup --gateway-name MyAppGateway -n MyHttpSettings

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the backend settings.

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

Edit

List settings.

az network application-gateway settings list --gateway-name
                                             --resource-group

Examples

List settings.

az network application-gateway settings 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 settings show

Edit

Get the details of settings.

az network application-gateway settings show --gateway-name
                                             --name
                                             --resource-group

Examples

Get the details of settings.

az network application-gateway settings show -g MyResourceGroup --gateway-name MyAppGateway -n MySettings

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the backend settings.

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

Edit

Update settings.

az network application-gateway settings update --gateway-name
                                               --name
                                               --resource-group
                                               [--add]
                                               [--backend-pool-host-name {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--host-name]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--port]
                                               [--probe]
                                               [--protocol {Http, Https, Tcp, Tls}]
                                               [--remove]
                                               [--root-certs]
                                               [--set]
                                               [--timeout]

Examples

Update settings to use a new probe.

az network application-gateway settings update -g MyResourceGroup --gateway-name MyAppGateway -n MySettings --probe MyNewProbe

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the backend settings.

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

--backend-pool-host-name

Whether to use host name of the backend server as the host header.

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

Host header sent to the backend servers.

--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 destination port on the backend.

--probe

Name or ID of the probe to associate with the settings.

--protocol

Protocol used to communicate with the backend.

accepted values: Http, Https, Tcp, Tls
--remove

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

--root-certs

Space-separated list of trusted root certificates (Names and IDs) to associate with the HTTP settings. --host-name or --backend-pool-host-name is required when this field is set. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--set

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

--timeout

Request timeout in seconds.

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

Edit

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

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