次の方法で共有

az spring api-portal

  • 非推奨

注

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

コマンド グループ 'spring' は非推奨であり、今後のリリースで削除されるため、このコマンド グループは暗黙的に非推奨となります。

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

コマンド

名前 説明 型 状態
az spring api-portal clear

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

 拡張 Deprecated
az spring api-portal create

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

 拡張 Deprecated
az spring api-portal custom-domain

API ポータルのカスタム ドメインを管理するコマンド。

 拡張 Deprecated
az spring api-portal custom-domain bind

API ポータルを使用してカスタム ドメインをバインドします。

 拡張 Deprecated
az spring api-portal custom-domain list

API ポータルのすべてのカスタム ドメインを一覧表示します。

 拡張 Deprecated
az spring api-portal custom-domain show

カスタム ドメインの詳細を表示します。

 拡張 Deprecated
az spring api-portal custom-domain unbind

API ポータルのカスタム ドメインのバインドを解除します。

 拡張 Deprecated
az spring api-portal custom-domain update

API ポータルのカスタム ドメインを更新します。

 拡張 Deprecated
az spring api-portal delete

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

 拡張 Deprecated
az spring api-portal show

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

 拡張 Deprecated
az spring api-portal update

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

 拡張 Deprecated

az spring api-portal clear

非推奨

コマンド グループ 'spring' は非推奨であり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。

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=<name>を使用して既定のサービスを構成できます。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az spring api-portal create

非推奨

コマンド グループ 'spring' は非推奨であり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。

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=<name>を使用して既定のサービスを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--instance-count

インスタンスの数。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az spring api-portal delete

非推奨

コマンド グループ 'spring' は非推奨であり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。

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=<name>を使用して既定のサービスを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--yes -y

確認を求めないでください。

プロパティ 値
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az spring api-portal show

非推奨

コマンド グループ 'spring' は非推奨であり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。

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=<name>を使用して既定のサービスを構成できます。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az spring api-portal update

非推奨

コマンド グループ 'spring' は非推奨であり、今後のリリースで削除されるため、このコマンドは暗黙的に非推奨となります。

既存の 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=<name>を使用して既定のサービスを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--assign-endpoint

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

プロパティ 値
指定可能な値: false, true
--client-id

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

プロパティ 値
パラメーター グループ: Single Sign On (SSO) Arguments
--client-secret

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

プロパティ 値
パラメーター グループ: Single Sign On (SSO) Arguments
--enable-api-try-out

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

プロパティ 値
パラメーター グループ: Try out API Arguments
指定可能な値: false, true
--https-only

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

プロパティ 値
指定可能な値: false, true
--instance-count

インスタンスの数。

--issuer-uri

発行者識別子の URI。

プロパティ 値
パラメーター グループ: Single Sign On (SSO) Arguments
--scope

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

プロパティ 値
パラメーター グループ: Single Sign On (SSO) Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False