az apic api

手記

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

API Center で API を管理するコマンド。

コマンド

名前	説明	型	状態
az apic api create	新しい API を登録するか、既存の API を更新します。	延長	ジョージア 州
az apic api definition	API Center で API 定義を管理するコマンド。	延長	ジョージア 州
az apic api definition create	新しい API 定義を作成するか、既存の API 定義を更新します。	延長	ジョージア 州
az apic api definition delete	指定した API 定義を削除します。	延長	ジョージア 州
az apic api definition export-specification	API 仕様をエクスポートします。	延長	ジョージア 州
az apic api definition import-specification	API 仕様をインポートします。	延長	ジョージア 州
az apic api definition list	API 定義のコレクションを一覧表示します。	延長	ジョージア 州
az apic api definition show	API 定義の詳細を取得します。	延長	ジョージア 州
az apic api definition update	既存の API 定義を更新します。	延長	ジョージア 州
az apic api delete	指定した API を削除します。	延長	ジョージア 州
az apic api deployment	API Center で API デプロイを管理するコマンド。	延長	ジョージア 州
az apic api deployment create	新しい API デプロイを作成するか、既存の API デプロイを更新します。	延長	ジョージア 州
az apic api deployment delete	API デプロイを削除します。	延長	ジョージア 州
az apic api deployment list	API デプロイのコレクションを一覧表示します。	延長	ジョージア 州
az apic api deployment show	API デプロイの詳細を取得します。	延長	ジョージア 州
az apic api deployment update	既存の API デプロイを更新します。	延長	ジョージア 州
az apic api list	API のコレクションを一覧表示します。	延長	ジョージア 州
az apic api register	仕様ファイルを信頼のソースとして使用して、バージョン、定義、および関連付けられたデプロイに新しい API を登録します。 現時点では、OpenAPI JSON/YAML 形式のみがサポートされています。	延長	プレビュー
az apic api show	API の詳細を取得します。	延長	ジョージア 州
az apic api update	既存の API を更新します。	延長	ジョージア 州
az apic api version	API Center で API バージョンを管理するコマンド。	延長	ジョージア 州
az apic api version create	新しい API バージョンを作成するか、既存の API バージョンを更新します。	延長	ジョージア 州
az apic api version delete	指定した API バージョンを削除します。	延長	ジョージア 州
az apic api version list	API バージョンのコレクションを一覧表示します。	延長	ジョージア 州
az apic api version show	API バージョンの詳細を取得します。	延長	ジョージア 州
az apic api version update	既存の API バージョンを更新します。	延長	ジョージア 州

az apic api create

新しい API を登録するか、既存の API を更新します。

az apic api create --api-id
                   --resource-group
                   --service-name
                   --title
                   --type {graphql, grpc, rest, soap, webhook, websocket}
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--license]
                   [--summary]

例

API の作成

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST

カスタム プロパティを使用して API を作成する

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'

json ファイルを使用してカスタム プロパティを使用して API を作成する

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json'

必須のパラメーター

--api-id

API の ID。

--resource-group -g

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

--service-name -n

Azure API Center サービスの名前。

--title

API タイトル。

--type

API の種類。

指定可能な値: graphql, grpc, rest, soap, webhook, websocket

省略可能のパラメーター

--contacts

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

--custom-properties

API カタログ エンティティに対して定義されたカスタム メタデータ。 json-file と yaml-file をサポートします。

--description

API の説明。

--external-documentation

API のその他の外部ドキュメント。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--license

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

--summary

API の簡単な説明。

グローバル パラメーター

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

指定した API を削除します。

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

例

API の削除

az apic api delete -g contoso-resources -n contoso --api-id echo-api

省略可能のパラメーター

--api-id

API の ID。

--ids

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

--resource-group -g

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

--service-name -n

Azure API Center サービスの名前。

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

API のコレクションを一覧表示します。

az apic api list --resource-group
                 --service-name
                 [--filter]
                 [--max-items]
                 [--next-token]

例

API の一覧表示

az apic api list -g contoso-resources -n contoso

フィルターを使用して API を一覧表示する

az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"

必須のパラメーター

--resource-group -g

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

--service-name -n

Azure API Center サービスの名前。

省略可能のパラメーター

--filter

OData フィルター パラメーター。

--max-items

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

--next-token

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

グローバル パラメーター

--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 api register

プレビュー

このコマンドはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

仕様ファイルを信頼のソースとして使用して、バージョン、定義、および関連付けられたデプロイに新しい API を登録します。 現時点では、OpenAPI JSON/YAML 形式のみがサポートされています。

az apic api register --api-location
                     --resource-group
                     --service-name
                     [--environment-id]

例

仕様ファイルを指定して API を登録します。

az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public

仕様 URL を指定して API を登録します。

az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.yaml" --environment-id public

必須のパラメーター

--api-location -l

仕様ファイルの場所。

--resource-group -g

リソース グループ名。

--service-name -n

APICenter カタログまたはサービス名。

省略可能のパラメーター

--environment-id

以前に作成された環境の 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 api show

API の詳細を取得します。

az apic api show [--api-id]
                 [--ids]
                 [--resource-group]
                 [--service-name]
                 [--subscription]

例

API の詳細を表示する

az apic api show -g contoso-resources -n contoso --api-id echo-api

省略可能のパラメーター

--api-id

API の ID。

--ids

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

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

既存の API を更新します。

az apic api update [--add]
                   [--api-id]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--license]
                   [--remove]
                   [--resource-group]
                   [--service-name]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

例

Update API

az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"

カスタム プロパティを更新する

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'

json ファイルを使用してカスタム プロパティを更新する

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'

単一のカスタム メタデータを更新する

az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false

省略可能のパラメーター

--add

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

--api-id

API の ID。

--contacts

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

--custom-properties

API カタログ エンティティに対して定義されたカスタム メタデータ。 json-file と yaml-file をサポートします。

--description

API の説明。

--external-documentation

API のその他の外部ドキュメント。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--force-string

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

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

--ids

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

--license

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

--remove

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

--resource-group -g

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

--service-name -n

Azure API Center サービスの名前。

--set

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

--subscription

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

--summary

API の簡単な説明。

--title

API タイトル。

--type

API の種類。

指定可能な値: graphql, grpc, rest, soap, webhook, websocket

グローバル パラメーター

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