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

az spring-cloud gateway

注意

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

此命令组处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

此命令组已隐式弃用，因为命令组“spring-cloud”已弃用，将在将来的版本中删除。 请改用“spring”。

（仅限企业层）用于管理 Azure Spring Cloud 中的网关的命令。

命令

名称	说明	类型	状态
az spring-cloud gateway clear	清除网关的所有设置。	分机	预览和弃用
az spring-cloud gateway custom-domain	用于管理网关自定义域的命令。	分机	预览和弃用
az spring-cloud gateway custom-domain bind	将自定义域与网关绑定。	分机	预览和弃用
az spring-cloud gateway custom-domain list	列出网关的所有自定义域。	扩展	预览和弃用
az spring-cloud gateway custom-domain show	显示自定义域的详细信息。	分机	预览和弃用
az spring-cloud gateway custom-domain unbind	取消绑定网关的自定义域。	分机	预览和弃用
az spring-cloud gateway custom-domain update	更新网关的自定义域。	扩展	预览和弃用
az spring-cloud gateway route-config	用于在 Azure Spring Cloud 中管理网关路由配置的命令。	分机	预览和弃用
az spring-cloud gateway route-config create	使用 Json 数组格式的路由规则创建网关路由配置。	扩展	预览和弃用
az spring-cloud gateway route-config list	列出所有现有网关路由配置。	扩展	预览和弃用
az spring-cloud gateway route-config remove	删除现有的网关路由配置。	分机	预览和弃用
az spring-cloud gateway route-config show	获取现有的网关路由配置。	扩展	预览和弃用
az spring-cloud gateway route-config update	使用 Json 数组格式的路由规则更新现有网关路由配置。	扩展	预览和弃用
az spring-cloud gateway show	显示网关的设置、预配状态和运行时状态。	分机	预览和弃用
az spring-cloud gateway update	更新现有网关属性。	扩展	预览和弃用

az spring-cloud gateway clear

预览 已放弃

命令组“spring-cloud gateway”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

此命令已隐式弃用，因为命令组“spring-cloud gateway”已弃用，将在将来的版本中删除。 请改用“spring gateway”。

清除网关的所有设置。

az spring-cloud gateway clear --resource-group
                              --service
                              [--no-wait]

必需参数

--resource-group -g

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

--service -s

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

可选参数

--no-wait

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

默认值: 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-cloud gateway show

预览 已放弃

命令组“spring-cloud gateway”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

此命令已隐式弃用，因为命令组“spring-cloud gateway”已弃用，将在将来的版本中删除。 请改用“spring gateway”。

显示网关的设置、预配状态和运行时状态。

az spring-cloud gateway show --resource-group
                             --service

必需参数

--resource-group -g

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

--service -s

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

全局参数

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

预览 已放弃

命令组“spring-cloud gateway”处于预览状态，正在开发中。 参考和支持级别： https://aka.ms/CLI_refstatus

此命令已隐式弃用，因为命令组“spring-cloud gateway”已弃用，将在将来的版本中删除。 请改用“spring gateway”。

更新现有网关属性。

az spring-cloud gateway update --resource-group
                               --service
                               [--allow-credentials {false, true}]
                               [--allowed-headers]
                               [--allowed-methods]
                               [--allowed-origins]
                               [--api-description]
                               [--api-doc-location]
                               [--api-title]
                               [--api-version]
                               [--assign-endpoint {false, true}]
                               [--client-id]
                               [--client-secret]
                               [--cpu]
                               [--exposed-headers]
                               [--https-only {false, true}]
                               [--instance-count]
                               [--issuer-uri]
                               [--max-age]
                               [--memory]
                               [--no-wait]
                               [--scope]
                               [--server-url]

示例

更新网关属性。

az spring-cloud gateway update -s MyService -g MyResourceGroup --assign-endpoint true --https-only true

必需参数

--resource-group -g

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

--service -s

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

可选参数

--allow-credentials

跨站点请求是否支持用户凭据。

接受的值: false, true

--allowed-headers

跨站点请求中允许标头的逗号分隔列表。 特殊值 * 允许实际请求发送任何标头。

--allowed-methods

跨站点请求上允许的 HTTP 方法的逗号分隔列表。 特殊值 * 允许所有方法。

--allowed-origins

允许的源的逗号分隔列表发出跨站点请求。 特殊值 * 允许所有域。

--api-description

网关实例上可用的 API 的详细说明。

--api-doc-location

网关实例上提供的 API 的其他文档的位置。

--api-title

描述网关实例上可用的 API 的上下文的标题。

--api-version

此网关实例上可用的 API 版本。

--assign-endpoint

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

接受的值: false, true

--client-id

应用程序的公共标识符。

--client-secret

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

--cpu

CPU 资源数量。 应为 500m 或 CPU 核心数。

--exposed-headers

要针对跨站点请求公开的 HTTP 响应标头的逗号分隔列表。

--https-only

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

接受的值: false, true

--instance-count

实例数。

--issuer-uri

颁发者标识符的 URI。

--max-age

客户端可以缓存来自预检请求的响应的时间（秒）。

--memory

内存资源数量。 应为 512Mi 或 #Gi，例如 1Gi、3Gi。

--no-wait

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

默认值: False

--scope

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

--server-url

API 使用者将用于访问网关实例上的 API 的基本 URL。

全局参数

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