az spring gateway
手記
このリファレンスは、Azure CLI (バージョン 2.56.0 以降) の spring 拡張機能の一部です。 拡張機能は、az spring gateway コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
(エンタープライズ層のみ)Azure Spring Apps でゲートウェイを管理するコマンド。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az spring gateway clear |
ゲートウェイのすべての設定をクリアします。 |
延長 | ジョージア 州 |
az spring gateway create |
Spring Cloud Gateway を作成します。 |
延長 | ジョージア 州 |
az spring gateway custom-domain |
ゲートウェイのカスタム ドメインを管理するコマンド。 |
延長 | ジョージア 州 |
az spring gateway custom-domain bind |
カスタム ドメインをゲートウェイにバインドします。 |
延長 | ジョージア 州 |
az spring gateway custom-domain list |
ゲートウェイのすべてのカスタム ドメインを一覧表示します。 |
延長 | ジョージア 州 |
az spring gateway custom-domain show |
カスタム ドメインの詳細を表示します。 |
延長 | ジョージア 州 |
az spring gateway custom-domain unbind |
ゲートウェイのカスタム ドメインのバインドを解除します。 |
延長 | ジョージア 州 |
az spring gateway custom-domain update |
ゲートウェイのカスタム ドメインを更新します。 |
延長 | ジョージア 州 |
az spring gateway delete |
Spring Cloud Gateway を削除します。 |
延長 | ジョージア 州 |
az spring gateway restart |
Spring Cloud Gateway を再起動します。 |
延長 | ジョージア 州 |
az spring gateway route-config |
Azure Spring Apps でゲートウェイ ルート構成を管理するコマンド。 |
延長 | ジョージア 州 |
az spring gateway route-config create |
Json 配列形式のルーティング規則を使用してゲートウェイ ルート構成を作成します。 |
延長 | ジョージア 州 |
az spring gateway route-config list |
既存のすべてのゲートウェイ ルート構成を一覧表示します。 |
延長 | ジョージア 州 |
az spring gateway route-config remove |
既存のゲートウェイ ルート構成を削除します。 |
延長 | ジョージア 州 |
az spring gateway route-config show |
既存のゲートウェイ ルート構成を取得します。 |
延長 | ジョージア 州 |
az spring gateway route-config update |
Json 配列形式のルーティング規則を使用して、既存のゲートウェイ ルート構成を更新します。 |
延長 | ジョージア 州 |
az spring gateway show |
ゲートウェイの設定、プロビジョニングの状態、およびランタイムの状態を表示します。 |
延長 | ジョージア 州 |
az spring gateway sync-cert |
ゲートウェイの同期証明書。 |
延長 | ジョージア 州 |
az spring gateway update |
既存のゲートウェイのプロパティを更新します。 |
延長 | ジョージア 州 |
az spring gateway clear
ゲートウェイのすべての設定をクリアします。
az spring gateway clear --resource-group
--service
[--no-wait]
必須のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure Spring Apps インスタンスの名前は、az configure --defaults spring=<name>
を使用して既定のサービスを構成できます。
省略可能のパラメーター
実行時間の長い操作が完了するまで待つ必要はありません。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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
必須のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure Spring Apps インスタンスの名前は、az configure --defaults spring=<name>
を使用して既定のサービスを構成できます。
省略可能のパラメーター
インスタンスの数。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az spring gateway delete
Spring Cloud Gateway を削除します。
az spring gateway delete --resource-group
--service
[--yes]
必須のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure Spring Apps インスタンスの名前は、az configure --defaults spring=<name>
を使用して既定のサービスを構成できます。
省略可能のパラメーター
確認を求めないでください。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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
必須のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure Spring Apps インスタンスの名前は、az configure --defaults spring=<name>
を使用して既定のサービスを構成できます。
省略可能のパラメーター
実行時間の長い操作が完了するまで待つ必要はありません。
確認を求めないでください。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az spring gateway show
ゲートウェイの設定、プロビジョニングの状態、およびランタイムの状態を表示します。
az spring gateway show --resource-group
--service
必須のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure Spring Apps インスタンスの名前は、az configure --defaults spring=<name>
を使用して既定のサービスを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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
必須のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure Spring Apps インスタンスの名前は、az configure --defaults spring=<name>
を使用して既定のサービスを構成できます。
省略可能のパラメーター
実行時間の長い操作が完了するまで待つ必要はありません。
確認を求めないでください。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --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
必須のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
Azure Spring Apps インスタンスの名前は、az configure --defaults spring=<name>
を使用して既定のサービスを構成できます。
省略可能のパラメーター
アドオン構成の JSON 文字列のファイル パス。
アドオン構成の JSON 文字列。
クロスサイト要求でユーザー資格情報がサポートされているかどうか。
クロスサイト要求を行うために許可される配信元パターンのコンマ区切りのリスト。
クロスサイト要求で許可されるヘッダーのコンマ区切りの一覧。 特殊な値 *
を使用すると、実際の要求で任意のヘッダーを送信できます。
クロスサイト要求で許可される HTTP メソッドのコンマ区切りの一覧。 特殊な値 *
では、すべてのメソッドが許可されます。
クロスサイト要求を行うために許可される配信元のコンマ区切りのリスト。 特殊な値 *
では、すべてのドメインが許可されます。
ゲートウェイ インスタンスで使用できる API の詳細な説明。
ゲートウェイ インスタンスで使用可能な API の追加ドキュメントの場所。
ゲートウェイ インスタンスで使用できる API のコンテキストを説明するタイトル。
このゲートウェイ インスタンスで使用できる API のバージョン。
ゲートウェイと統合された APM のスペース区切りの一覧。 使用できる値は、ApplicationInsights、AppDynamics、Dynatrace、NewRelic、ElasticAPM です。
ゲートウェイと統合するための Azure Spring Apps の APM 参照名のスペース区切りの一覧。
true の場合は、直接アクセスするためのエンドポイント URL を割り当てます。
Azure Spring Apps の証明書名のコンマ区切りの一覧。
アプリケーションのパブリック識別子。
アプリケーションと承認サーバーにのみ認識されるシークレット。
CPU リソース量。 500m または CPU コアの数にする必要があります。
true の場合、ゲートウェイからアプリへの TLS 接続で証明書を検証します。
Spring Cloud Gateway で応答キャッシュ設定を有効にします。
クロスサイト要求用に公開する HTTP 応答ヘッダーのコンマ区切りの一覧。
true の場合は、https 経由でエンドポイントにアクセスします。
インスタンスの数。
発行者識別子の URI。
フライト前要求からの応答をクライアントがキャッシュできる時間 (秒単位)。
メモリ リソースの量。 512Mi または #Gi にする必要があります (例: 1Gi、3Gi)。
実行時間の長い操作が完了するまで待つ必要はありません。
環境変数の機密性の高いプロパティ。 "key[=value]" の書式をスペースで区切ります。
応答キャッシュのスコープ。使用可能な値は [Route, Instance] です。
キャッシュが一部のエントリを削除する必要があるかどうかを決定するキャッシュの最大サイズ。 例として、[1 GB、10 MB、100 KB] があります。 リセットするには "default" を使用します。ゲートウェイはこのプロパティを管理します。
キャッシュされたエントリの有効期限が切れるまでの時間。 例として、[1h, 30m, 50s] があります。 リセットするには "default" を使用します。ゲートウェイはこのプロパティを管理します。
アプリケーションがユーザーの代わりに実行できる特定のアクションのコンマ区切りリスト。
環境変数の機密性の高いプロパティ。 一度置くと、暗号化され、返されません。"key[=value]" の書式をスペースで区切ります。
API コンシューマーがゲートウェイ インスタンス上の API にアクセスするために使用するベース URL。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
Azure CLI