az spring app

Note

このリファレンスは、Azure CLI (バージョン 2.56.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 Cache for Redis バインドを管理するコマンド。	拡張子	"非推奨"
az spring app binding redis add	Azure Cache for Redis とアプリをバインドします。	拡張子	"非推奨"
az spring app binding redis update	アプリの Azure Cache for Redis サービス バインドを更新します。	拡張子	"非推奨"
az spring app binding remove	アプリのサービス バインドを削除します。	拡張子	"非推奨"
az spring app binding show	サービス バインドの詳細を表示します。	拡張子	"非推奨"
az spring app connect	トラブルシューティングのためにアプリ インスタンスの対話型シェルに接続します。	拡張子	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	アプリのマネージド ID を管理します。	拡張子	GA
az spring app identity assign	システム割り当てマネージド ID を有効にするか、ユーザー割り当てマネージド ID をアプリに割り当てます。	拡張子	GA
az spring app identity force-set	アプリでマネージド ID を強制的に設定します。	拡張子	GA
az spring app identity remove	アプリからマネージド ID を削除します。	拡張子	GA
az spring app identity show	アプリのマネージド ID 情報を表示します。	拡張子	GA
az spring app list	Azure Spring Apps 内のすべてのアプリを一覧表示します。	拡張子	GA
az spring app log	複数のオプションを使用してアプリ インスタンスのログを末尾に記録するコマンド。 アプリにインスタンスが 1 つしかない場合、インスタンス名は省略可能です。	拡張子	"非推奨"
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

事前に作成されたファイル共有の名前。 ShareName は、永続ストレージ ボリュームの種類が AzureFileVolume の場合にのみ指定する必要があります。

グローバル パラメーター

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

トラブルシューティングのためにアプリ インスタンスの対話型シェルに接続します。

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

アプリ インスタンスに接続するときに実行するシェル コマンド。

規定値: /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-config-server]
                     [--bind-service-registry]
                     [--client-auth-certs]
                     [--cpu]
                     [--deployment-name]
                     [--disable-probe {false, true}]
                     [--disable-tea {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

既定の Service Registry、Application Configuration Service、Spring Cloud Config Server へのアプリ バインドを作成します。

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

必須のパラメーター

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

アプリを既定の Application Configuration Service に自動的にバインドします。

--bind-config-server --bind-cs

アプリを既定の構成サーバーに自動的にバインドします。

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

アプリを既定のサービス レジストリに自動的にバインドします。

--client-auth-certs

クライアント認証用の証明書のリソース ID を含むスペース区切りの文字列。 例: --client_auth_certs='id0 id1'。 既存の証明書をクリアするには、'' を使用します。

--cpu

CPU リソース量。 250m、500m、750m、1250m、または CPU コア数である必要があります。

--deployment-name

既定のデプロイの名前。

規定値: default

--disable-probe

true の場合は、liveness と readiness プローブを無効にします。

指定可能な値: false, true

--disable-tea --disable-test-endpoint-auth

true の場合は、アプリのテスト エンドポイントの認証を無効にします。

指定可能な値: false, true

規定値: False

--enable-liveness-probe

プレビュー

false の場合、アプリ インスタンスのライブネス プローブが無効になります。

指定可能な値: false, true

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

true の場合は、既定のパスで 50G (Standard 価格レベル) または 1G (Basic 価格レベル) ディスクをマウントします。

指定可能な値: 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

レプリカの最大数。

規定値: 10

--memory

メモリ リソースの量。 512Mi、1536Mi、2560Mi、3584Mi、または #Gi にする必要があります (例: 1Gi、3Gi)。

--min-replicas

レプリカの最小数。

規定値: 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

システム割り当てマネージド ID を有効にします。

指定可能な値: false, true

--user-assigned

プレビュー

アプリへの assgin へのスペース区切りのユーザー割り当てマネージド ID リソース ID。

--workload-profile

マネージド環境で使用されるワークロード プロファイル。 既定値は "Consumption" です。

グローバル パラメーター

--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]
                     [--custom-actuator-path]
                     [--custom-actuator-port]
                     [--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 Build Service でバイナリがビルドされ、アプリにデプロイされます。

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 オプション、環境変数 (Standard および Basic レベルのみ) を使用して、事前構築済みの war をアプリにデプロイします。

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>

Application Configuration Service 構成ファイル パターンを使用してアプリにデプロイします。

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

ビルド env を使用して事前構築済みの jar をアプリにデプロイします (Enterprise レベルの場合のみ)。

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

(エンタープライズ層のみ)使用する Application Configuration Service のパターンを決定するために、"," で区切られたファイル パターンを構成します。 既存の構成をクリアするには、'""' を使用します。

--container-args

コンテナー イメージの引数。

--container-command

コンテナー イメージのコマンド。

--container-image

コンテナー イメージ タグ。

--container-registry

コンテナー イメージのレジストリ。

規定値: docker.io

--custom-actuator-path

(エンタープライズ層のみ)アプリのカスタム アクチュエータ パス。 既定値は "/actuator" です。

--custom-actuator-port

(エンタープライズ層のみ)アプリのカスタム アクチュエータ ポート。 既定値は 8080 です。

--deployment -d

アプリの既存のデプロイの名前。 指定されていない場合は、既定で運用環境のデプロイになります。

--disable-app-log

アプリケーションのデプロイ時にアプリケーション ログを出力しないでください。

規定値: False

--disable-probe

true の場合は、liveness と readiness プローブを無効にします。

指定可能な値: 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

(Standard レベルと Basic レベルのみ)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

5 秒、2m、1 時間などの相対的な期間より新しいログのみを返します。 最大値は 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、1250m、または CPU コア数である必要があります。

--deployment -d

アプリの既存のデプロイの名前。 指定されていない場合は、既定で運用環境のデプロイになります。

--instance-count

インスタンスの数。

--max-replicas

レプリカの最大数。

規定値: 10

--memory

メモリ リソースの量。 512Mi、1536Mi、2560Mi、3584Mi、または #Gi にする必要があります (例: 1Gi、3Gi)。

--min-replicas

レプリカの最小数。

規定値: 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]
                     [--custom-actuator-path]
                     [--custom-actuator-port]
                     [--deployment]
                     [--disable-probe {false, true}]
                     [--disable-tea {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

(エンタープライズ層のみ)使用する Application Configuration Service のパターンを決定するために、"," で区切られたファイル パターンを構成します。 既存の構成をクリアするには、'""' を使用します。

--custom-actuator-path

(エンタープライズ層のみ)アプリのカスタム アクチュエータ パス。 既定値は "/actuator" です。

--custom-actuator-port

(エンタープライズ層のみ)アプリのカスタム アクチュエータ ポート。 既定値は 8080 です。

--deployment -d

アプリの既存のデプロイの名前。 指定されていない場合は、既定で運用環境のデプロイになります。

--disable-probe

true の場合は、liveness と readiness プローブを無効にします。

指定可能な値: false, true

--disable-tea --disable-test-endpoint-auth

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 (Standard 価格レベル) または 1G (Basic 価格レベル) ディスクをマウントします。

指定可能な値: 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

マネージド環境で使用されるワークロード プロファイル。 既定値は "Consumption" です。

グローバル パラメーター

--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 を使います。