az network application-gateway http-settings
Manage HTTP settings of 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 |
Get the details of a gateway's 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]
[--auth-certs]
[--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}]
[--root-certs]
[--subscription]
[--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 30Create HTTP settings. (autogenerated)
az network application-gateway http-settings create --affinity-cookie-name MyAffinityCookie --cookie-based-affinity Enabled --gateway-name MyAppGateway --host-name MyHost --name MyHttpSettings --port 80 --probe MyNewProbe --protocol Http --resource-group MyResourceGroup --timeout 30Required Parameters
Name of the application gateway.
The name of the backed HTTP settings.
The port number.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Name used for the affinity cookie.
Space-separated list of authentication certificates (names or IDs) to associate with the HTTP settings.
The time in seconds after a backend server is removed during which on open connection remains active. Range: 0 (disabled) to 3600.
Enable or disable cookie-based affinity.
Whether the probe is enabled.
Host header sent to the backend servers.
Use host name of the backend server as the host header.
Do not wait for the long-running operation to finish.
Path that will prefix all HTTP requests.
Name or ID of the probe to associate with the HTTP settings.
The HTTP settings protocol.
Space-separated list of trusted root certificates (names or IDs) to associate with the HTTP settings. --host-name or --host-name-from-backend-pool is required when this field is set.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Request timeout in seconds.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az network application-gateway http-settings delete
Delete HTTP settings.
az network application-gateway http-settings delete [--gateway-name]
[--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]Examples
Delete HTTP settings.
az network application-gateway http-settings delete -g MyResourceGroup --gateway-name MyAppGateway -n MyHttpSettingsOptional Parameters
The name of the application gateway.
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.
The name of the backed HTTP settings.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az network application-gateway http-settings list
List HTTP settings.
az network application-gateway http-settings list --gateway-name
--resource-group
[--query-examples]
[--subscription]Examples
List HTTP settings.
az network application-gateway http-settings list -g MyResourceGroup --gateway-name MyAppGatewayRequired Parameters
The name of the application gateway.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az network application-gateway http-settings show
Get the details of a gateway's HTTP settings.
az network application-gateway http-settings show [--gateway-name]
[--ids]
[--name]
[--query-examples]
[--resource-group]
[--subscription]Examples
Get the details of a gateway's HTTP settings.
az network application-gateway http-settings show -g MyResourceGroup --gateway-name MyAppGateway -n MyHttpSettingsOptional Parameters
The name of the application gateway.
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.
The name of the backed HTTP settings.
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az network application-gateway http-settings update
Update HTTP settings.
az network application-gateway http-settings update [--add]
[--affinity-cookie-name]
[--auth-certs]
[--connection-draining-timeout]
[--cookie-based-affinity {Disabled, Enabled}]
[--enable-probe {false, true}]
[--force-string]
[--gateway-name]
[--host-name]
[--host-name-from-backend-pool {false, true}]
[--ids]
[--name]
[--no-wait]
[--path]
[--port]
[--probe]
[--protocol {Http, Https}]
[--remove]
[--resource-group]
[--root-certs]
[--set]
[--subscription]
[--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 MyNewProbeUpdate HTTP settings. (autogenerated)
az network application-gateway http-settings update --enable-probe true --gateway-name MyAppGateway --name MyHttpSettings --probe MyNewProbe --resource-group MyResourceGroupOptional Parameters
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>.
Name used for the affinity cookie.
Space-separated list of authentication certificates (names or IDs) to associate with the HTTP settings.
The time in seconds after a backend server is removed during which on open connection remains active. Range: 0 (disabled) to 3600.
Enable or disable cookie-based affinity.
Whether the probe is enabled.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Name of the application gateway.
Host header sent to the backend servers.
Use host name of the backend server as the host header.
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.
The name of the backed HTTP settings.
Do not wait for the long-running operation to finish.
Path that will prefix all HTTP requests.
The port number.
Name or ID of the probe to associate with the HTTP settings.
The HTTP settings protocol.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Space-separated list of trusted root certificates (names or IDs) to associate with the HTTP settings. --host-name or --host-name-from-backend-pool is required when this field is set.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Request timeout in seconds.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.