HTTP settings - az network application-gateway http-settings

Manage HTTP settings for an application gateway.

Commands

az network application-gateway http-settings create Create HTTP settings.
az network application-gateway http-settings delete Delete HTTP settings.
az network application-gateway http-settings list List HTTP settings.
az network application-gateway http-settings show Show details of HTTP settings.
az network application-gateway http-settings update Update HTTP settings.

az network application-gateway http-settings create

Create HTTP settings.

az network application-gateway http-settings create --gateway-name
--name
--port
--resource-group
[--affinity-cookie-name]
[--connection-draining-timeout]
[--cookie-based-affinity {Disabled, Enabled}]
[--enable-probe {false, true}]
[--host-name]
[--host-name-from-backend-pool {false, true}]
[--no-wait]
[--path]
[--probe]
[--protocol {Http, Https}]
[--timeout]

Required Parameters

--gateway-name

The name of the application gateway.

--name -n

The name of the backed HTTP settings.

--port

The port number.

--resource-group -g

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

Optional Parameters

--affinity-cookie-name

Name used for the affinity cookie.

--connection-draining-timeout

The time in seconds after a backend server is removed during which on open connection remains active. Range: 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: false, true
--host-name

Host header sent to the backend servers.

--host-name-from-backend-pool

Use host name of the backend server as the host header.

accepted values: false, true
--no-wait

Do not wait for the long running operation to finish.

--path

Path that will prefix all HTTP requests.

--probe

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

--protocol

The HTTP settings protocol.

accepted values: Http, Https
default value: http
--timeout

Request timeout in seconds.

az network application-gateway http-settings delete

Delete HTTP settings.

az network application-gateway http-settings delete --gateway-name
--name
--resource-group
[--no-wait]

Required Parameters

--gateway-name

The name of the application gateway.

--name -n

The name of the backed HTTP settings.

--resource-group -g

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

Optional Parameters

--no-wait

Do not wait for the long running operation to finish.

az network application-gateway http-settings list

List HTTP settings.

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

Required Parameters

--gateway-name

The name of the application gateway.

--resource-group -g

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

az network application-gateway http-settings show

Show details of HTTP settings.

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

Required Parameters

--gateway-name

The name of the application gateway.

--name -n

The name of the backed HTTP settings.

--resource-group -g

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

az network application-gateway http-settings update

Update HTTP settings.

az network application-gateway http-settings update --gateway-name
--name
--resource-group
[--add]
[--affinity-cookie-name]
[--connection-draining-timeout]
[--cookie-based-affinity {Disabled, Enabled}]
[--enable-probe {false, true}]
[--host-name]
[--host-name-from-backend-pool {false, true}]
[--no-wait]
[--path]
[--port]
[--probe]
[--protocol {Http, Https}]
[--remove]
[--set]
[--timeout]

Required Parameters

--gateway-name

The name of the application gateway.

--name -n

The name of the backed HTTP settings.

--resource-group -g

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

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .

--affinity-cookie-name

Name used for the affinity cookie.

--connection-draining-timeout

The time in seconds after a backend server is removed during which on open connection remains active. Range: 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: false, true
--host-name

Host header sent to the backend servers.

--host-name-from-backend-pool

Use host name of the backend server as the host header.

accepted values: false, true
--no-wait

Do not wait for the long running operation to finish.

--path

Path that will prefix all HTTP requests.

--port

The port number.

--probe

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

--protocol

The HTTP settings protocol.

accepted values: Http, Https
--remove

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

--set

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

--timeout

Request timeout in seconds.