az network front-door backend-pool

  • Reference

Note

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

Manage Front Door backend pools.

Commands

Name Description Type Status
az network front-door backend-pool backend

Manage backends of Front Door backend pools.

 Extension GA
az network front-door backend-pool backend add

Add a backend to a Front Door backend pool.

 Extension GA
az network front-door backend-pool backend list

List backends of a Front Door backend pool.

 Extension GA
az network front-door backend-pool backend remove

Remove a backend from a Front Door backend pool.

 Extension GA
az network front-door backend-pool backend update

Update a backend to a Front Door backend pool.

 Extension GA
az network front-door backend-pool create

Create a Front Door backend pool.

 Extension GA
az network front-door backend-pool delete

Delete a Front Door backend pool.

 Extension GA
az network front-door backend-pool list

List Front Door backend pools.

 Extension GA
az network front-door backend-pool show

Get the details of a Front Door backend pool.

 Extension GA

az network front-door backend-pool create

Create a Front Door backend pool.

Since a backend pool must contain a backend, this command also creates the first backend. To add additional backends, use the az network front-door backend-pool backend add command.

az network front-door backend-pool create --address
                                          --front-door-name
                                          --load-balancing
                                          --name
                                          --probe
                                          --resource-group
                                          [--backend-host-header]
                                          [--disabled {false, true}]
                                          [--http-port]
                                          [--https-port]
                                          [--priority]
                                          [--weight]

Required Parameters

--address

FQDN of the backend endpoint.

--front-door-name -f

Name of the Front Door.

--load-balancing

Name or ID of the load balancing settings.

--name -n

Name of the backend pool.

--probe

Name or ID of the probe settings.

--resource-group -g

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

Optional Parameters

--backend-host-header

Host header sent to the backend.

--disabled

Create in a disabled state.

accepted values: false, true
--http-port

HTTP TCP port number.

default value: 80
--https-port

HTTPS TCP port number.

default value: 443
--priority

Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy.

default value: 1
--weight

Weight of this endpoint for load balancing purposes.

default value: 50
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 backend-pool delete

Delete a Front Door backend pool.

az network front-door backend-pool delete --front-door-name
                                          --name
                                          --resource-group

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

Name of the backend pool.

--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 backend-pool list

List Front Door backend pools.

az network front-door backend-pool 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 backend-pool show

Get the details of a Front Door backend pool.

az network front-door backend-pool show --front-door-name
                                        --name
                                        --resource-group

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

Name of the backend pool.

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