az apic

Note

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

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

コマンド

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

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

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

--identity

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

--location -l

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

--tags

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

グローバルパラメーター

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

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

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

例

サービスの削除

az apic delete -n contoso -g contoso-resources

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

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

--ids

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--name -n

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--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/ を参照してください。

--verbose

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

プロパティ	値
規定値:	False

az apic list

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

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

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

例

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

az apic list -g contoso-resources

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

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

--max-items

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

プロパティ	値
パラメーターグループ:	Pagination Arguments

--next-token

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

プロパティ	値
パラメーターグループ:	Pagination Arguments

--resource-group -g

リソースグループの名前。 az configure --defaults group=<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 apic show

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

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

例

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

az apic show -g contoso-resources -n contoso

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

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

--ids

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--name -n

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--resource-group -g

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--subscription

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

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

--query

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

--verbose

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

プロパティ	値
規定値:	False

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}'

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

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

--add

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

プロパティ	値
パラメーターグループ:	Generic Update Arguments

--force-string

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

プロパティ	値
パラメーターグループ:	Generic Update Arguments
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--identity

--ids

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--name -n

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--remove

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

プロパティ	値
パラメーターグループ:	Generic Update Arguments

--resource-group -g

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--set

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

プロパティ	値
パラメーターグループ:	Generic Update Arguments

--subscription

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

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--tags

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

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

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

--query

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

--verbose

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

プロパティ	値
規定値:	False

フィードバック

このページはお役に立ちましたか?

次の方法で共有

az apic

コマンド

az apic create

例

必須のパラメーター

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

az apic delete

例

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

az apic list

例

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

az apic show

例

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

az apic update

例

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

フィードバック