Share via

az network application-gateway probe

  • Reference

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

Edit

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 ProbePath

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the probe.

--resource-group -g

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

Optional Parameters

--from-http-settings --host-name-from-http-settings

Whether to use host header from HTTP settings.

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

Whether to use host header from settings. Pick hostname from settings is currently not supported, now only support false.

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

Name of the host to send the probe.

--interval

Time interval in seconds between consecutive probes.

Default value: 30
--match-body

Body that must be contained in the health response.

--match-status-codes

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.

--min-servers

Minimum number of servers that are always marked healthy.

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

Relative path of probe. Valid path starts from "/". Probe is sent to ://:.

--port

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

Protocol used for the probe.

Accepted values: Http, Https, Tcp, Tls
--threshold

Number of failed probes after which the back end server is marked down.

Default value: 8
--timeout

Probe timeout in seconds.

Default value: 120
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 probe delete

Edit

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 MyProbe

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the probe.

--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 probe list

Edit

List probes.

az network application-gateway probe list --gateway-name
                                          --resource-group

Examples

List probes.

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

Edit

Get the details of a probe.

az network application-gateway probe show --gateway-name
                                          --name
                                          --resource-group

Examples

Get the details of a probe.

az network application-gateway probe show -g MyResourceGroup --gateway-name MyAppGateway -n MyProbe

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the probe.

--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 probe update

Edit

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 60

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the probe.

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

--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
--from-http-settings --host-name-from-http-settings

Whether to use host header from HTTP settings.

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

Whether to use host header from settings. Pick hostname from settings is currently not supported, now only support false.

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

Name of the host to send the probe.

--interval

Time interval in seconds between consecutive probes.

--match-body

Body that must be contained in the health response.

--match-status-codes

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.

--min-servers

Minimum number of servers that are always marked healthy.

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

Relative path of probe. Valid path starts from "/". Probe is sent to ://:.

--port

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

Protocol used for the probe.

Accepted values: Http, Https, Tcp, Tls
--remove

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

--set

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

--threshold

Number of failed probes after which the back end server is marked down.

--timeout

Probe 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 probe wait

Edit

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

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