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

az spring gateway

注意

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

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

命令

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

az spring gateway clear

清除网关的所有设置。

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

必需参数

--resource-group -g

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

--service -s

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

可选参数

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

创建 Spring Cloud Gateway。

az spring gateway create --resource-group
                         --service
                         [--instance-count]

示例

创建 Spring Cloud Gateway。

az spring gateway create -s MyService -g MyResourceGroup --instance-count 2

必需参数

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

删除 Spring Cloud Gateway。

az spring gateway 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 gateway restart

重启 Spring Cloud 网关。

az spring gateway restart --resource-group
                          --service
                          [--no-wait]
                          [--yes]

示例

重启 Spring Cloud 网关。

az spring gateway restart -s MyService -g MyResourceGroup

必需参数

--resource-group -g

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

--service -s

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

可选参数

--no-wait

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

默认值: False

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

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

az spring gateway 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 gateway sync-cert

同步网关证书。

az spring gateway sync-cert --resource-group
                            --service
                            [--no-wait]
                            [--yes]

示例

同步网关证书。

az spring gateway sync-cert -s MyService -g MyResourceGroup

必需参数

--resource-group -g

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

--service -s

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

可选参数

--no-wait

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

默认值: False

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

更新现有网关属性。

az spring gateway update --resource-group
                         --service
                         [--addon-configs-file]
                         [--addon-configs-json]
                         [--allow-credentials {false, true}]
                         [--allow-origin-patterns]
                         [--allowed-headers]
                         [--allowed-methods]
                         [--allowed-origins]
                         [--api-description]
                         [--api-doc-location]
                         [--api-title]
                         [--api-version]
                         [--apm-types]
                         [--apms]
                         [--assign-endpoint {false, true}]
                         [--certificate-names]
                         [--client-id]
                         [--client-secret]
                         [--cpu]
                         [--enable-cert-verify {false, true}]
                         [--enable-response-cache {false, true}]
                         [--exposed-headers]
                         [--https-only {false, true}]
                         [--instance-count]
                         [--issuer-uri]
                         [--max-age]
                         [--memory]
                         [--no-wait]
                         [--properties]
                         [--response-cache-scope]
                         [--response-cache-size]
                         [--response-cache-ttl]
                         [--scope]
                         [--secrets]
                         [--server-url]

示例

更新网关属性。

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

在路由级别启用和配置响应缓存，并将 ttl 设置为 5 分钟。

az spring gateway update -s MyService -g MyResourceGroup --enable-response-cache --response-cache-scope Route --response-cache-ttl 5m

启用响应缓存后，将 ttl 更新为 3 分钟。

az spring gateway update -s MyService -g MyResourceGroup --response-cache-ttl 3m

禁用响应缓存。

az spring gateway update -s MyService -g MyResourceGroup --enable-response-cache false

必需参数

--resource-group -g

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

--service -s

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

可选参数

--addon-configs-file

加载项配置的 JSON 字符串的文件路径。

--addon-configs-json

加载项配置的 JSON 字符串。

--allow-credentials

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

接受的值: false, true

--allow-origin-patterns --allowed-origin-patterns

允许的源模式的逗号分隔列表发出跨站点请求。

--allowed-headers

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

--allowed-methods

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

--allowed-origins

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

--api-description

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

--api-doc-location

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

--api-title

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

--api-version

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

--apm-types

与网关集成的 APM 的空间分隔列表。 允许的值为：ApplicationInsights、AppDynamics、Dynatrace、NewRelic、ElasticAPM。

--apms

Azure Spring Apps 中用于与网关集成的 APM 引用名称的空间分隔列表。

--assign-endpoint

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

接受的值: false, true

--certificate-names

Azure Spring Apps 中证书名称的逗号分隔列表。

--client-id

应用程序的公共标识符。

--client-secret

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

--cpu

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

--enable-cert-verify --enable-certificate-verification

如果为 true，则会验证 TLS 连接中的证书（从网关到应用）。

接受的值: false, true

--enable-response-cache

在 Spring Cloud Gateway 中启用响应缓存设置。

接受的值: false, true

--exposed-headers

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

--https-only

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

接受的值: false, true

--instance-count

实例数。

--issuer-uri

颁发者标识符的 URI。

--max-age

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

--memory

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

--no-wait

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

默认值: False

--properties

环境变量的非敏感属性。 设置“key[=value]”格式，并用空格分隔。

--response-cache-scope

响应缓存的范围，可用值为 [Route， Instance]。

--response-cache-size

确定缓存是否需要逐出某些条目的缓存的最大大小。 例如 [1GB， 10MB， 100知识库(KB)]。 使用“default”重置，网关将管理此属性。

--response-cache-ttl

缓存项过期前的时间。 例如 [1h， 30m， 50s]。 使用“default”重置，网关将管理此属性。

--scope

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

--secrets

环境变量的敏感属性。 一旦放置，它将被加密，不会返回。设置“key[=value]”格式，并用空格分隔。

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