Share via

az network front-door frontend-endpoint

Note

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

Manage Front Door frontend endpoints.

Commands

Name Description Type Status
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 frontend-endpoint create

Create a Front Door frontend endpoint.

az network front-door frontend-endpoint create --front-door-name
                                               --host-name
                                               --name
                                               --resource-group
                                               [--session-affinity-enabled {Disabled, Enabled}]
                                               [--session-affinity-ttl]
                                               [--waf-policy]

Required Parameters

--front-door-name -f

Name of the Front Door.

--host-name

Domain name of the frontend endpoint.

--name -n

Name of the frontend endpoint.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--session-affinity-enabled

Whether to allow session affinity on this host.

Property Value
Accepted values: Disabled, Enabled
--session-affinity-ttl

The TTL to use in seconds for session affinity.

--waf-policy

Name or ID of a web application firewall policy.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network front-door frontend-endpoint delete

Delete a Front Door frontend endpoint.

az network front-door frontend-endpoint delete --front-door-name
                                               --name
                                               --resource-group

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

Name of the frontend endpoint.

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

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network front-door frontend-endpoint disable-https

Disable HTTPS protocol for a custom domain.

az network front-door frontend-endpoint disable-https --front-door-name
                                                      --name
                                                      --resource-group

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

Name of the frontend endpoint.

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

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network front-door frontend-endpoint enable-https

Enable HTTPS protocol for a custom domain.

HTTPS protocol for a custom domain can be enabled using Front Door managed certificate or using your own certificate in Azure Key Vault. For Azure Key Vault, right permissions need to be set for Front Door to access the Key vault. Learn more at https://aka.ms/FrontDoorCustomDomain.

az network front-door frontend-endpoint enable-https --front-door-name
                                                     --name
                                                     --resource-group
                                                     [--certificate-source {AzureKeyVault, FrontDoor}]
                                                     [--minimum-tls-version {1.0, 1.2}]
                                                     [--secret-name]
                                                     [--secret-version]
                                                     [--vault-id]

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

Name of the frontend endpoint.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--certificate-source

Certificate source to enable HTTPS.

Property Value
Parameter group: HTTPS Arguments
Default value: FrontDoor
Accepted values: AzureKeyVault, FrontDoor
--minimum-tls-version

The minimum TLS version required from the clients to establish an SSL handshake with Front Door.

Property Value
Parameter group: HTTPS Arguments
Default value: 1.2
Accepted values: 1.0, 1.2
--secret-name

The name of the Key Vault secret representing the full certificate PFX.

Property Value
Parameter group: HTTPS Arguments
--secret-version

The version of the Key Vault secret representing the full certificate PFX, the "Latest" version will always be used if not specified and your certificate will be auto-rotated when a new version of secret generated.

Property Value
Parameter group: HTTPS Arguments
--vault-id

The resource id of the Key Vault containing the SSL certificate.

Property Value
Parameter group: HTTPS Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network front-door frontend-endpoint list

List Front Door frontend endpoints.

az network front-door frontend-endpoint 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.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network front-door frontend-endpoint show

Get the details of a Front Door frontend endpoint.

az network front-door frontend-endpoint show --front-door-name
                                             --name
                                             --resource-group

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

Name of the frontend endpoint.

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

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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.

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

Examples

Wait until a front endpoint's certificate is deployed.

az network front-door frontend-endpoint wait -g MyResourceGroup --name endpoint1 --front-door-name frontdoor1 --custom "customHttpsProvisioningState=='Enabled'"

Required Parameters

--front-door-name -f

Name of the Front Door.

--name -n

Name of the frontend endpoint.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False