Application Gateway probes - az network application-gateway probe

Use probes to gather information, such as utilization, and then evaluate it by using rules.

Commands

az network application-gateway probe create Create a probe.
az network application-gateway probe delete Delete a probe.
az network application-gateway probe list List probes.
az network application-gateway probe show Show details of a probe.
az network application-gateway probe update Update a probe.

az network application-gateway probe create

Create a probe.

az network application-gateway probe create --gateway-name
--name
--path
--protocol {Http, Https}
--resource-group
[--host]
[--host-name-from-http-settings {false, true}]
[--interval]
[--match-body]
[--match-status-codes]
[--min-servers]
[--no-wait]
[--threshold]
[--timeout]

Examples

Create an application gateway probe.

az network application-gateway probe create -g MyResourceGroup -n MyProbe --protocol Https --gateway-name MyApplicationGateway --host 127.0.0.1 --path /path/to/probe

Required Parameters

--gateway-name

The name of the application gateway.

--name -n

The name of the probe.

--path

The relative path of the probe. Valid paths start from "/".

--protocol

The HTTP settings protocol.

accepted values: Http, Https
--resource-group -g

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

Optional Parameters

--host

The name of the host to send the probe.

--host-name-from-http-settings

Use host header from HTTP settings.

accepted values: false, true
--interval

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

--min-servers

Minimum number of servers that are always marked healthy.

--no-wait

Do not wait for the long running operation to finish.

--threshold

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

default value: 8
--timeout

The probe timeout in seconds.

default value: 120

az network application-gateway probe delete

Delete a probe.

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

Required Parameters

--gateway-name

The name of the application gateway.

--name -n

The name of the probe.

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

List probes.

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

Show details of a probe.

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

Required Parameters

--gateway-name

The name of the application gateway.

--name -n

The name of the probe.

--resource-group -g

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

az network application-gateway probe update

Update a probe.

az network application-gateway probe update --gateway-name
--name
--resource-group
[--add]
[--host]
[--host-name-from-http-settings {false, true}]
[--interval]
[--match-body]
[--match-status-codes]
[--min-servers]
[--no-wait]
[--path]
[--protocol {Http, Https}]
[--remove]
[--set]
[--threshold]
[--timeout]

Required Parameters

--gateway-name

The name of the application gateway.

--name -n

The name of the probe.

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

--host

The name of the host to send the probe.

--host-name-from-http-settings

Use host header from HTTP settings.

accepted values: false, true
--interval

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

--min-servers

Minimum number of servers that are always marked healthy.

--no-wait

Do not wait for the long running operation to finish.

--path

The relative path of the probe. Valid paths start from "/".

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

--threshold

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

--timeout

The probe timeout in seconds.