Share via

az network application-gateway http-settings

  • Reference

Manage HTTP settings of an application gateway.

Commands

Name Description Type Status
az network application-gateway http-settings create

Create HTTP settings.

 Core GA
az network application-gateway http-settings delete

Delete HTTP settings.

 Core GA
az network application-gateway http-settings list

List HTTP settings.

 Core GA
az network application-gateway http-settings show

Get the details of HTTP settings.

 Core GA
az network application-gateway http-settings update

Update HTTP settings.

 Core GA
az network application-gateway http-settings wait

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

 Core GA

az network application-gateway http-settings create

Edit

Create HTTP settings.

az network application-gateway http-settings create --gateway-name
                                                    --name
                                                    --port
                                                    --resource-group
                                                    [--affinity-cookie-name]
                                                    [--auth-certs]
                                                    [--connection-draining-timeout]
                                                    [--cookie-based-affinity {Disabled, Enabled}]
                                                    [--enable-probe {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--host-name]
                                                    [--host-name-from-backend-pool {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--path]
                                                    [--probe]
                                                    [--protocol {Http, Https, Tcp, Tls}]
                                                    [--root-certs]
                                                    [--timeout]

Examples

Create HTTP settings.

az network application-gateway http-settings create -g MyResourceGroup --gateway-name MyAppGateway -n MyHttpSettings --port 80 --protocol Http --cookie-based-affinity Disabled --timeout 30

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the backend http 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

--affinity-cookie-name

Name used for the affinity cookie.

--auth-certs

Space-separated list of authentication certificates (Names and IDs) to associate with the HTTP settings. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--connection-draining-timeout

Time in seconds after a backend server is removed during which on open connection remains active. Range from 0 (Disabled) to 3600.

Default value: 0
--cookie-based-affinity

Enable or disable cookie-based affinity.

Accepted values: Disabled, Enabled
Default value: Disabled
--enable-probe

Whether the probe is enabled.

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

Host header sent to the backend servers.

--host-name-from-backend-pool

Whether to pick host header should be picked from the host name of the backend server.

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

Path that will prefix all HTTP requests.

--probe

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

--protocol

Protocol used to communicate with the backend.

Accepted values: Http, Https, Tcp, Tls
Default value: Http
--root-certs

Space-separated list of trusted root certificates (Names and IDs) to associate with the HTTP settings. --host-name or --host-name-from-backend-pool 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 http-settings delete

Edit

Delete HTTP settings.

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

Examples

Delete HTTP settings.

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

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the backend http 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 http-settings list

Edit

List HTTP settings.

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

Examples

List HTTP settings.

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

Edit

Get the details of HTTP settings.

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

Examples

Get the details of HTTP settings.

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

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the backend http 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 http-settings update

Edit

Update HTTP settings.

az network application-gateway http-settings update --gateway-name
                                                    --name
                                                    --resource-group
                                                    [--add]
                                                    [--affinity-cookie-name]
                                                    [--auth-certs]
                                                    [--connection-draining-timeout]
                                                    [--cookie-based-affinity {Disabled, Enabled}]
                                                    [--enable-probe {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--host-name]
                                                    [--host-name-from-backend-pool {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                    [--path]
                                                    [--port]
                                                    [--probe]
                                                    [--protocol {Http, Https, Tcp, Tls}]
                                                    [--remove]
                                                    [--root-certs]
                                                    [--set]
                                                    [--timeout]

Examples

Update HTTP settings to use a new probe.

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

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the backend http 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>.

--affinity-cookie-name

Name used for the affinity cookie.

--auth-certs

Space-separated list of authentication certificates (Names and IDs) to associate with the HTTP settings. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--connection-draining-timeout

Time in seconds after a backend server is removed during which on open connection remains active. Range from 0 (Disabled) to 3600.

--cookie-based-affinity

Enable or disable cookie-based affinity.

Accepted values: Disabled, Enabled
--enable-probe

Whether the probe is enabled.

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.

--host-name-from-backend-pool

Whether to pick host header should be picked from the host name of the backend server.

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

Path that will prefix all HTTP requests.

--port

Number of the destination port on the backend.

--probe

Name or ID of the probe to associate with the HTTP 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 <indexToRemove> OR --remove propertyToRemove.

--root-certs

Space-separated list of trusted root certificates (Names and IDs) to associate with the HTTP settings. --host-name or --host-name-from-backend-pool 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=<value>.

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

Edit

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

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