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

az spring api-portal

  • 参考

注意

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

（仅限企业层）用于在 Azure Spring Apps 中管理 API 门户的命令。

命令

名称 说明 类型 状态
az spring api-portal clear

清除 API 门户的所有设置。

 扩展 GA
az spring api-portal create

创建 API 门户。

 扩展 GA
az spring api-portal custom-domain

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

 扩展 GA
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 delete

删除 API 门户。

 扩展 GA
az spring api-portal show

显示 API 门户的设置、预配状态和运行时状态。

 扩展 GA
az spring api-portal update

更新现有的 API 门户属性。

 扩展 GA

az spring api-portal clear

清除 API 门户的所有设置。

az spring api-portal clear --resource-group
                           --service

必需参数

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

创建 API 门户。

az spring api-portal create --resource-group
                            --service
                            [--instance-count]

示例

创建 API 门户。

az spring api-portal create -s MyService -g MyResourceGroup --instance-count 1

必需参数

--resource-group -g

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

--service -s

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

可选参数

--instance-count

实例数。

全局参数
--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 delete

删除 API 门户。

az spring api-portal delete --resource-group
                            --service
                            [--yes]

必需参数

--resource-group -g

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

--service -s

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

可选参数

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

显示 API 门户的设置、预配状态和运行时状态。

az spring api-portal show --resource-group
                          --service

必需参数

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

更新现有的 API 门户属性。

az spring api-portal update --resource-group
                            --service
                            [--assign-endpoint {false, true}]
                            [--client-id]
                            [--client-secret]
                            [--enable-api-try-out {false, true}]
                            [--https-only {false, true}]
                            [--instance-count]
                            [--issuer-uri]
                            [--scope]

示例

更新 API 门户属性。

az spring api-portal update -s MyService -g MyResourceGroup --assign-endpoint true --https-only true

必需参数

--resource-group -g

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

--service -s

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

可选参数

--assign-endpoint

如果为 true，请分配用于直接访问的终结点 URL。

接受的值: false, true
--client-id

应用程序的公共标识符。

--client-secret

只有应用程序和授权服务器知道的机密。

--enable-api-try-out

通过发送请求并在 API 门户中查看响应来试用 API。

接受的值: false, true
--https-only

如果为 true，则通过 https 访问终结点。

接受的值: false, true
--instance-count

实例数。

--issuer-uri

颁发者标识符的 URI。

--scope

允许以逗号分隔的特定操作列表应用程序代表用户执行操作。

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