az network front-door probe

Note

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

Manage Front Door health probe settings.

Commands

Name	Description	Type	Status
az network front-door probe create	Create Front Door health probe settings.	Extension	GA
az network front-door probe delete	Delete Front Door health probe settings.	Extension	GA
az network front-door probe list	List Front Door health probe settings.	Extension	GA
az network front-door probe show	Get the details of a Front Door health probe settings.	Extension	GA
az network front-door probe update	Update Front Door health probe settings.	Extension	GA

az network front-door probe create

Create Front Door health probe settings.

az network front-door probe create --front-door-name
                                   --interval
                                   --name
                                   --path
                                   --resource-group
                                   [--enabled {Disabled, Enabled}]
                                   [--probeMethod {GET, HEAD}]
                                   [--protocol {Http, Https}]

Required Parameters

--front-door-name -f

Name of the Front Door.

--interval

Interval in seconds between probes.

--name -n

Name of the health probe.

--path

Path to probe.

--resource-group -g

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

Optional Parameters

--enabled

Enabled status.

Accepted values: Disabled, Enabled

Default value: Enabled

--probeMethod

Configures which HTTP method to use to probe the backends defined under backendPools.

Accepted values: GET, HEAD

Default value: HEAD

--protocol

Protocol to use for sending probes.

Accepted values: Http, Https

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 front-door probe delete

Delete Front Door health probe settings.

az network front-door probe delete --front-door-name
                                   --name
                                   --resource-group

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

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

--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 front-door probe list

List Front Door health probe settings.

az network front-door probe list --front-door-name
                                 --resource-group

Required Parameters

--front-door-name -f

Name of the Front Door.

--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 front-door probe show

Get the details of a Front Door health probe settings.

az network front-door probe show --front-door-name
                                 --name
                                 --resource-group

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

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

--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 front-door probe update

Update Front Door health probe settings.

az network front-door probe update --front-door-name
                                   --name
                                   --resource-group
                                   [--enabled {Disabled, Enabled}]
                                   [--interval]
                                   [--path]
                                   [--probeMethod {GET, HEAD}]
                                   [--protocol {Http, Https}]

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

Name of the health probe.

--resource-group -g

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

Optional Parameters

--enabled

Enabled status.

Accepted values: Disabled, Enabled

--interval

Interval in seconds between probes.

--path

Path to probe.

--probeMethod

Configures which HTTP method to use to probe the backends defined under backendPools.

Accepted values: GET, HEAD

--protocol

Protocol to use for sending probes.

Accepted values: Http, Https

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.