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

az spring app

注意

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

用于管理 Azure Spring Apps 中的应用的命令。

命令

名称	说明	类型	状态
az spring app append-loaded-public-certificate	将新加载的公共证书追加到 Azure Spring Apps 中的应用。	扩展	GA
az spring app append-persistent-storage	将新的持久存储追加到 Azure Spring Apps 中的应用。	扩展	GA
az spring app binding	使用 Azure Data Services 管理绑定的命令需要手动重启应用以使设置生效。	扩展	已放弃
az spring app binding cosmos	用于管理 Azure Cosmos DB 绑定的命令。	扩展	已放弃
az spring app binding cosmos add	将 Azure Cosmos DB 与应用绑定。	扩展	已放弃
az spring app binding cosmos update	更新应用的 Azure Cosmos DB 服务绑定。	扩展	已放弃
az spring app binding list	列出应用中的所有服务绑定。	扩展	已放弃
az spring app binding mysql	用于管理 Azure Database for MySQL 绑定的命令。	扩展	已放弃
az spring app binding mysql add	将 Azure Database for MySQL 与应用绑定。	扩展	已放弃
az spring app binding mysql update	更新应用的 Azure Database for MySQL 服务绑定。	扩展	已放弃
az spring app binding redis	用于管理 Azure Redis 缓存绑定的命令。	扩展	已放弃
az spring app binding redis add	将 Azure Redis 缓存与应用绑定。	扩展	已放弃
az spring app binding redis update	更新应用的 Azure Redis 缓存服务绑定。	扩展	已放弃
az spring app binding remove	删除应用的服务绑定。	扩展	已放弃
az spring app binding show	显示服务绑定的详细信息。	扩展	已放弃
az spring app connect	连接应用实例的交互式 shell 进行故障排除”。	扩展	GA
az spring app create	在 Azure Spring Apps 实例中使用默认部署创建新应用。	扩展	GA
az spring app custom-domain	用于管理自定义域的命令。	扩展	GA
az spring app custom-domain bind	将自定义域与应用绑定。	扩展	GA
az spring app custom-domain list	列出应用的所有自定义域。	扩展	GA
az spring app custom-domain show	显示自定义域的详细信息。	扩展	GA
az spring app custom-domain unbind	取消绑定应用的自定义域。	扩展	GA
az spring app custom-domain update	更新应用的自定义域。	扩展	GA
az spring app delete	删除 Azure Spring Apps 中的应用。	扩展	GA
az spring app deploy	将源代码或预生成的二进制文件部署到应用并更新相关配置。	扩展	GA
az spring app deployment	用于管理 Azure Spring Apps 中应用的部署生命周期的命令。 可以使用参数 --deployment 在应用级别上对部署执行更多操作。 例如 az spring app deploy --deployment.	扩展	GA
az spring app deployment create	为应用创建过渡部署。 若要将代码或更新设置部署到现有部署，请使用 az spring app deploy/update --deployment <staging deployment>。	扩展	GA
az spring app deployment delete	删除应用的部署。	扩展	GA
az spring app deployment generate-heap-dump	将目标应用实例的堆转储生成到给定的文件路径。	扩展	GA
az spring app deployment generate-thread-dump	将目标应用实例的线程转储生成到给定的文件路径。	扩展	GA
az spring app deployment list	列出应用中的所有部署。	扩展	GA
az spring app deployment show	显示部署的详细信息。	扩展	GA
az spring app deployment start-jfr	在目标应用实例上启动 JFR 以指定文件路径。	扩展	GA
az spring app disable-remote-debugging	禁用部署的远程调试。	扩展	GA
az spring app enable-remote-debugging	为部署启用远程调试。	扩展	GA
az spring app get-remote-debugging-config	获取部署的远程调试配置。	扩展	GA
az spring app identity	管理应用的托管标识。	扩展	GA
az spring app identity assign	启用系统分配的托管标识或将用户分配的托管标识分配给应用。	扩展	GA
az spring app identity force-set	在应用上强制设置托管标识。	扩展	GA
az spring app identity remove	从应用中删除托管标识。	扩展	GA
az spring app identity show	显示应用的托管标识信息。	扩展	GA
az spring app list	列出 Azure Spring Apps 中的所有应用。	扩展	GA
az spring app log	使用多个选项结尾应用实例日志的命令。 如果应用只有一个实例，则实例名称是可选的。	扩展	已放弃
az spring app log tail	显示应用实例的日志，设置“-f/--follow”时将流式传输日志。	扩展	已放弃
az spring app logs	显示应用实例的日志，设置“-f/--follow”时将流式传输日志。	扩展	GA
az spring app restart	重启应用的实例，默认为生产部署。	扩展	GA
az spring app scale	手动缩放应用或其部署。	扩展	GA
az spring app set-deployment	设置应用的生产部署。	扩展	GA
az spring app show	在 Azure Spring Apps 中显示应用的详细信息。	扩展	GA
az spring app show-deploy-log	显示上次部署的生成日志，仅适用于源代码部署，默认为生产部署。	扩展	GA
az spring app start	启动应用的实例，默认为生产部署。	扩展	GA
az spring app stop	停止应用的实例，默认为生产部署。	扩展	GA
az spring app unset-deployment	取消设置应用的生产部署。	扩展	GA
az spring app update	更新应用的配置。	扩展	GA

az spring app append-loaded-public-certificate

将新加载的公共证书追加到 Azure Spring Apps 中的应用。

az spring app append-loaded-public-certificate --certificate-name
                                               --load-trust-store {false, true}
                                               --name
                                               --resource-group
                                               --service

示例

将新加载的公共证书追加到应用。

az spring app append-loaded-public-certificate --name MyApp --service MyCluster --resource-group MyResourceGroup --certificate-name MyCertName --load-trust-store true

必需参数

--certificate-name

要追加的证书的名称。

--load-trust-store

如果为 true，则会将证书加载到 Java 应用程序的信任存储中。

接受的值: false, true

默认值: False

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--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 app append-persistent-storage

将新的持久存储追加到 Azure Spring Apps 中的应用。

az spring app append-persistent-storage --mount-path
                                        --name
                                        --persistent-storage-type
                                        --resource-group
                                        --service
                                        --storage-name
                                        [--enable-sub-path {false, true}]
                                        [--mount-options]
                                        [--read-only {false, true}]
                                        [--share-name]

示例

将新的持久存储追加到应用。

az spring app append-persistent-storage --persistent-storage-type AzureFileVolume --share-name MyShareName --mount-path /MyMountPath --storage-name MyStorageName -n MyApp -g MyResourceGroup -s MyService

必需参数

--mount-path

要装载的永久性存储卷的路径。

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--persistent-storage-type -t

永久性存储卷的类型。

--resource-group -g

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

--service -s

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

--storage-name

在 Azure Spring Apps 中创建的存储资源的名称。

可选参数

--enable-sub-path

[可选]如果为 true，则会在每个应用实例具有相同路径的单独子目录中装载。

接受的值: false, true

默认值: False

--mount-options

[可选]永久性存储卷的装载选项。

--read-only

[可选]如果为 true，则永久性存储卷将为只读。

接受的值: false, true

默认值: False

--share-name

预先创建的文件共享的名称。 仅当永久性存储卷的类型为 AzureFileVolume 时，才应提供 ShareName。

全局参数

--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 app connect

连接应用实例的交互式 shell 进行故障排除”。

az spring app connect --name
                      --resource-group
                      --service
                      [--deployment]
                      [--instance]
                      [--shell-cmd]

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--resource-group -g

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

--service -s

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

可选参数

--deployment -d

应用的现有部署的名称。 如果未指定，则默认为生产部署。

--instance -i

部署的现有实例的名称。

--shell-cmd

连接到应用实例时要运行的 shell 命令。

默认值: /bin/sh

全局参数

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

在 Azure Spring Apps 实例中使用默认部署创建新应用。

az spring app create --name
                     --resource-group
                     --service
                     [--assign-endpoint {false, true}]
                     [--assign-public-endpoint {false, true}]
                     [--backend-protocol {Default, GRPC}]
                     [--bind-acs]
                     [--bind-service-registry]
                     [--client-auth-certs]
                     [--cpu]
                     [--deployment-name]
                     [--disable-probe {false, true}]
                     [--enable-liveness-probe {false, true}]
                     [--enable-persistent-storage {false, true}]
                     [--enable-readiness-probe {false, true}]
                     [--enable-startup-probe {false, true}]
                     [--env]
                     [--grace-period]
                     [--ingress-read-timeout]
                     [--ingress-send-timeout]
                     [--instance-count]
                     [--jvm-options]
                     [--liveness-probe-config]
                     [--loaded-public-certificate-file]
                     [--max-replicas]
                     [--memory]
                     [--min-replicas]
                     [--persistent-storage]
                     [--readiness-probe-config]
                     [--runtime-version {Java_11, Java_17, Java_21, Java_8, NetCore_31}]
                     [--scale-rule-auth]
                     [--scale-rule-http-concurrency]
                     [--scale-rule-metadata]
                     [--scale-rule-name]
                     [--scale-rule-type]
                     [--secrets]
                     [--session-affinity {Cookie, None}]
                     [--session-max-age]
                     [--startup-probe-config]
                     [--system-assigned {false, true}]
                     [--user-assigned]
                     [--workload-profile]

示例

使用默认配置创建应用。

az spring app create -n MyApp -s MyCluster -g MyResourceGroup

创建具有 3 个实例和 2 个 CPU 核心和 3 GB 内存（每个实例）的公共可访问应用。

az spring app create -n MyApp -s MyCluster -g MyResourceGroup --assign-endpoint true --cpu 2 --memory 3 --instance-count 3

创建到默认服务注册表和应用程序配置服务的应用绑定。

az spring app create -n MyApp -s MyCluster -g MyResourceGroup --bind-service-registry --bind-application-configuration-service

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--resource-group -g

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

--service -s

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

可选参数

--assign-endpoint

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

接受的值: false, true

默认值: False

--assign-public-endpoint

如果为 true，请分配可从虚拟网络中访问的 vnet 注入实例应用的终结点 URL。

接受的值: false, true

--backend-protocol

应用的入口后端协议。 默认值表示 HTTP/HTTPS/WebSocket。

接受的值: Default, GRPC

--bind-acs --bind-application-configuration-service

自动将应用绑定到默认的应用程序配置服务。

--bind-service-registry --bind-sr

自动将应用绑定到默认服务注册表。

--client-auth-certs

一个空格分隔的字符串，其中包含用于客户端身份验证的证书的资源 ID。 例如：--client_auth_certs='id0 id1'。 使用“”清除现有证书。

--cpu

CPU 资源数量。 应为 250m、500m、750m、12.50 米或 CPU 内核数。

--deployment-name

默认部署的名称。

默认值: default

--disable-probe

如果为 true，请禁用实时性和就绪情况探测。

接受的值: false, true

--enable-liveness-probe

预览

如果为 false，将禁用应用实例的运行情况探测。

接受的值: false, true

--enable-persistent-storage --enable-ps

如果为 true，请使用默认路径装载 50G（标准定价层）或 1G（基本定价层）磁盘。

接受的值: false, true

--enable-readiness-probe

预览

如果为 false，将禁用应用实例的就绪情况探测。

接受的值: false, true

--enable-startup-probe

预览

如果为 false，将禁用应用实例的启动探测。

接受的值: false, true

--env

以“key[=value]”格式分隔的空间分隔环境变量。

--grace-period --termination-grace-period-seconds

预览

应用实例需要正常终止的可选持续时间（以秒为单位）。

--ingress-read-timeout

入口读取超时值（以秒为单位）。 默认值 300，最小值为 1，最大值为 1800。

--ingress-send-timeout

入口发送超时值（以秒为单位）。 默认值 60，最小值为 1，最大值为 1800。

--instance-count

实例数。

默认值: 1

--jvm-options

包含 jvm 选项的字符串，请对此参数使用“=”而不是“'”以避免 bash 分析错误，例如：--jvm-options='-Xms1024m -Xmx2048m'。

--liveness-probe-config

预览

json 文件路径指示实时探测配置。

--loaded-public-certificate-file -f

json 文件路径指示将加载到应用的证书。

--max-replicas

最大副本 (replica)数。

默认值: 10

--memory

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

--min-replicas

最小副本 (replica)数。

默认值: 1

--persistent-storage

要装载到应用的永久性存储的 json 文件路径。

--readiness-probe-config

预览

json 文件路径指示就绪情况探测配置。

--runtime-version

已用语言的运行时版本。

接受的值: Java_11, Java_17, Java_21, Java_8, NetCore_31

--scale-rule-auth --sra

缩放规则身份验证参数。 设置“=”格式，并用空格分隔。

--scale-rule-http-concurrency --scale-rule-tcp-concurrency --srhc --srtc

横向扩展前的最大并发请求数。仅支持 http 和 tcp 缩放规则。

--scale-rule-metadata --srm

缩放规则元数据。 设置“key[=value]”格式，并用空格分隔。

--scale-rule-name --srn

缩放规则的名称。

--scale-rule-type --srt

缩放规则的类型。 默认值：http。

--secrets

应用的机密列表。 设置“key[=value]”格式，并用空格分隔。

--session-affinity

应用的入口会话相关性。

接受的值: Cookie, None

--session-max-age

Cookie 过期之前的时间。 最小值为 1 秒，最大值为 7 天。 如果设置为 0，则到期期限等于浏览器会话周期。

--startup-probe-config

预览

json 文件路径指示启动探测配置。

--system-assigned

启用系统分配的托管标识。

接受的值: false, true

--user-assigned

预览

将空间分隔的用户分配的托管标识资源 ID 分配给应用。

--workload-profile

托管环境中使用的工作负荷配置文件。 默认为“消耗”。

全局参数

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

删除 Azure Spring Apps 中的应用。

az spring app delete --name
                     --resource-group
                     --service

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--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 app deploy

将源代码或预生成的二进制文件部署到应用并更新相关配置。

az spring app deploy --name
                     --resource-group
                     --service
                     [--apms]
                     [--artifact-path]
                     [--build-certificates]
                     [--build-cpu]
                     [--build-env]
                     [--build-memory]
                     [--builder]
                     [--config-file-patterns]
                     [--container-args]
                     [--container-command]
                     [--container-image]
                     [--container-registry]
                     [--deployment]
                     [--disable-app-log]
                     [--disable-probe {false, true}]
                     [--disable-validation {false, true}]
                     [--enable-liveness-probe {false, true}]
                     [--enable-readiness-probe {false, true}]
                     [--enable-startup-probe {false, true}]
                     [--env]
                     [--grace-period]
                     [--jvm-options]
                     [--language-framework]
                     [--liveness-probe-config]
                     [--main-entry]
                     [--no-wait]
                     [--readiness-probe-config]
                     [--registry-password]
                     [--registry-username]
                     [--runtime-version {Java_11, Java_17, Java_21, Java_8, NetCore_31}]
                     [--server-version]
                     [--source-path]
                     [--startup-probe-config]
                     [--target-module]
                     [--version]

示例

将源代码部署到应用。 这将打包当前目录，使用 Pivotal 生成服务生成二进制文件，然后部署到应用。

az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --source-path

使用 jvm 选项和环境变量将预生成的 jar 部署到应用。

az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --artifact-path app.jar --jvm-options="-XX:+UseG1GC -XX:+UseStringDeduplication" --env foo=bar

使用服务器版本、jvm 选项和环境变量（仅限标准和基本层）将预建战争部署到应用。

az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --artifact-path app.war --server-version Tomcat_10 --jvm-options="-XX:+UseG1GC -XX:+UseStringDeduplication" --env foo=bar

将源代码部署到应用的特定部署。

az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup -d green-deployment --source-path

将 Docker Hub 上的容器映像部署到应用。

az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --container-image contoso/your-app:v1

将专用注册表上的容器映像部署到应用。

az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --container-image contoso/your-app:v1 --container-registry myacr.azurecr.io --registry-username <username> --registry-password <password>

使用应用程序配置服务配置文件模式部署到应用。

az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --config-file-patterns MyPatterns --artifact-path app.jar

将预生成的 jar 部署到具有生成 env 的应用（仅适用于企业层）。

az spring app deploy -n MyApp -s MyCluster -g MyResourceGroup --artifact-path app.jar --build-env BP_JVM_VERSION=11.*

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--resource-group -g

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

--service -s

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

可选参数

--apms

（仅限企业层）空格分隔的 APM 名称。

--artifact-path

部署指定的预生成项目（jar、war 或 netcore zip，war 为公共预览版）。

--build-certificates

（仅限企业层）空间分隔的证书名称，证书在生成期间使用。

--build-cpu

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

默认值: 1

--build-env

以“key[=value]”格式分隔的空间分隔环境变量。

--build-memory

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

默认值: 2Gi

--builder

（仅限企业层）用于生成可执行文件的生成服务生成器。

默认值: default

--config-file-patterns

（仅限企业层）使用“”分隔的配置文件模式，以确定将使用哪个应用程序配置服务的模式。 使用“”“清除现有配置。

--container-args

容器映像的参数。

--container-command

容器映像的命令。

--container-image

容器映像标记。

--container-registry

容器映像的注册表。

默认值: docker.io

--deployment -d

应用的现有部署的名称。 如果未指定，则默认为生产部署。

--disable-app-log

部署应用程序时不要打印应用程序日志。

默认值: False

--disable-probe

如果为 true，请禁用实时性和就绪情况探测。

接受的值: false, true

--disable-validation

如果为 true，请禁用 jar 验证。

接受的值: false, true

--enable-liveness-probe

预览

如果为 false，将禁用应用实例的运行情况探测。

接受的值: false, true

--enable-readiness-probe

预览

如果为 false，将禁用应用实例的就绪情况探测。

接受的值: false, true

--enable-startup-probe

预览

如果为 false，将禁用应用实例的启动探测。

接受的值: false, true

--env

以“key[=value]”格式分隔的空间分隔环境变量。

--grace-period --termination-grace-period-seconds

预览

应用实例需要正常终止的可选持续时间（以秒为单位）。

--jvm-options

包含 jvm 选项的字符串，请对此参数使用“=”而不是“'”以避免 bash 分析错误，例如：--jvm-options='-Xms1024m -Xmx2048m'。

--language-framework

上传的容器映像的语言框架。 支持的值：“springboot”、“”。

--liveness-probe-config

预览

json 文件路径指示实时探测配置。

--main-entry -m

一个字符串，包含相对于 zip 根的 .NET 可执行文件的路径。

--no-wait

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

默认值: False

--readiness-probe-config

预览

json 文件路径指示就绪情况探测配置。

--registry-password

容器注册表的密码。

--registry-username

容器注册表的用户名。

--runtime-version

已用语言的运行时版本。

接受的值: Java_11, Java_17, Java_21, Java_8, NetCore_31

--server-version

（仅限标准和基本层）Tomcat 服务器版本。 通过运行 az spring list-support-server-versions -o table列出所有受支持的服务器版本。 此功能目前以公共预览版提供。

--source-path

部署指定的源文件夹。 该文件夹将打包到 tar 中，上传并使用 kpack 生成。 如果未提供任何值，则默认为当前文件夹。

--startup-probe-config

预览

json 文件路径指示启动探测配置。

--target-module

要部署的子模块，需要从源代码生成的多个 jar 包。

--version

部署版本，如果未设置，则保持不变。

全局参数

--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 app disable-remote-debugging

禁用部署的远程调试。

az spring app disable-remote-debugging --name
                                       --resource-group
                                       --service
                                       [--deployment]
                                       [--no-wait]

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--resource-group -g

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

--service -s

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

可选参数

--deployment -d

应用的现有部署的名称。 如果未指定，则默认为生产部署。

--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 app enable-remote-debugging

为部署启用远程调试。

az spring app enable-remote-debugging --name
                                      --resource-group
                                      --service
                                      [--deployment]
                                      [--no-wait]
                                      [--port]

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--resource-group -g

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

--service -s

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

可选参数

--deployment -d

应用的现有部署的名称。 如果未指定，则默认为生产部署。

--no-wait

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

默认值: False

--port -p

远程调试端口，该值应从 1024 到 65536，默认值为 5005。

默认值: 5005

全局参数

--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 app get-remote-debugging-config

获取部署的远程调试配置。

az spring app get-remote-debugging-config --name
                                          --resource-group
                                          --service
                                          [--deployment]

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--resource-group -g

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

--service -s

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

可选参数

--deployment -d

应用的现有部署的名称。 如果未指定，则默认为生产部署。

全局参数

--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 app list

列出 Azure Spring Apps 中的所有应用。

az spring app list --resource-group
                   --service

示例

所有应用的持久存储的查询状态

az spring app list -s MyCluster -g MyResourceGroup -o json --query '[].{Name:name, PersistentStorage:properties.persistentDisk}'

必需参数

--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 app logs

显示应用实例的日志，设置“-f/--follow”时将流式传输日志。

az spring app logs --name
                   --resource-group
                   --service
                   [--deployment]
                   [--follow]
                   [--format-json]
                   [--instance]
                   [--limit]
                   [--lines]
                   [--since]

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--resource-group -g

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

--service -s

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

可选参数

--deployment -d

应用的现有部署的名称。 如果未指定，则默认为生产部署。

--follow -f

指定是否应流式传输日志。

默认值: False

--format-json

如果启用了结构化日志，则设置 JSON 日志的格式。

--instance -i

部署的现有实例的名称。

--limit

要返回的最大日志字节数。 上限编号为 2048。

默认值: 2048

--lines

要显示的行数。 最大值为 10000。

默认值: 50

--since

仅返回比相对持续时间（如 5s、2m 或 1h）的日志。 最大值为 1 小时。

全局参数

--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 app restart

重启应用的实例，默认为生产部署。

az spring app restart --name
                      --resource-group
                      --service
                      [--deployment]
                      [--no-wait]

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--resource-group -g

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

--service -s

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

可选参数

--deployment -d

应用的现有部署的名称。 如果未指定，则默认为生产部署。

--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 app scale

手动缩放应用或其部署。

az spring app scale --name
                    --resource-group
                    --service
                    [--cpu]
                    [--deployment]
                    [--instance-count]
                    [--max-replicas]
                    [--memory]
                    [--min-replicas]
                    [--no-wait]
                    [--scale-rule-auth]
                    [--scale-rule-http-concurrency]
                    [--scale-rule-metadata]
                    [--scale-rule-name]
                    [--scale-rule-type]

示例

将应用纵向扩展到 4 个 CPU 核心和每个实例的 8 Gb 内存。

az spring app scale -n MyApp -s MyCluster -g MyResourceGroup --cpu 3 --memory 8

将应用的部署横向扩展到 5 个实例。

az spring app scale -n MyApp -s MyCluster -g MyResourceGroup -d green-deployment --instance-count 5

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--resource-group -g

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

--service -s

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

可选参数

--cpu

CPU 资源数量。 应为 250m、500m、750m、12.50 米或 CPU 内核数。

--deployment -d

应用的现有部署的名称。 如果未指定，则默认为生产部署。

--instance-count

实例数。

--max-replicas

最大副本 (replica)数。

默认值: 10

--memory

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

--min-replicas

最小副本 (replica)数。

默认值: 1

--no-wait

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

默认值: False

--scale-rule-auth --sra

缩放规则身份验证参数。 设置“=”格式，并用空格分隔。

--scale-rule-http-concurrency --scale-rule-tcp-concurrency --srhc --srtc

横向扩展前的最大并发请求数。仅支持 http 和 tcp 缩放规则。

--scale-rule-metadata --srm

缩放规则元数据。 设置“key[=value]”格式，并用空格分隔。

--scale-rule-name --srn

缩放规则的名称。

--scale-rule-type --srt

缩放规则的类型。 默认值：http。

全局参数

--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 app set-deployment

设置应用的生产部署。

az spring app set-deployment --deployment
                             --name
                             --resource-group
                             --service
                             [--no-wait]

示例

将应用的过渡部署交换到生产环境。

az spring app set-deployment -d green-deployment -n MyApp -s MyCluster -g MyResourceGroup

必需参数

--deployment -d

应用的现有部署的名称。

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

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

在 Azure Spring Apps 中显示应用的详细信息。

az spring app show --name
                   --resource-group
                   --service

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--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 app show-deploy-log

显示上次部署的生成日志，仅适用于源代码部署，默认为生产部署。

az spring app show-deploy-log --name
                              --resource-group
                              --service
                              [--deployment]

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--resource-group -g

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

--service -s

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

可选参数

--deployment -d

应用的现有部署的名称。 如果未指定，则默认为生产部署。

全局参数

--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 app start

启动应用的实例，默认为生产部署。

az spring app start --name
                    --resource-group
                    --service
                    [--deployment]
                    [--no-wait]

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--resource-group -g

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

--service -s

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

可选参数

--deployment -d

应用的现有部署的名称。 如果未指定，则默认为生产部署。

--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 app stop

停止应用的实例，默认为生产部署。

az spring app stop --name
                   --resource-group
                   --service
                   [--deployment]
                   [--no-wait]

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--resource-group -g

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

--service -s

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

可选参数

--deployment -d

应用的现有部署的名称。 如果未指定，则默认为生产部署。

--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 app unset-deployment

取消设置应用的生产部署。

az spring app unset-deployment --name
                               --resource-group
                               --service
                               [--no-wait]

示例

如果应用具有生产部署，将应用的生产部署交换到过渡。

az spring app unset-deployment -n MyApp -s MyCluster -g MyResourceGroup

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

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

更新应用的配置。

az spring app update --name
                     --resource-group
                     --service
                     [--assign-endpoint {false, true}]
                     [--assign-public-endpoint {false, true}]
                     [--backend-protocol {Default, GRPC}]
                     [--client-auth-certs]
                     [--config-file-patterns]
                     [--deployment]
                     [--disable-probe {false, true}]
                     [--enable-ingress-to-app-tls {false, true}]
                     [--enable-liveness-probe {false, true}]
                     [--enable-persistent-storage {false, true}]
                     [--enable-readiness-probe {false, true}]
                     [--enable-startup-probe {false, true}]
                     [--env]
                     [--grace-period]
                     [--https-only {false, true}]
                     [--ingress-read-timeout]
                     [--ingress-send-timeout]
                     [--jvm-options]
                     [--liveness-probe-config]
                     [--loaded-public-certificate-file]
                     [--main-entry]
                     [--no-wait]
                     [--persistent-storage]
                     [--readiness-probe-config]
                     [--runtime-version {Java_11, Java_17, Java_21, Java_8, NetCore_31}]
                     [--secrets]
                     [--session-affinity {Cookie, None}]
                     [--session-max-age]
                     [--startup-probe-config]
                     [--workload-profile]

示例

为应用添加环境变量。

az spring app update -n MyApp -s MyCluster -g MyResourceGroup --env foo=bar

必需参数

--name -n

在指定的 Azure Spring Apps 实例中运行的应用的名称。

--resource-group -g

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

--service -s

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

可选参数

--assign-endpoint

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

接受的值: false, true

--assign-public-endpoint

如果为 true，请分配可从虚拟网络中访问的 vnet 注入实例应用的终结点 URL。

接受的值: false, true

--backend-protocol

应用的入口后端协议。 默认值表示 HTTP/HTTPS/WebSocket。

接受的值: Default, GRPC

--client-auth-certs

一个空格分隔的字符串，其中包含用于客户端身份验证的证书的资源 ID。 例如：--client_auth_certs='id0 id1'。 使用“”清除现有证书。

--config-file-patterns

（仅限企业层）使用“”分隔的配置文件模式，以确定将使用哪个应用程序配置服务的模式。 使用“”“清除现有配置。

--deployment -d

应用的现有部署的名称。 如果未指定，则默认为生产部署。

--disable-probe

如果为 true，请禁用实时性和就绪情况探测。

接受的值: false, true

--enable-ingress-to-app-tls

如果为 true，则启用应用 tls 的入口。

接受的值: false, true

--enable-liveness-probe

预览

如果为 false，将禁用应用实例的运行情况探测。

接受的值: false, true

--enable-persistent-storage --enable-ps

如果为 true，请使用默认路径装载 50G（标准定价层）或 1G（基本定价层）磁盘。

接受的值: false, true

--enable-readiness-probe

预览

如果为 false，将禁用应用实例的就绪情况探测。

接受的值: false, true

--enable-startup-probe

预览

如果为 false，将禁用应用实例的启动探测。

接受的值: false, true

--env

以“key[=value]”格式分隔的空间分隔环境变量。

--grace-period --termination-grace-period-seconds

预览

应用实例需要正常终止的可选持续时间（以秒为单位）。

--https-only

如果为 true，则通过 https 访问应用。

接受的值: false, true

--ingress-read-timeout

入口读取超时值（以秒为单位）。 默认值 300，最小值为 1，最大值为 1800。

--ingress-send-timeout

入口发送超时值（以秒为单位）。 默认值 60，最小值为 1，最大值为 1800。

--jvm-options

包含 jvm 选项的字符串，请对此参数使用“=”而不是“'”以避免 bash 分析错误，例如：--jvm-options='-Xms1024m -Xmx2048m'。

--liveness-probe-config

预览

json 文件路径指示实时探测配置。

--loaded-public-certificate-file -f

json 文件路径指示将加载到应用的证书。

--main-entry -m

相对于 zip 根目录的 .NET 可执行文件的路径。

--no-wait

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

默认值: False

--persistent-storage

要装载到应用的永久性存储的 json 文件路径。

--readiness-probe-config

预览

json 文件路径指示就绪情况探测配置。

--runtime-version

已用语言的运行时版本。

接受的值: Java_11, Java_17, Java_21, Java_8, NetCore_31

--secrets

应用的机密列表。 设置“key[=value]”格式，并用空格分隔。

--session-affinity

应用的入口会话相关性。

接受的值: Cookie, None

--session-max-age

Cookie 过期之前的时间。 最小值为 1 秒，最大值为 7 天。 如果设置为 0，则到期期限等于浏览器会话周期。

--startup-probe-config

预览

json 文件路径指示启动探测配置。

--workload-profile

托管环境中使用的工作负荷配置文件。 默认为“消耗”。

全局参数

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