az network front-door

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

Manage Classical Azure Front Doors. For managing Azure Front Door Standard/Premium, please refer https://docs.microsoft.com/en-us/cli/azure/afd?view=azure-cli-latest.

Commands

Name	Description	Type	Status
az network front-door backend-pool	Manage Front Door backend pools.	Extension	GA
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 check-custom-domain	Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.	Extension	GA
az network front-door check-name-availability	Check the availability of a Front Door resource name.	Extension	GA
az network front-door create	Create a Front Door.	Extension	GA
az network front-door delete	Delete a Front Door.	Extension	GA
az network front-door frontend-endpoint	Manage Front Door frontend endpoints.	Extension	GA
az network front-door frontend-endpoint create	Create a Front Door frontend endpoint.	Extension	GA
az network front-door frontend-endpoint delete	Delete a Front Door frontend endpoint.	Extension	GA
az network front-door frontend-endpoint disable-https	Disable HTTPS protocol for a custom domain.	Extension	GA
az network front-door frontend-endpoint enable-https	Enable HTTPS protocol for a custom domain.	Extension	GA
az network front-door frontend-endpoint list	List Front Door frontend endpoints.	Extension	GA
az network front-door frontend-endpoint show	Get the details of a Front Door frontend endpoint.	Extension	GA
az network front-door frontend-endpoint wait	Place the CLI in a waiting state until a condition of the Front Door frontend endpoint is met.	Extension	GA
az network front-door list	List Front Doors.	Extension	GA
az network front-door load-balancing	Manage Front Door load-balancing settings.	Extension	GA
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 probe	Manage Front Door health probe settings.	Extension	GA
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 purge-endpoint	Removes a content from Front Door.	Extension	GA
az network front-door routing-rule	Manage Front Door routing rules.	Extension	GA
az network front-door routing-rule create	Create a Front Door routing rule.	Extension	GA
az network front-door routing-rule delete	Delete a Front Door routing rule.	Extension	GA
az network front-door routing-rule list	List Front Door routing rules.	Extension	GA
az network front-door routing-rule show	Get the details of a Front Door routing rule.	Extension	GA
az network front-door routing-rule update	Update a Front Door routing rule.	Extension	GA
az network front-door rules-engine	Manage Front Door rules engines.	Extension	GA
az network front-door rules-engine delete	Deletes an existing Rules Engine Configuration with the specified parameters.	Extension	GA
az network front-door rules-engine list	Lists all of the Rules Engine Configurations within a Front Door.	Extension	GA
az network front-door rules-engine rule	Manage Rules Engine rules.	Extension	GA
az network front-door rules-engine rule action	Manage Rules Engine actions for Front Door.	Extension	GA
az network front-door rules-engine rule action add	Add an action to a Rules Engine rule.	Extension	GA
az network front-door rules-engine rule action list	Show all actions that apply for a Rules Engine rule.	Extension	GA
az network front-door rules-engine rule action remove	Remove an action from a Rules Engine rule.	Extension	GA
az network front-door rules-engine rule condition	Manage Rules Engine match conditions for Front Door.	Extension	GA
az network front-door rules-engine rule condition add	Add a match condition to a Rules Engine rule.	Extension	GA
az network front-door rules-engine rule condition list	Show all match conditions associated with a Rules Engine rule.	Extension	GA
az network front-door rules-engine rule condition remove	Remove a match condition from a Rules Engine rule.	Extension	GA
az network front-door rules-engine rule create	Create a Rules Engine rule for a Front Door.	Extension	GA
az network front-door rules-engine rule delete	Delete a Rules Engine rule.	Extension	GA
az network front-door rules-engine rule list	List rules of a Rules Engine configuration.	Extension	GA
az network front-door rules-engine rule show	Get the details of a Rules Engine rule.	Extension	GA
az network front-door rules-engine rule update	Update Rules Engine configuration of a rule.	Extension	GA
az network front-door rules-engine show	Gets a Rules Engine Configuration with the specified name within the specified Front Door.	Extension	GA
az network front-door show	Get the details of a Front Door.	Extension	GA
az network front-door update	Update settings of a Front Door.	Extension	GA
az network front-door waf-policy	Manage WebApplication Firewall (WAF) policies.	Extension	GA
az network front-door waf-policy create	Create a WAF policy.	Extension	GA
az network front-door waf-policy delete	Delete a WAF policy.	Extension	GA
az network front-door waf-policy list	List WAF policies.	Extension	GA
az network front-door waf-policy managed-rule-definition	Learn about available managed rule sets.	Extension	GA
az network front-door waf-policy managed-rule-definition list	Show a detailed list of available managed rule sets.	Extension	GA
az network front-door waf-policy managed-rules	Change and view managed rule sets associated with your WAF policy.	Extension	GA
az network front-door waf-policy managed-rules add	Add a managed rule set to a WAF policy.	Extension	GA
az network front-door waf-policy managed-rules exclusion	View and alter exclusions on a managed rule set, rule group, or rule within a managed rule set.	Extension	GA
az network front-door waf-policy managed-rules exclusion add	Add an exclusion on a managed rule set, rule group, or rule within a managed rule set.	Extension	GA
az network front-door waf-policy managed-rules exclusion list	List the exclusions on managed rule set, rule group, or rule within a managed rule set.	Extension	GA
az network front-door waf-policy managed-rules exclusion remove	Remove an exclusion on a managed rule set, rule group, or rule within a managed rule set.	Extension	GA
az network front-door waf-policy managed-rules list	Show which managed rule sets are applied to a WAF policy.	Extension	GA
az network front-door waf-policy managed-rules override	View and alter overrides on managed rules within a managed rule set.	Extension	GA
az network front-door waf-policy managed-rules override add	Add an override on a managed rule within a managed rule set.	Extension	GA
az network front-door waf-policy managed-rules override list	List the overrides on managed rules within a managed rule set.	Extension	GA
az network front-door waf-policy managed-rules override remove	Remove an override on a managed rule within a managed rule set.	Extension	GA
az network front-door waf-policy managed-rules remove	Remove a managed rule set from a WAF policy.	Extension	GA
az network front-door waf-policy rule	Manage WAF policy custom rules.	Extension	GA
az network front-door waf-policy rule create	Create a WAF policy custom rule. Use --defer and add a rule match-condition.	Extension	GA
az network front-door waf-policy rule delete	Delete a WAF policy custom rule.	Extension	GA
az network front-door waf-policy rule list	List WAF policy custom rules.	Extension	GA
az network front-door waf-policy rule match-condition	Alter match-conditions associated with a WAF policy custom rule.	Extension	GA
az network front-door waf-policy rule match-condition add	Add a match-condition to a WAF policy custom rule.	Extension	GA
az network front-door waf-policy rule match-condition list	Show all match-conditions associated with a WAF policy custom rule.	Extension	GA
az network front-door waf-policy rule match-condition remove	Remove a match-condition from a WAF policy custom rule.	Extension	GA
az network front-door waf-policy rule show	Get the details of a WAF policy custom rule.	Extension	GA
az network front-door waf-policy rule update	Alter the details of a WAF policy custom rule.	Extension	GA
az network front-door waf-policy show	Get the details of a WAF policy.	Extension	GA
az network front-door waf-policy update	Update settings of a WAF policy.	Extension	GA
az network front-door wait	Place the CLI in a waiting state until a condition of the Front Door is met.	Extension	GA

az network front-door check-custom-domain

Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.

az network front-door check-custom-domain --host-name
                                          [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]

Required Parameters

--host-name

Required. The host name of the custom domain. Must be a domain name.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the Front Door.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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 check-name-availability

Check the availability of a Front Door resource name.

az network front-door check-name-availability --name
                                              --resource-type {Microsoft.Network/frontDoors, Microsoft.Network/frontDoors/frontendEndpoints}

Examples

Check the availability of a Front Door resource name.

az network front-door check-name-availability --name frontdoor1 --resource-type Microsoft.Network/frontDoors

Required Parameters

--name

The resource name to be validated.

--resource-type

The type of the resource whose name is to be validated.

accepted values: Microsoft.Network/frontDoors, Microsoft.Network/frontDoors/frontendEndpoints

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 create

Create a Front Door.

az network front-door create --backend-address
                             --name
                             --resource-group
                             [--accepted-protocols]
                             [--backend-host-header]
                             [--disabled {false, true}]
                             [--enforce-certificate-name-check {Disabled, Enabled}]
                             [--forwarding-protocol {HttpOnly, HttpsOnly, MatchRequest}]
                             [--friendly-name]
                             [--frontend-host-name]
                             [--interval]
                             [--no-wait]
                             [--path]
                             [--patterns]
                             [--probeMethod {GET, HEAD}]
                             [--protocol {Http, Https}]
                             [--send-recv-timeout]
                             [--tags]

Required Parameters

--backend-address

FQDN of the backend endpoint.

--name -n

Name of the Front Door.

--resource-group -g

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

Optional Parameters

--accepted-protocols

Space-separated list of protocols to accept. Default: Http.

--backend-host-header

Host header sent to the backend.

--disabled

Create in a disabled state.

accepted values: false, true

--enforce-certificate-name-check

Whether to disable certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests.

accepted values: Disabled, Enabled

default value: Enabled

--forwarding-protocol

Protocol to use for forwarding traffic.

accepted values: HttpOnly, HttpsOnly, MatchRequest

default value: MatchRequest

--friendly-name

Friendly name of the Front Door.

--frontend-host-name

Domain name of the frontend endpoint.

--interval

Interval in seconds between probes.

default value: 30

--no-wait

Do not wait for the long-running operation to finish.

default value: False

--path

Path to probe.

default value: /

--patterns

Space-separated list of patterns to match. Default: '/*'.

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

default value: Https

--send-recv-timeout

Send and receive timeout in seconds on forwarding request to the backend. When timeout is reached, the request fails and returns.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 delete

Delete a Front Door.

az network front-door delete [--ids]
                             [--name]
                             [--no-wait]
                             [--resource-group]
                             [--subscription]

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the Front Door.

--no-wait

Do not wait for the long-running operation to finish.

default value: False

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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 list

List Front Doors.

az network front-door list [--resource-group]

Optional Parameters

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

Removes a content from Front Door.

az network front-door purge-endpoint --content-paths
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Required Parameters

--content-paths

The path to the content to be purged. Can describe a file path or a wildcard directory.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the Front Door.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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 show

Get the details of a Front Door.

az network front-door show [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the Front Door.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

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 update

Update settings of a Front Door.

az network front-door update [--add]
                             [--enforce-certificate-name-check {Disabled, Enabled}]
                             [--force-string]
                             [--ids]
                             [--name]
                             [--remove]
                             [--resource-group]
                             [--send-recv-timeout]
                             [--set]
                             [--subscription]
                             [--tags]

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: []

--enforce-certificate-name-check

Whether to disable certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests.

accepted values: Disabled, Enabled

--force-string

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

default value: False

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the Front Door.

--remove

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

default value: []

--resource-group -g

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

--send-recv-timeout

Send and receive timeout in seconds on forwarding request to the backend. When timeout is reached, the request fails and returns.

--set

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

default value: []

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 wait

Place the CLI in a waiting state until a condition of the Front Door is met.

az network front-door wait [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--ids]
                           [--interval]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--timeout]
                           [--updated]

Examples

Wait until a front door is created.

az network front-door wait -g MyResourceGroup --name frontdoor1 --created

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False

--exists

Wait until the resource exists.

default value: False

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

default value: 30

--name -n

Name of the Front Door.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False

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.