az spring gateway

Note

このリファレンスは、Azure CLI (バージョン 2.56.0 以降) の Spring 拡張機能の一部です。 拡張機能は、az spring gateway コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

(エンタープライズ層のみ)Azure Spring Apps でゲートウェイを管理するコマンド。

コマンド

名前	説明	型	Status
az spring gateway clear	ゲートウェイのすべての設定をクリアします。	拡張子	GA
az spring gateway create	Spring Cloud Gateway を作成します。	拡張子	GA
az spring gateway custom-domain	ゲートウェイのカスタム doメイン を管理するコマンド。	拡張子	GA
az spring gateway custom-domain bind	カスタム doメイン をゲートウェイにバインドします。	拡張子	GA
az spring gateway custom-domain list	ゲートウェイのすべてのカスタム doメイン を一覧表示します。	拡張子	GA
az spring gateway custom-domain show	カスタム do の詳細を表示メイン。	拡張子	GA
az spring gateway custom-domain unbind	ゲートウェイの custom-doメイン のバインドを解除します。	拡張子	GA
az spring gateway custom-domain update	ゲートウェイのカスタム doメイン を更新します。	拡張子	GA
az spring gateway delete	Spring Cloud Gateway を削除します。	拡張子	GA
az spring gateway restart	Spring Cloud Gateway を再起動します。	拡張子	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 Gateway を再起動します。

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

例

Spring Cloud Gateway を再起動します。

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 のスペース区切りの一覧。 使用できる値は、Applicationインサイト、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

キャッシュが一部のエントリを削除する必要があるかどうかを決定するキャッシュの最大サイズ。 例として、[1 GB、10 MB (メガバイト)、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 を使います。