az network application-gateway probe

Manage probes to gather and evaluate information on a gateway.

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

Get the 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]
                                            [--port]
                                            [--subscription]
                                            [--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 /path/to/probe

Required Parameters

--gateway-name

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

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.

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--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]
                                            [--ids]
                                            [--name]
                                            [--no-wait]
                                            [--resource-group]
                                            [--subscription]

Examples

Delete a probe.

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

Delete a probe. (autogenerated)

az network application-gateway probe delete --gateway-name MyAppGateway --name MyProbe --resource-group MyResourceGroup --subscription MySubscription

Optional Parameters

--gateway-name

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

--name -n

The name of the probe.

--no-wait

Do not wait for the long-running operation to finish.

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

az network application-gateway probe list

List probes.

az network application-gateway probe list --gateway-name
                                          --resource-group
                                          [--query-examples]
                                          [--subscription]

Examples

List probes.

az network application-gateway probe list -g MyResourceGroup --gateway-name MyAppGateway

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

Optional Parameters

--query-examples

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.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az network application-gateway probe show

Get the details of a probe.

az network application-gateway probe show [--gateway-name]
                                          [--ids]
                                          [--name]
                                          [--query-examples]
                                          [--resource-group]
                                          [--subscription]

Examples

Get the details of a probe.

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

Optional Parameters

--gateway-name

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

--name -n

The name of the probe.

--query-examples

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.

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

az network application-gateway probe update

Update a probe.

az network application-gateway probe update [--add]
                                            [--force-string]
                                            [--gateway-name]
                                            [--host]
                                            [--host-name-from-http-settings {false, true}]
                                            [--ids]
                                            [--interval]
                                            [--match-body]
                                            [--match-status-codes]
                                            [--min-servers]
                                            [--name]
                                            [--no-wait]
                                            [--path]
                                            [--port]
                                            [--protocol {Http, Https}]
                                            [--remove]
                                            [--resource-group]
                                            [--set]
                                            [--subscription]
                                            [--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

Update a probe. (autogenerated)

az network application-gateway probe update --gateway-name MyAppGateway --host 127.0.0.1 --name MyProbe --resource-group MyResourceGroup --subscription MySubscription

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.

--gateway-name

Name of the application gateway.

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

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.

--name -n

The name of the probe.

--no-wait

Do not wait for the long-running operation to finish.

--path

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

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

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.

--resource-group -g

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

--set

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--threshold

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

--timeout

The probe timeout in seconds.