az apic api definition
Note
このリファレンスは、Azure CLI (バージョン 2.57.0 以降) の apic-extension 拡張機能の一部です。 拡張機能は、az apic api definition コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
API Center で API 定義を管理するコマンド。
コマンド
| 名前 | 説明 | 型 | Status |
|---|---|---|---|
| az apic api definition create |
新しい API 定義を作成するか、既存の API 定義を更新します。 |
拡張子 | GA |
| az apic api definition delete |
指定した API 定義を削除します。 |
拡張子 | GA |
| az apic api definition export-specification |
API 仕様をエクスポートします。 |
拡張子 | GA |
| az apic api definition import-specification |
API 仕様をインポートします。 |
拡張子 | GA |
| az apic api definition list |
API 定義のコレクションを一覧表示します。 |
拡張子 | GA |
| az apic api definition show |
API 定義の詳細を取得します。 |
拡張子 | GA |
| az apic api definition update |
既存の API 定義を更新します。 |
拡張子 | GA |
az apic api definition create
新しい API 定義を作成するか、既存の API 定義を更新します。
az apic api definition create --api-id
--definition-id
--resource-group
--service
--title
--version-id
[--description]例
API 定義を作成する
az apic api definition create -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"必須のパラメーター
API の ID。
API 定義の ID。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
API センター サービスの名前。
API バージョン。
API バージョンの ID。
省略可能のパラメーター
API 定義の説明。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apic api definition delete
指定した API 定義を削除します。
az apic api definition delete [--api-id]
[--definition-id]
[--ids]
[--resource-group]
[--service]
[--subscription]
[--version-id]
[--yes]例
API 定義の削除
az apic api definition delete -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"省略可能のパラメーター
API の ID。
API 定義の ID。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
API センター サービスの名前。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
API バージョンの ID。
確認のダイアログを表示しません。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apic api definition export-specification
API 仕様をエクスポートします。
az apic api definition export-specification --file-name
[--api-id]
[--definition-id]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service]
[--subscription]
[--version-id]例
エクスポートの仕様
az apic api version definition export-specification -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default必須のパラメーター
スペックのエクスポート先となるファイルの名前。
省略可能のパラメーター
API の ID。
API 定義の ID。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
実行時間の長い操作の終了を待機しません。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
API センター サービスの名前。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
API バージョンの ID。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apic api definition import-specification
API 仕様をインポートします。
az apic api definition import-specification [--api-id]
[--definition-id]
[--file-name]
[--format {inline, link}]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service]
[--specification]
[--subscription]
[--value]
[--version-id]例
インポート仕様の例 1
az apic api definition import-specification -g api-center-test -s contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'インポート仕様の例 2
az apic api definition import-specification -g api-center-test -s contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json' --specification '{"name":"openapi","version":"3.0.0"}'省略可能のパラメーター
API の ID。
API 定義の ID。
スペックのインポート先となるファイルの名前。
API 仕様ソースの形式。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
実行時間の長い操作の終了を待機しません。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
API センター サービスの名前。
API 仕様の詳細。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
API 仕様ソースの値。
API バージョンの ID。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apic api definition list
API 定義のコレクションを一覧表示します。
az apic api definition list --api-id
--resource-group
--service
--version-id
[--filter]
[--max-items]
[--next-token]例
API 定義を一覧表示する
az apic api definition list -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01必須のパラメーター
API の ID。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
API センター サービスの名前。
API バージョンの ID。
省略可能のパラメーター
OData フィルター パラメーター。
コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数に --next-token トークン値を指定します。
ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apic api definition show
API 定義の詳細を取得します。
az apic api definition show [--api-id]
[--definition-id]
[--ids]
[--resource-group]
[--service]
[--subscription]
[--version-id]例
API 定義の詳細を表示する
az apic api definition show -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"省略可能のパラメーター
API の ID。
API 定義の ID。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
API センター サービスの名前。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
API バージョンの ID。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apic api definition update
既存の API 定義を更新します。
az apic api definition update [--add]
[--api-id]
[--definition-id]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--remove]
[--resource-group]
[--service]
[--set]
[--subscription]
[--title]
[--version-id]例
API 定義を更新する
az apic api definition update -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"省略可能のパラメーター
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value、string、または JSON 文字列>。
API の ID。
API 定義の ID。
API 定義の説明。
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
リストからプロパティまたは要素を削除します。 例: --remove property.list OR --remove propertyToRemove。
リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。
API センター サービスの名前。
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
API バージョンのタイトル。
API バージョンの ID。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示