Del via

az stack-hci-vm network lb probe

Note

This reference is part of the stack-hci-vm extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az stack-hci-vm network lb probe command. Learn more about extensions.

Manage health probes attached to load balancers.

Commands

Name Description Type Status
az stack-hci-vm network lb probe add

Add a TCP or HTTP health probe.

 Extension GA
az stack-hci-vm network lb probe delete

Delete a probe.

 Extension GA
az stack-hci-vm network lb probe list

List probes configured on a load balancer.

 Extension GA
az stack-hci-vm network lb probe show

Show details for a probe configuration.

 Extension GA
az stack-hci-vm network lb probe update

Update probe settings such as interval or threshold.

 Extension GA

az stack-hci-vm network lb probe add

Add a TCP or HTTP health probe.

az stack-hci-vm network lb probe add --lb-name
                                     --name
                                     --port
                                     --protocol {Http, Tcp}
                                     --resource-group
                                     [--interval]
                                     [--path]
                                     [--threshold]

Examples

Add HTTP Probe

az stack-hci-vm network lb probe add --resource-group "test-rg" --lb-name "test-lb" --name "healthz" --protocol Http --port 8080 --path /healthz --interval 10 --threshold 2

Required Parameters

--lb-name

Name of the load balancer that owns the health probe.

--name -n

Name of the health probe to create.

--port

Port to probe on the backend instances.

--protocol

Specify Tcp or Http.

Property Value
Accepted values: Http, 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

Probe interval in seconds.

--path

Required when protocol is Http.

--threshold

Number of consecutive failures before marking backend unhealthy.

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 stack-hci-vm network lb probe delete

Delete a probe.

az stack-hci-vm network lb probe delete --lb-name
                                        --name
                                        --resource-group
                                        [--yes]

Examples

Delete Probe

az stack-hci-vm network lb probe delete --resource-group "test-rg" --lb-name "test-lb" --name "healthz" --yes

Required Parameters

--lb-name

Name of the load balancer that owns the health probe.

--name -n

Name of the health probe to delete.

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

--yes -y

Do not prompt for confirmation.

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

--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 stack-hci-vm network lb probe list

List probes configured on a load balancer.

az stack-hci-vm network lb probe list --lb-name
                                      --resource-group

Examples

List Probes

az stack-hci-vm network lb probe list --resource-group "test-rg" --lb-name "test-lb"

Required Parameters

--lb-name

Name of the load balancer that owns the health 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 stack-hci-vm network lb probe show

Show details for a probe configuration.

az stack-hci-vm network lb probe show --lb-name
                                      --name
                                      --resource-group

Examples

Show Probe

az stack-hci-vm network lb probe show --resource-group "test-rg" --lb-name "test-lb" --name "probe-base"

Required Parameters

--lb-name

Name of the load balancer that owns the health probe.

--name -n

Name of the health probe to show.

--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 stack-hci-vm network lb probe update

Update probe settings such as interval or threshold.

az stack-hci-vm network lb probe update --lb-name
                                        --name
                                        --resource-group
                                        [--interval]
                                        [--path]
                                        [--port]
                                        [--protocol {Http, Tcp}]
                                        [--threshold]

Examples

Slow Down Probe Frequency

az stack-hci-vm network lb probe update --resource-group "test-rg" --lb-name "test-lb" --name "healthz" --interval 15 --threshold 4

Required Parameters

--lb-name

Name of the load balancer that owns the health probe.

--name -n

Name of the health probe to update.

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

Updated probe interval in seconds.

--path

Updated probe path. Provide empty string to clear.

--port

Updated port to probe.

--protocol

Updated probe protocol.

Property Value
Accepted values: Http, Tcp
--threshold

Updated unhealthy threshold.

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