az network application-gateway settings
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
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
Name of the application gateway.
Name of the backend settings.
Number of the destination port on the backend.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Whether to use host name of the backend server as the host header.
Host header sent to the backend servers.
Do not wait for the long-running operation to finish.
Name or ID of the probe to associate with the settings.
Protocol used to communicate with the backend.
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.
Request timeout in seconds.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network application-gateway settings delete
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
Name of the application gateway.
Name of the backend settings.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network application-gateway settings list
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
Name of the application gateway.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network application-gateway settings show
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
Name of the application gateway.
Name of the backend settings.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network application-gateway settings update
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
Name of the application gateway.
Name of the backend settings.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional 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>.
Whether to use host name of the backend server as the host header.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Host header sent to the backend servers.
Do not wait for the long-running operation to finish.
Number of the destination port on the backend.
Name or ID of the probe to associate with the settings.
Protocol used to communicate with the backend.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
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.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Request timeout in seconds.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network application-gateway settings wait
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
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
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
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.