az network lb probe

  • Reference

Evaluate probe information and define routing rules.

Commands

Name Description Type Status
az network lb probe create

Create a probe in the load balance.

 Core GA
az network lb probe delete

Delete a probe in the load balancer.

 Core GA
az network lb probe list

List probes in the load balancer.

 Core GA
az network lb probe show

Get the details of a probe in the load balancer.

 Core GA
az network lb probe update

Update a probe in the load balancer.

 Core GA
az network lb probe wait

Place the CLI in a waiting state until a condition is met.

 Core GA

az network lb probe create

Edit

Create a probe in the load balance.

az network lb probe create --lb-name
                           --name
                           --port
                           --protocol {Http, Https, Tcp}
                           --resource-group
                           [--interval]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--number-of-probes]
                           [--path]
                           [--probe-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 for communicating the probe. Possible values range from 1 to 65535, inclusive.

--protocol

The protocol of the end point.

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 --interval-in-seconds

The interval, in seconds, for how frequently to probe the endpoint for health status.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--number-of-probes --threshold

The number of consecutive probe failures before an instance is deemed unhealthy.

--path --request-path

The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed.

--probe-threshold
Preview

The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. It is currently in preview and is not recommended for production workloads. For most scenarios, we recommend maintaining the default value of 1 by not specifying the value of the property.

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

Edit

Delete a probe in the load balancer.

az network lb probe delete --lb-name
                           --name
                           --resource-group
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Delete a probe.

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

Required Parameters

--lb-name

The load balancer name.

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

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

Edit

List probes in the load balancer.

az network lb probe list --lb-name
                         --resource-group

Examples

List probes

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

Required Parameters

--lb-name

The load balancer name.

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

Edit

Get the details of a probe in the load balancer.

az network lb probe show --lb-name
                         --name
                         --resource-group

Examples

Get the details of a probe.

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

Required Parameters

--lb-name

The load balancer name.

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

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

Edit

Update a probe in the load balancer.

az network lb probe update --lb-name
                           --name
                           --resource-group
                           [--add]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--interval]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--number-of-probes]
                           [--path]
                           [--port]
                           [--probe-threshold]
                           [--protocol {Http, Https, Tcp}]
                           [--remove]
                           [--set]

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

Required Parameters

--lb-name

The load balancer name.

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

--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
--interval --interval-in-seconds

The interval, in seconds, for how frequently to probe the endpoint for health status.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--number-of-probes --threshold

The number of consecutive probe failures before an instance is deemed unhealthy.

--path --request-path

The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed.

--port

The port for communicating the probe. Possible values range from 1 to 65535, inclusive.

--probe-threshold
Preview

The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. It is currently in preview and is not recommended for production workloads. For most scenarios, we recommend maintaining the default value of 1 by not specifying the value of the property.

--protocol

The protocol of the end point.

accepted values: Http, Https, Tcp
--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=.

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

Edit

Place the CLI in a waiting state until a condition is met.

az network lb probe wait [--created]
                         [--custom]
                         [--deleted]
                         [--exists]
                         [--ids]
                         [--interval]
                         [--lb-name]
                         [--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
--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
--lb-name

The load balancer name.

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