az network lb probe

Evaluate probe information and define routing rules.

Commands

az network lb probe create

Create a probe.
az network lb probe delete

Delete a probe.
az network lb probe list

List probes.
az network lb probe show

Get the details of a probe.
az network lb probe update

Update a probe.

az network lb probe create

Edit

Create a probe.

az network lb probe create --lb-name
                           --name
                           --port
                           --protocol {Http, Https, Tcp}
                           --resource-group
                           [--interval]
                           [--path]
                           [--subscription]
                           [--threshold]

Examples

Create a probe on a load balancer over HTTP and port 80.

az network lb probe create -g MyResourceGroup --lb-name MyLb -n MyProbe \
    --protocol http --port 80 --path /

Create a probe on a load balancer over TCP on port 443.

az network lb probe create -g MyResourceGroup --lb-name MyLb -n MyProbe \
    --protocol tcp --port 443

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the probe.

--port

The port to interrogate.

--protocol

The protocol to probe.

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

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

Optional Parameters

--interval

Probing time interval in seconds.

--path

The endpoint to interrogate (http 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 consecutive probe failures before an instance is deemed unhealthy.

az network lb probe delete

Edit

Delete a probe.

az network lb probe delete --lb-name
                           --name
                           --resource-group
                           [--subscription]

Examples

Delete a probe.

az network lb probe delete -g MyResourceGroup --lb-name MyLb -n MyProbe

Required Parameters

--lb-name

The name of the load balancer.

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

Optional Parameters

--subscription

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

az network lb probe list

Edit

List probes.

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

Examples

List probes.

az network lb probe list -g MyResourceGroup --lb-name MyLb -o table

Required Parameters

--lb-name

The name of the load balancer.

--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 lb probe show

Edit

Get the details of a probe.

az network lb probe show --lb-name
                         --name
                         --resource-group
                         [--query-examples]
                         [--subscription]

Examples

Get the details of a probe.

az network lb probe show -g MyResourceGroup --lb-name MyLb -n MyProbe

Required Parameters

--lb-name

The name of the load balancer.

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

Edit

Update a probe.

az network lb probe update [--add]
                           [--force-string]
                           [--ids]
                           [--interval]
                           [--lb-name]
                           [--name]
                           [--path]
                           [--port]
                           [--protocol {Http, Https, Tcp}]
                           [--remove]
                           [--resource-group]
                           [--set]
                           [--subscription]
                           [--threshold]

Examples

Update a probe with a different port and interval.

az network lb probe update -g MyResourceGroup --lb-name MyLb -n MyProbe --port 81 --interval 10

Update a probe. (autogenerated)

az network lb probe update --lb-name MyLb --name MyProbe --port 81 --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.

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

Probing time interval in seconds.

--lb-name

The load balancer name.

--name -n

The name of the probe.

--path

The endpoint to interrogate (http only).

--port

The port to interrogate.

--protocol

The protocol to probe.

accepted values: Http, Https, Tcp
--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 consecutive probe failures before an instance is deemed unhealthy.