Share via

az afd custom-domain

  • Reference

Manage custom domains within the specified profile.

Commands

Name Description Type Status
az afd custom-domain create

Create a new domain within the specified profile.

 Core GA
az afd custom-domain delete

Delete an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

 Core GA
az afd custom-domain list

List existing AzureFrontDoor domains.

 Core GA
az afd custom-domain regenerate-validation-token

Updates the domain validation token.

 Core GA
az afd custom-domain show

Get an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

 Core GA
az afd custom-domain update

Update a new domain within the specified profile.

 Core GA
az afd custom-domain wait

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

 Core GA

az afd custom-domain create

Create a new domain within the specified profile.

az afd custom-domain create --custom-domain-name
                            --profile-name
                            --resource-group
                            [--azure-dns-zone]
                            [--certificate-type {AzureFirstPartyManagedCertificate, CustomerCertificate, ManagedCertificate}]
                            [--host-name]
                            [--minimum-tls-version {TLS10, TLS12}]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--secret]

Examples

Create a custom domain that uses AFD managed certificate for SSL/TLS encryption.

az afd custom-domain create -g group --custom-domain-name customDomain --profile-name profile --host-name www.contoso.com --minimum-tls-version TLS12 --certificate-type ManagedCertificate

Create a custom domain that uses your own certificate for SSL/TLS encryption, the certificate is stored in Azure Key Vault and referenced by an AFD secret.

az afd custom-domain create -g group --custom-domain-name customDomain --profile-name profile --host-name www.contoso.com --minimum-tls-version TLS12 --certificate-type CustomerCertificate --secret secretName

Required Parameters

--custom-domain-name --name -n

Name of the domain under the profile which is unique globally.

--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

--resource-group -g

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

Optional Parameters

--azure-dns-zone

ID of the Azure DNS zone.

--certificate-type

Defines the source of the SSL certificate.

Accepted values: AzureFirstPartyManagedCertificate, CustomerCertificate, ManagedCertificate
--host-name

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

--minimum-tls-version

TLS protocol version that will be used for Https.

Accepted values: TLS10, TLS12
--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--secret

Resource reference to the secret. ie. subs/rg/profile/secret.

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 afd custom-domain delete

Delete an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

az afd custom-domain delete [--custom-domain-name]
                            [--ids]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--profile-name]
                            [--resource-group]
                            [--subscription]
                            [--yes]

Examples

Delete a custom domain.

az afd custom-domain delete -g group --profile-name profile  --custom-domain-name customDomainName

Optional Parameters

--custom-domain-name --name -n

Name of the domain under the profile which is unique globally.

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

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

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

--yes -y

Do not prompt for confirmation.

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.

az afd custom-domain list

List existing AzureFrontDoor domains.

az afd custom-domain list --profile-name
                          --resource-group
                          [--max-items]
                          [--next-token]

Examples

List all the custom domains within the specified profile.

az afd custom-domain list -g group --profile-name profile

Required Parameters

--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

--resource-group -g

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

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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 afd custom-domain regenerate-validation-token

Updates the domain validation token.

az afd custom-domain regenerate-validation-token [--custom-domain-name]
                                                 [--ids]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--profile-name]
                                                 [--resource-group]
                                                 [--subscription]

Examples

Regenerate the domain validation token.

az afd custom-domain regenerate-validation-token -g MyResourceGroup --profile-name MyProfle --custom-domain-name MyCustomDomain

Optional Parameters

--custom-domain-name

Name of the domain under the profile which is unique globally.

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

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

--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 afd custom-domain show

Get an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

az afd custom-domain show [--custom-domain-name]
                          [--ids]
                          [--profile-name]
                          [--resource-group]
                          [--subscription]

Examples

show details of the custom domain within the specified profile.

az afd custom-domain show -g group --profile-name profile  --custom-domain-name customDomainName

Optional Parameters

--custom-domain-name --name -n

Name of the domain under the profile which is unique globally.

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

--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

--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 afd custom-domain update

Update a new domain within the specified profile.

az afd custom-domain update [--add]
                            [--azure-dns-zone]
                            [--certificate-type {AzureFirstPartyManagedCertificate, CustomerCertificate, ManagedCertificate}]
                            [--custom-domain-name]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--ids]
                            [--minimum-tls-version {TLS10, TLS12}]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--profile-name]
                            [--remove]
                            [--resource-group]
                            [--secret]
                            [--set]
                            [--subscription]

Examples

Update the custom domain's supported minimum TLS version.

az afd custom-domain update -g group --custom-domain-name customDomain --profile-name profile --minimum-tls-version TLS12

Update the custom domain's certificate type to AFD managed certificate.

az afd custom-domain update -g group --custom-domain-name customDomain --profile-name profile --certificate-type ManagedCertificate

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

--azure-dns-zone

ID of the Azure DNS zone.

--certificate-type

Defines the source of the SSL certificate.

Accepted values: AzureFirstPartyManagedCertificate, CustomerCertificate, ManagedCertificate
--custom-domain-name --name -n

Name of the domain under the profile which is unique globally.

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--minimum-tls-version

TLS protocol version that will be used for Https.

Accepted values: TLS10, TLS12
--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--profile-name

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

--remove

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

--resource-group -g

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

--secret

Resource reference to the secret. ie. subs/rg/profile/secret.

--set

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

--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 afd custom-domain wait

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

az afd custom-domain wait [--created]
                          [--custom]
                          [--custom-domain-name]
                          [--deleted]
                          [--exists]
                          [--ids]
                          [--interval]
                          [--profile-name]
                          [--resource-group]
                          [--subscription]
                          [--timeout]
                          [--updated]

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

--custom-domain-name --name -n

Name of the domain under the profile which is unique globally.

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

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

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