az afd custom-domain

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

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 create (cdn extension)	Create a new domain within the specified profile.	Extension	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 delete (cdn extension)	Delete an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.	Extension	GA
az afd custom-domain list	List existing AzureFrontDoor domains.	Core	GA
az afd custom-domain list (cdn extension)	List existing AzureFrontDoor domains.	Extension	GA
az afd custom-domain regenerate-validation-token	Updates the domain validation token.	Core	GA
az afd custom-domain regenerate-validation-token (cdn extension)	Updates the domain validation token.	Extension	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 show (cdn extension)	Get an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.	Extension	GA
az afd custom-domain update	Update a new domain within the specified profile.	Core	GA
az afd custom-domain update (cdn extension)	Update a new domain within the specified profile.	Extension	GA
az afd custom-domain wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az afd custom-domain wait (cdn extension)	Place the CLI in a waiting state until a condition is met.	Extension	GA

az afd custom-domain create

Create a new domain within the specified profile.

az afd custom-domain create --custom-domain-name --name
                            --profile-name
                            --resource-group
                            [--acquire-policy-token]
                            [--azure-dns-zone]
                            [--certificate-type {AzureFirstPartyManagedCertificate, CustomerCertificate, ManagedCertificate}]
                            [--change-reference]
                            [--cipher-suite-set-type {Customized, TLS10_2019, TLS12_2022, TLS12_2023}]
                            [--customized-cipher-suite-set]
                            [--host-name]
                            [--minimum-tls-version {TLS10, TLS12, TLS13}]
                            [--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 example-custom-domain --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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--azure-dns-zone

ID of the Azure DNS zone.

Property	Value
Parameter group:	AzureDnsZone Arguments

--certificate-type

Defines the source of the SSL certificate.

Property	Value
Parameter group:	TlsSettings Arguments
Accepted values:	AzureFirstPartyManagedCertificate, CustomerCertificate, ManagedCertificate

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cipher-suite-set-type

Cipher suite set type that will be used for Https.

Property	Value
Parameter group:	TlsSettings Arguments
Accepted values:	Customized, TLS10_2019, TLS12_2022, TLS12_2023

--customized-cipher-suite-set

Customized cipher suites object that will be used for Https when cipherSuiteSetType is Customized. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	TlsSettings Arguments

--host-name

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

Property	Value
Parameter group:	Properties Arguments

--minimum-tls-version

TLS protocol version that will be used for Https.

Property	Value
Parameter group:	TlsSettings Arguments
Accepted values:	TLS10, TLS12, TLS13

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--secret

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

Property	Value
Parameter group:	Secret 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 afd custom-domain create (cdn extension)

Create a new domain within the specified profile.

az afd custom-domain create --custom-domain-name --name
                            --profile-name
                            --resource-group
                            [--acquire-policy-token]
                            [--azure-dns-zone]
                            [--certificate-type {AzureFirstPartyManagedCertificate, CustomerCertificate, ManagedCertificate}]
                            [--change-reference]
                            [--cipher-suite-set-type {Customized, TLS10_2019, TLS12_2022, TLS12_2023}]
                            [--customized-cipher-suite-set]
                            [--host-name]
                            [--minimum-tls-version {TLS10, TLS12, TLS13}]
                            [--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 example-custom-domain --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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--azure-dns-zone

ID of the Azure DNS zone.

Property	Value
Parameter group:	AzureDnsZone Arguments

--certificate-type

Defines the source of the SSL certificate.

Property	Value
Parameter group:	TlsSettings Arguments
Accepted values:	AzureFirstPartyManagedCertificate, CustomerCertificate, ManagedCertificate

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cipher-suite-set-type

Cipher suite set type that will be used for Https.

Property	Value
Parameter group:	TlsSettings Arguments
Accepted values:	Customized, TLS10_2019, TLS12_2022, TLS12_2023

--customized-cipher-suite-set

Customized cipher suites object that will be used for Https when cipherSuiteSetType is Customized. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	TlsSettings Arguments

--host-name

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

Property	Value
Parameter group:	Properties Arguments

--minimum-tls-version

TLS protocol version that will be used for Https.

Property	Value
Parameter group:	TlsSettings Arguments
Accepted values:	TLS10, TLS12, TLS13

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--secret

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

Property	Value
Parameter group:	Secret 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 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 [--acquire-policy-token]
                            [--change-reference]
                            [--custom-domain-name --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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az afd custom-domain delete (cdn extension)

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

az afd custom-domain delete [--acquire-policy-token]
                            [--change-reference]
                            [--custom-domain-name --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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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

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

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

Property	Value
Parameter group:	Pagination 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 afd custom-domain list (cdn extension)

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

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

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

Property	Value
Parameter group:	Pagination 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 afd custom-domain regenerate-validation-token

Updates the domain validation token.

az afd custom-domain regenerate-validation-token [--acquire-policy-token]
                                                 [--change-reference]
                                                 [--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--custom-domain-name

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az afd custom-domain regenerate-validation-token (cdn extension)

Updates the domain validation token.

az afd custom-domain regenerate-validation-token [--acquire-policy-token]
                                                 [--change-reference]
                                                 [--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--custom-domain-name

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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

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

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

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	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.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az afd custom-domain show (cdn extension)

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

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

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

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	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.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az afd custom-domain update

Update a new domain within the specified profile.

az afd custom-domain update [--acquire-policy-token]
                            [--add]
                            [--azure-dns-zone]
                            [--certificate-type {AzureFirstPartyManagedCertificate, CustomerCertificate, ManagedCertificate}]
                            [--change-reference]
                            [--cipher-suite-set-type {Customized, TLS10_2019, TLS12_2022, TLS12_2023}]
                            [--custom-domain-name --name]
                            [--customized-cipher-suite-set]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--ids]
                            [--minimum-tls-version {TLS10, TLS12, TLS13}]
                            [--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

Property	Value
Parameter group:	Generic Update Arguments

--azure-dns-zone

ID of the Azure DNS zone.

Property	Value
Parameter group:	AzureDnsZone Arguments

--certificate-type

Defines the source of the SSL certificate.

Property	Value
Parameter group:	TlsSettings Arguments
Accepted values:	AzureFirstPartyManagedCertificate, CustomerCertificate, ManagedCertificate

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cipher-suite-set-type

Cipher suite set type that will be used for Https.

Property	Value
Parameter group:	TlsSettings Arguments
Accepted values:	Customized, TLS10_2019, TLS12_2022, TLS12_2023

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

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

Property	Value
Parameter group:	Resource Id Arguments

--customized-cipher-suite-set

Customized cipher suites object that will be used for Https when cipherSuiteSetType is Customized. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	TlsSettings Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--minimum-tls-version

TLS protocol version that will be used for Https.

Property	Value
Parameter group:	TlsSettings Arguments
Accepted values:	TLS10, TLS12, TLS13

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--secret

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

Property	Value
Parameter group:	Secret Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az afd custom-domain update (cdn extension)

Update a new domain within the specified profile.

az afd custom-domain update [--acquire-policy-token]
                            [--add]
                            [--azure-dns-zone]
                            [--certificate-type {AzureFirstPartyManagedCertificate, CustomerCertificate, ManagedCertificate}]
                            [--change-reference]
                            [--cipher-suite-set-type {Customized, TLS10_2019, TLS12_2022, TLS12_2023}]
                            [--custom-domain-name --name]
                            [--customized-cipher-suite-set]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--ids]
                            [--minimum-tls-version {TLS10, TLS12, TLS13}]
                            [--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

Property	Value
Parameter group:	Generic Update Arguments

--azure-dns-zone

ID of the Azure DNS zone.

Property	Value
Parameter group:	AzureDnsZone Arguments

--certificate-type

Defines the source of the SSL certificate.

Property	Value
Parameter group:	TlsSettings Arguments
Accepted values:	AzureFirstPartyManagedCertificate, CustomerCertificate, ManagedCertificate

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cipher-suite-set-type

Cipher suite set type that will be used for Https.

Property	Value
Parameter group:	TlsSettings Arguments
Accepted values:	Customized, TLS10_2019, TLS12_2022, TLS12_2023

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

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

Property	Value
Parameter group:	Resource Id Arguments

--customized-cipher-suite-set

Customized cipher suites object that will be used for Https when cipherSuiteSetType is Customized. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	TlsSettings Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--minimum-tls-version

TLS protocol version that will be used for Https.

Property	Value
Parameter group:	TlsSettings Arguments
Accepted values:	TLS10, TLS12, TLS13

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--secret

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

Property	Value
Parameter group:	Secret Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az afd custom-domain wait

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

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

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

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

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

Property	Value
Parameter group:	Resource Id 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

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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az afd custom-domain wait (cdn extension)

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

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

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

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

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

Property	Value
Parameter group:	Resource Id 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

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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False