az network application-gateway probe
Manage probes to gather and evaluate information on an application gateway.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az network application-gateway probe create |
Create a probe. |
Core | GA |
| az network application-gateway probe delete |
Delete a probe. |
Core | GA |
| az network application-gateway probe list |
List probes. |
Core | GA |
| az network application-gateway probe show |
Get the details of a probe. |
Core | GA |
| az network application-gateway probe update |
Update a probe. |
Core | GA |
| az network application-gateway probe wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network application-gateway probe create
Create a probe.
az network application-gateway probe create --gateway-name
--name
--resource-group
[--from-http-settings {0, 1, f, false, n, no, t, true, y, yes}]
[--from-settings {0, 1, f, false, n, no, t, true, y, yes}]
[--host]
[--interval]
[--match-body]
[--match-status-codes]
[--min-servers]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--path]
[--port]
[--protocol {Http, Https, Tcp, Tls}]
[--threshold]
[--timeout]Examples
Create an application gateway probe.
az network application-gateway probe create -g MyResourceGroup --gateway-name MyAppGateway -n MyProbe --protocol https --host 127.0.0.1 --path ProbePathRequired Parameters
Name of the application gateway.
Name of the probe.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Whether to use host header from HTTP settings.
Whether to use host header from settings. Pick hostname from settings is currently not supported, now only support false.
Name of the host to send the probe.
Time interval in seconds between consecutive probes.
Body that must be contained in the health response.
Space-separated list of allowed ranges of healthy status codes for the health response. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Minimum number of servers that are always marked healthy.
Do not wait for the long-running operation to finish.
Relative path of probe. Valid path starts from "/". Probe is sent to ://:.
Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.
Protocol used for the probe.
Number of failed probes after which the back end server is marked down.
Probe 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 probe delete
Delete a probe.
az network application-gateway probe delete --gateway-name
--name
--resource-group
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]Examples
Delete a probe.
az network application-gateway probe delete -g MyResourceGroup --gateway-name MyAppGateway -n MyProbeRequired Parameters
Name of the application gateway.
Name of the probe.
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 probe list
List probes.
az network application-gateway probe list --gateway-name
--resource-groupExamples
List probes.
az network application-gateway probe list -g MyResourceGroup --gateway-name MyAppGatewayRequired 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 probe show
Get the details of a probe.
az network application-gateway probe show --gateway-name
--name
--resource-groupExamples
Get the details of a probe.
az network application-gateway probe show -g MyResourceGroup --gateway-name MyAppGateway -n MyProbeRequired Parameters
Name of the application gateway.
Name of the probe.
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 probe update
Update a probe.
az network application-gateway probe update --gateway-name
--name
--resource-group
[--add]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--from-http-settings {0, 1, f, false, n, no, t, true, y, yes}]
[--from-settings {0, 1, f, false, n, no, t, true, y, yes}]
[--host]
[--interval]
[--match-body]
[--match-status-codes]
[--min-servers]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--path]
[--port]
[--protocol {Http, Https, Tcp, Tls}]
[--remove]
[--set]
[--threshold]
[--timeout]Examples
Update an application gateway probe with a timeout of 60 seconds.
az network application-gateway probe update -g MyResourceGroup --gateway-name MyAppGateway -n MyProbe --timeout 60Required Parameters
Name of the application gateway.
Name of the probe.
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>.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Whether to use host header from HTTP settings.
Whether to use host header from settings. Pick hostname from settings is currently not supported, now only support false.
Name of the host to send the probe.
Time interval in seconds between consecutive probes.
Body that must be contained in the health response.
Space-separated list of allowed ranges of healthy status codes for the health response. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Minimum number of servers that are always marked healthy.
Do not wait for the long-running operation to finish.
Relative path of probe. Valid path starts from "/". Probe is sent to ://:.
Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.
Protocol used for the probe.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Number of failed probes after which the back end server is marked down.
Probe 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 probe wait
Place the CLI in a waiting state until a condition is met.
az network application-gateway probe 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.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for