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

az spring api-portal custom-domain

注意

此参考是 Azure CLI（版本 2.56.0 或更高版本）的 spring 扩展的一部分。 该扩展将在首次运行 az spring api-portal custom-domain 命令时自动安装。 详细了解扩展。

用于管理 API 门户自定义域的命令。

命令

名称	说明	类型	状态
az spring api-portal custom-domain bind	使用 API 门户绑定自定义域。	扩展	GA
az spring api-portal custom-domain list	列出 API 门户的所有自定义域。	扩展	GA
az spring api-portal custom-domain show	显示自定义域的详细信息。	扩展	GA
az spring api-portal custom-domain unbind	取消绑定 API 门户的自定义域。	扩展	GA
az spring api-portal custom-domain update	更新 API 门户的自定义域。	扩展	GA

az spring api-portal custom-domain bind

使用 API 门户绑定自定义域。

az spring api-portal custom-domain bind --domain-name
                                        --resource-group
                                        --service
                                        [--certificate]

示例

将自定义域绑定到 API 门户。

az spring api-portal custom-domain bind --domain-name MyDomainName --certificate MyCertName --service MyCluster --resource-group MyResourceGroup

必需参数

--domain-name

自定义域的名称。

--resource-group -g

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

--service -s

Azure Spring Apps 实例的名称，可以使用 az configure --defaults spring=配置默认服务。

可选参数

--certificate

Azure Spring Apps 中的证书名称。

全局参数

--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 spring api-portal custom-domain list

列出 API 门户的所有自定义域。

az spring api-portal custom-domain list --resource-group
                                        --service

示例

列出 API 门户的所有自定义域。

az spring api-portal custom-domain list --service MyCluster --resource-group MyResourceGroup

必需参数

--resource-group -g

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

--service -s

Azure Spring Apps 实例的名称，可以使用 az configure --defaults spring=配置默认服务。

全局参数

--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 spring api-portal custom-domain show

显示自定义域的详细信息。

az spring api-portal custom-domain show --domain-name
                                        --resource-group
                                        --service

必需参数

--domain-name

自定义域的名称。

--resource-group -g

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

--service -s

Azure Spring Apps 实例的名称，可以使用 az configure --defaults spring=配置默认服务。

全局参数

--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 spring api-portal custom-domain unbind

取消绑定 API 门户的自定义域。

az spring api-portal custom-domain unbind --domain-name
                                          --resource-group
                                          --service

必需参数

--domain-name

自定义域的名称。

--resource-group -g

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

--service -s

Azure Spring Apps 实例的名称，可以使用 az configure --defaults spring=配置默认服务。

全局参数

--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 spring api-portal custom-domain update

更新 API 门户的自定义域。

az spring api-portal custom-domain update --domain-name
                                          --resource-group
                                          --service
                                          [--certificate]

示例

使用指定的证书绑定自定义域。

az spring api-portal custom-domain update --domain-name MyDomainName --certificate MCertName --service MyCluster --resource-group MyResourceGroup

必需参数

--domain-name

自定义域的名称。

--resource-group -g

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

--service -s

Azure Spring Apps 实例的名称，可以使用 az configure --defaults spring=配置默认服务。

可选参数

--certificate

Azure Spring Apps 中的证书名称。

全局参数

--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 获取完整的调试日志。