az network front-door load-balancing

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 load-balancing command. Learn more about extensions.

Manage Front Door load-balancing settings.

Commands

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

az network front-door load-balancing create

Create Front Door load-balancing settings.

az network front-door load-balancing create --front-door-name
                                            --name
                                            --resource-group
                                            --sample-size
                                            --successful-samples-required
                                            [--additional-latency]

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

Name of the load balancing settings.

--resource-group -g

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

--sample-size

The number of samples to consider for load balancing decisions.

--successful-samples-required -s

The number of samples within the sample period that must succeed.

Optional Parameters

--additional-latency

The additional latency in milliseconds for probes to fall in the lowest latency bucket.

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 load-balancing delete

Delete Front Door load-balancing settings.

az network front-door load-balancing delete --front-door-name
                                            --name
                                            --resource-group

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

Name of the load balancing settings.

--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 load-balancing list

List Front Door load-balancing settingss.

az network front-door load-balancing 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 load-balancing show

Get the details of a Front Door load-balancing settings bundle.

az network front-door load-balancing show --front-door-name
                                          --name
                                          --resource-group

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

Name of the load balancing settings.

--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 load-balancing update

Update Front Door load-balancing settings.

az network front-door load-balancing update --front-door-name
                                            --name
                                            --resource-group
                                            [--add]
                                            [--additional-latency]
                                            [--force-string]
                                            [--remove]
                                            [--sample-size]
                                            [--set]
                                            [--successful-samples-required]

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

Name of the load balancing settings.

--resource-group -g

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

Optional Parameters

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

Default value: []

--additional-latency

The additional latency in milliseconds for probes to fall in the lowest latency bucket.

--force-string

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

Default value: False

--remove

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

Default value: []

--sample-size

The number of samples to consider for load balancing decisions.

--set

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

Default value: []

--successful-samples-required -s

The number of samples within the sample period that must succeed.

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.