az network front-door backend-pool backend

  • Reference

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 backend-pool backend command. Learn more about extensions.

Manage backends of Front Door backend pools.

Commands

Name Description Type Status
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 backend add

Add a backend to a Front Door backend pool.

az network front-door backend-pool backend add --address
                                               --front-door-name
                                               --pool-name
                                               --resource-group
                                               [--approval-message]
                                               [--backend-host-header]
                                               [--disabled {false, true}]
                                               [--http-port]
                                               [--https-port]
                                               [--priority]
                                               [--private-link-alias]
                                               [--private-link-location]
                                               [--private-link-resource-id]
                                               [--weight]

Required Parameters

--address

FQDN of the backend endpoint.

--front-door-name -f

Name of the Front Door.

--pool-name

Name of the backend pool.

--resource-group -g

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

Optional Parameters

--approval-message --private-link-approval-message

A custom message to be included in the approval request to connect to the Private Link.

--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
--private-link-alias

The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private'.

--private-link-location

The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated.

--private-link-resource-id --resource-id

The Resource Id of the Private Link. Populating this optional field indicates that this backend is 'Private'.

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

List backends of a Front Door backend pool.

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

Required Parameters

--front-door-name -f

Name of the Front Door.

--pool-name

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

Remove a backend from a Front Door backend pool.

az network front-door backend-pool backend remove --front-door-name
                                                  --index
                                                  --pool-name
                                                  --resource-group

Required Parameters

--front-door-name -f

Name of the Front Door.

--index

Index of the backend to remove (starting with 1).

--pool-name

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

Update a backend to a Front Door backend pool.

az network front-door backend-pool backend update --front-door-name
                                                  --index
                                                  --pool-name
                                                  --resource-group
                                                  [--address]
                                                  [--approval-message]
                                                  [--backend-host-header]
                                                  [--disabled {false, true}]
                                                  [--http-port]
                                                  [--https-port]
                                                  [--priority]
                                                  [--private-link-alias]
                                                  [--private-link-location]
                                                  [--private-link-resource-id]
                                                  [--weight]

Required Parameters

--front-door-name -f

Name of the Front Door.

--index

Index of the backend to remove (starting with 1).

--pool-name

Name of the backend pool.

--resource-group -g

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

Optional Parameters

--address

FQDN of the backend endpoint.

--approval-message --private-link-approval-message

A custom message to be included in the approval request to connect to the Private Link.

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

--https-port

HTTPS TCP port number.

--priority

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

--private-link-alias

The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private'.

--private-link-location

The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated.

--private-link-resource-id --resource-id

The Resource Id of the Private Link. Populating this optional field indicates that this backend is 'Private'.

--weight

Weight of this endpoint for load balancing purposes.

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.