az spring api-portal

Note

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

(エンタープライズ層のみ)Azure Spring Apps で API ポータルを管理するコマンド。

コマンド

名前	説明	型	Status
az spring api-portal clear	API ポータルのすべての設定をクリアします。	拡張子	GA
az spring api-portal create	API ポータルを作成します。	拡張子	GA
az spring api-portal custom-domain	API ポータルのカスタム doメイン を管理するコマンド。	拡張子	GA
az spring api-portal custom-domain bind	カスタム do メインを API ポータルにバインドします。	拡張子	GA
az spring api-portal custom-domain list	API ポータルのすべてのカスタム doメイン を一覧表示します。	拡張子	GA
az spring api-portal custom-domain show	カスタム do の詳細を表示メイン。	拡張子	GA
az spring api-portal custom-domain unbind	API ポータルの custom-doメイン のバインドを解除します。	拡張子	GA
az spring api-portal custom-domain update	API ポータルのカスタム doメイン を更新します。	拡張子	GA
az spring api-portal delete	API ポータルを削除します。	拡張子	GA
az spring api-portal show	API ポータルの設定、プロビジョニングの状態、およびランタイムの状態を表示します。	拡張子	GA
az spring api-portal update	既存の API ポータルのプロパティを更新します。	拡張子	GA

az spring api-portal clear

API ポータルのすべての設定をクリアします。

az spring api-portal clear --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 api-portal create

API ポータルを作成します。

az spring api-portal create --resource-group
                            --service
                            [--instance-count]

例

API ポータルを作成します。

az spring api-portal create -s MyService -g MyResourceGroup --instance-count 1

必須のパラメーター

--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 api-portal delete

API ポータルを削除します。

az spring api-portal 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 api-portal show

API ポータルの設定、プロビジョニングの状態、およびランタイムの状態を表示します。

az spring api-portal 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 api-portal update

既存の API ポータルのプロパティを更新します。

az spring api-portal update --resource-group
                            --service
                            [--assign-endpoint {false, true}]
                            [--client-id]
                            [--client-secret]
                            [--enable-api-try-out {false, true}]
                            [--https-only {false, true}]
                            [--instance-count]
                            [--issuer-uri]
                            [--scope]

例

API ポータルのプロパティを更新します。

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

必須のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--service -s

Azure Spring Apps インスタンスの名前。az configure --defaults spring= を使用して既定のサービスを構成できます。

省略可能のパラメーター

--assign-endpoint

true の場合は、直接アクセスするためのエンドポイント URL を割り当てます。

承認された値: false, true

--client-id

アプリケーションのパブリック識別子。

--client-secret

アプリケーションと承認サーバーにのみ認識されるシークレット。

--enable-api-try-out

API ポータルで要求を送信し、応答を表示して、API を試してみてください。

承認された値: false, true

--https-only

true の場合は、https 経由でエンドポイントにアクセスします。

承認された値: false, true

--instance-count

インスタンスの数。

--issuer-uri

発行者識別子の URI。

--scope

アプリケーションがユーザーの代わりに実行できる特定のアクションのコンマ区切りリスト。

グローバル パラメーター

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