你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

az afd custom-domain

管理指定配置文件中的自定义域。

命令

名称 说明 类型 状态
az afd custom-domain create

在指定的配置文件中创建新域。

核心 GA
az afd custom-domain delete

删除具有指定订阅、资源组和配置文件下指定域名的现有 AzureFrontDoor 域。

核心 GA
az afd custom-domain list

列出现有的 AzureFrontDoor 域。

核心 GA
az afd custom-domain regenerate-validation-token

汇报域验证令牌。

核心 GA
az afd custom-domain show

获取具有指定订阅、资源组和配置文件下指定域名的现有 AzureFrontDoor 域。

核心 GA
az afd custom-domain update

更新指定配置文件中的新域。

核心 GA
az afd custom-domain wait

将 CLI 置于等待状态,直到满足条件。

核心 GA

az afd custom-domain create

在指定的配置文件中创建新域。

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]

示例

创建使用 AFD 托管证书进行 SSL/TLS 加密的自定义域。

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

创建使用自己的证书进行 SSL/TLS 加密的自定义域,该证书存储在 Azure 密钥库中,并由 AFD 机密引用。

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

必需参数

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

全局唯一的配置文件下的域的名称。

--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称,该配置文件在资源组中是唯一的。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--azure-dns-zone

Azure DNS 区域的 ID。

--certificate-type

定义 SSL 证书的源。

接受的值: AzureFirstPartyManagedCertificate, CustomerCertificate, ManagedCertificate
--host-name

域的主机名。 必须是域名。

--minimum-tls-version

将用于 Https 的 TLS 协议版本。

接受的值: TLS10, TLS12
--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--secret

对机密的资源引用。即。subs/rg/profile/secret。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az afd custom-domain delete

删除具有指定订阅、资源组和配置文件下指定域名的现有 AzureFrontDoor 域。

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]

示例

删除自定义域。

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

可选参数

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

全局唯一的配置文件下的域的名称。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称,该配置文件在资源组中是唯一的。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--yes -y

不提示确认。

默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az afd custom-domain list

列出现有的 AzureFrontDoor 域。

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

示例

列出指定配置文件中的所有自定义域。

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

必需参数

--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称,该配置文件在资源组中是唯一的。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值,则会在命令的输出中提供令牌。 若要恢复分页,请在后续命令的参数中 --next-token 提供令牌值。

--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az afd custom-domain regenerate-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]

示例

重新生成域验证令牌。

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

可选参数

--custom-domain-name

全局唯一的配置文件下的域的名称。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称,该配置文件在资源组中是唯一的。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az afd custom-domain show

获取具有指定订阅、资源组和配置文件下指定域名的现有 AzureFrontDoor 域。

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

示例

显示指定配置文件中自定义域的详细信息。

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

可选参数

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

全局唯一的配置文件下的域的名称。

--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称,该配置文件在资源组中是唯一的。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az afd custom-domain update

更新指定配置文件中的新域。

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]

示例

更新自定义域支持的最低 TLS 版本。

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

将自定义域的证书类型更新为 AFD 托管证书。

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

可选参数

--add

通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value、string 或 JSON 字符串>。

--azure-dns-zone

Azure DNS 区域的 ID。

--certificate-type

定义 SSL 证书的源。

接受的值: AzureFirstPartyManagedCertificate, CustomerCertificate, ManagedCertificate
--custom-domain-name --name -n

全局唯一的配置文件下的域的名称。

--force-string

使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--minimum-tls-version

将用于 Https 的 TLS 协议版本。

接受的值: TLS10, TLS12
--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称,该配置文件在资源组中是唯一的。

--remove

从列表中删除属性或元素。 示例:--remove property.list OR --remove propertyToRemove。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--secret

对机密的资源引用。即。subs/rg/profile/secret。

--set

通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az afd custom-domain wait

将 CLI 置于等待状态,直到满足条件。

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

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。

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

全局唯一的配置文件下的域的名称。

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--ids

一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

--interval

轮询间隔(以秒为单位)。

默认值: 30
--profile-name

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称,该配置文件在资源组中是唯一的。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--timeout

最大等待(以秒为单位)。

默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。