az network lb probe

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

Create a probe in the load balance.

az network lb probe create --lb-name
                           --name
                           --port
                           --protocol {Http, Https, Tcp}
                           --resource-group
                           [--interval --interval-in-seconds]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--number-of-probes --threshold]
                           [--path --request-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.

Property	Value
Parameter group:	Properties Arguments

--protocol

The protocol of the end point.

Property	Value
Parameter group:	Properties Arguments
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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--interval --interval-in-seconds

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

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

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

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Properties Arguments

--probe-threshold

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.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network lb probe delete

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network lb probe list

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.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network lb probe show

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.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network lb probe update

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 --interval-in-seconds]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--number-of-probes --threshold]
                           [--path --request-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Generic Update Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
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.

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

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

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Properties Arguments

--port

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

Property	Value
Parameter group:	Properties Arguments

--probe-threshold

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.

Property	Value
Parameter group:	Properties Arguments

--protocol

The protocol of the end point.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Http, Https, Tcp

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network lb probe wait

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--lb-name

The load balancer name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False