az apic

リファレンス

注

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

Azure API Center サービスを管理します。

コマンド

名前	説明	型	状態
az apic api	API Center で API を管理するコマンド。	拡張	GA
az apic api create	新しい API を登録するか、既存の API を更新します。	拡張	GA
az apic api definition	API Center で API 定義を管理するコマンド。	拡張	GA
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 delete	指定した API を削除します。	拡張	GA
az apic api deployment	API Center で API デプロイを管理するコマンド。	拡張	GA
az apic api deployment create	新しい API デプロイを作成するか、既存の API デプロイを更新します。	拡張	GA
az apic api deployment delete	API デプロイを削除します。	拡張	GA
az apic api deployment list	API デプロイのコレクションを一覧表示します。	拡張	GA
az apic api deployment show	API デプロイの詳細を取得します。	拡張	GA
az apic api deployment update	既存の API デプロイを更新します。	拡張	GA
az apic api list	API のコレクションを一覧表示します。	拡張	GA
az apic api register	仕様ファイルを信頼のソースとして使用して、バージョン、定義、および関連付けられたデプロイに新しい API を登録します。現時点では、OpenAPI JSON/YAML 形式のみがサポートされています。	拡張	プレビュー
az apic api show	API の詳細を取得します。	拡張	GA
az apic api update	既存の API を更新します。	拡張	GA
az apic api version	API Center で API バージョンを管理するコマンド。	拡張	GA
az apic api version create	新しい API バージョンを作成するか、既存の API バージョンを更新します。	拡張	GA
az apic api version delete	指定した API バージョンを削除します。	拡張	GA
az apic api version list	API バージョンのコレクションを一覧表示します。	拡張	GA
az apic api version show	API バージョンの詳細を取得します。	拡張	GA
az apic api version update	既存の API バージョンを更新します。	拡張	GA
az apic create	インスタンスを作成するか、Azure API Center サービスの既存のインスタンスを更新します。	拡張	GA
az apic delete	Azure API Center サービスのインスタンスを削除します。	拡張	GA
az apic environment	API Center で環境を管理するためのコマンド。	拡張	GA
az apic environment create	新しい環境を作成するか、既存の環境を更新します。	拡張	GA
az apic environment delete	その環境を削除します。	拡張	GA
az apic environment list	環境のコレクションを一覧表示します。	拡張	GA
az apic environment show	環境の詳細を取得します。	拡張	GA
az apic environment update	既存の環境を更新します。	拡張	GA
az apic import	Azure API Center サービスを管理します。	拡張	GA
az apic import-from-apim	Azure API Management サービスインスタンスから API をインポートします。	拡張	GA
az apic import aws	Amazon API Gateway API ソースをインポートします。	拡張	プレビュー
az apic integration	Azure API Center での統合を管理します。	拡張	プレビュー
az apic integration create	Azure API Center サービスを管理します。	拡張	プレビュー
az apic integration create apim	API ソースとして Azure APIM を追加します。	拡張	プレビュー
az apic integration create aws	API ソースとして Amazon API Gateway を追加します。	拡張	プレビュー
az apic integration delete	指定した API ソースを削除します。	拡張	プレビュー
az apic integration list	API ソースのコレクションを一覧表示します。	拡張	プレビュー
az apic integration show	API ソースの詳細を取得します。	拡張	プレビュー
az apic list	Azure サブスクリプション内の Azure API Center サービスを一覧表示します。	拡張	GA
az apic metadata	API Center でメタデータスキーマを管理するコマンド。	拡張	GA
az apic metadata create	新しいメタデータスキーマを作成するか、既存のメタデータスキーマを更新します。	拡張	GA
az apic metadata delete	指定したメタデータスキーマを削除します。	拡張	GA
az apic metadata export	メタデータスキーマをエクスポートします。	拡張	GA
az apic metadata list	メタデータスキーマのコレクションを一覧表示します。	拡張	GA
az apic metadata show	メタデータスキーマの詳細を取得します。	拡張	GA
az apic metadata update	既存のメタデータスキーマを更新します。	拡張	GA
az apic show	Azure API Center サービスインスタンスの詳細を表示します。	拡張	GA
az apic update	Azure API Center サービスのインスタンスを更新します。	拡張	GA

az apic create

インスタンスを作成するか、Azure API Center サービスの既存のインスタンスを更新します。

az apic create --name
               --resource-group
               [--identity]
               [--___location]
               [--tags]

例

サービスの作成の例

az apic create -g contoso-resources -n contoso -l eastus

システム割り当て ID を使用したサービスの作成の例

az apic create -g contoso-resources -n contoso -l eastus --identity '{type:systemassigned}'

必須のパラメーター

--name -n

API センターサービスの名前。

--resource-group -g

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

省略可能のパラメーター

--identity

このリソースに割り当てられているマネージドサービス ID。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--___location -l

リソースが存在する地理的な場所を指定しない場合は、リソースグループの場所が使用されます。

--tags

リソースタグ。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

グローバルパラメーター

--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 apic delete

Azure API Center サービスのインスタンスを削除します。

az apic delete [--ids]
               [--name]
               [--resource-group]
               [--subscription]
               [--yes]

例

サービスの削除

az apic delete -n contoso -g contoso-resources

省略可能のパラメーター

--ids

1 つ以上のリソース ID (スペース区切り)。これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

API センターサービスの名前。

--resource-group -g

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

--subscription

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

--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 apic import-from-apim

Azure API Management サービスインスタンスから API をインポートします。

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

例

同じリソースグループ内の APIM からすべての API をインポートする

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

同じリソースグループ内の APIM から選択した API をインポートする

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

別のサブスクリプションとリソースグループの APIM からすべての API をインポートする

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

必須のパラメーター

--apim-apis

インポートする API。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--apim-name

ソース APIM インスタンスの名前。

省略可能のパラメーター

--apim-resource-group

ソース APIM インスタンスのリソースグループ。

--apim-subscription

ソース APIM インスタンスのサブスクリプション ID。

--ids

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--service-name -n

Azure API Center サービスの名前。

--subscription

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

グローバルパラメーター

--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 apic list

Azure サブスクリプション内の Azure API Center サービスを一覧表示します。

サブスクリプションのすべてのリソースの一覧表示が機能しないという既知の問題があります。リソースグループごとにリソースを一覧表示してください。

az apic list [--max-items]
             [--next-token]
             [--resource-group]

例

リソースグループ内のサービスを一覧表示する

az apic list -g contoso-resources

省略可能のパラメーター

--max-items

コマンドの出力で返される項目の合計数。使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。これは、以前に切り捨てられた応答からのトークン値です。

--resource-group -g

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

グローバルパラメーター

--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 apic show

Azure API Center サービスインスタンスの詳細を表示します。

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

例

サービスの詳細を表示する

az apic show -g contoso-resources -n contoso

省略可能のパラメーター

--ids

--name -n

API センターサービスの名前。

--resource-group -g

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

--subscription

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

グローバルパラメーター

--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 apic update

Azure API Center サービスのインスタンスを更新します。

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

例

サービスの詳細を更新する

az apic update -g contoso-resources -n contoso

システム割り当て ID を使用したサービスの更新の例

az apic update -g contoso-resources -n contoso --identity '{type:systemassigned}'

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。例: --add property.listProperty <key=value, string or JSON string>。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--identity

--ids

--name -n

API センターサービスの名前。

--remove

リストからプロパティまたは要素を削除します。例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

--resource-group -g

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

--set

設定するプロパティパスと値を指定して、オブジェクトを更新します。例: --set property1.property2=<value>。

--subscription

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

--tags

リソースタグ。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

グローバルパラメーター

--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 apic

コマンド

az apic create

例

必須のパラメーター

省略可能のパラメーター

az apic delete

例

省略可能のパラメーター

az apic import-from-apim

例

必須のパラメーター

省略可能のパラメーター

az apic list

例

省略可能のパラメーター

az apic show

例

省略可能のパラメーター

az apic update

例

省略可能のパラメーター