az apim
Azure API Management サービスを管理します。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az apim api |
Azure API Management API を管理します。 |
コア | GA |
az apim api create |
API Management API を作成します。 |
コア | GA |
az apim api delete |
API Management API を削除します。 |
コア | GA |
az apim api export |
API Management API をエクスポートします。 |
コア | GA |
az apim api import |
API Management API をインポートします。 |
コア | GA |
az apim api list |
API Management API を一覧表示します。 |
コア | GA |
az apim api operation |
Azure API Management API 操作を管理します。 |
コア | GA |
az apim api operation create |
API で新しい操作を作成します。 |
コア | GA |
az apim api operation delete |
API の指定された操作を削除します。 |
コア | GA |
az apim api operation list |
指定した API の操作のコレクションを一覧表示します。 |
コア | GA |
az apim api operation show |
識別子で指定された API 操作の詳細を取得します。 |
コア | GA |
az apim api operation update |
識別子で指定された API の操作の詳細を更新します。 |
コア | GA |
az apim api release |
Azure API Management API リリースを管理します。 |
コア | GA |
az apim api release create |
API の新しいリリースを作成します。 |
コア | GA |
az apim api release delete |
API で指定したリリースを削除します。 |
コア | GA |
az apim api release list |
API のすべてのリリースを一覧表示します。 |
コア | GA |
az apim api release show |
API リリースの詳細を返します。 |
コア | GA |
az apim api release update |
識別子で指定された API のリリースの詳細を更新します。 |
コア | GA |
az apim api revision |
Azure API Management API リビジョンを管理します。 |
コア | GA |
az apim api revision create |
API リビジョンを作成します。 |
コア | GA |
az apim api revision list |
API のすべてのリビジョンを一覧表示します。 |
コア | GA |
az apim api schema |
Azure API Management API スキーマを管理します。 |
コア | GA |
az apim api schema create |
API Management API スキーマを作成します。 |
コア | GA |
az apim api schema delete |
API Management API スキーマを削除します。 |
コア | GA |
az apim api schema get-etag |
API Management API スキーマの etag を取得します。 |
コア | GA |
az apim api schema list |
API Management API スキーマを一覧表示します。 |
コア | GA |
az apim api schema show |
API Management API スキーマの詳細を表示します。 |
コア | GA |
az apim api schema wait |
apim api スキーマの条件が満たされるまで、CLI を待機状態にします。 |
コア | GA |
az apim api show |
API Management API の詳細を表示します。 |
コア | GA |
az apim api update |
API Management API を更新します。 |
コア | GA |
az apim api versionset |
Azure API Management API バージョン セットを管理します。 |
コア | GA |
az apim api versionset create |
API バージョン セットを作成します。 |
コア | GA |
az apim api versionset delete |
特定の API バージョン セットを削除します。 |
コア | GA |
az apim api versionset list |
指定されたサービス インスタンスにおける API バージョン セットのコレクションを一覧表示します。 |
コア | GA |
az apim api versionset show |
識別子で指定された API バージョン セットの詳細を取得します。 |
コア | GA |
az apim api versionset update |
識別子で指定された Api VersionSet の詳細を更新します。 |
コア | GA |
az apim api wait |
apim API の条件が満たされるまで、CLI を待機状態にします。 |
コア | GA |
az apim apply-network-updates |
仮想ネットワークで実行されている API Management リソースを更新して、更新されたネットワーク設定を選択します。 |
コア | GA |
az apim backup |
特定の Azure ストレージ アカウントへの API Management サービスのバックアップを作成します。 これは実行時間の長い操作であり、完了までに数分かかる場合があります。 |
コア | GA |
az apim check-name |
サービス名を使用できるかどうかを確認します。 |
コア | GA |
az apim create |
API Management サービス インスタンスの作成。 |
コア | GA |
az apim delete |
API Management サービスを削除します。 |
コア | GA |
az apim deletedservice |
論理的に削除された Azure API Management サービスを管理します。 |
コア | GA |
az apim deletedservice list |
特定のサブスクリプションの削除を取り消す際に使用できる、論理的に削除されたすべての Api Management サービス インスタンスを一覧表示します。 |
コア | GA |
az apim deletedservice purge |
論理的に削除された Api Management サービス インスタンスを消去します (削除を取り消すオプションなしで削除します)。 |
コア | GA |
az apim deletedservice show |
名前で削除を取り消して使用できる論理的に削除された Api Management サービス インスタンスを取得します。 |
コア | GA |
az apim graphql |
Azure API Management GraphQL API を管理します。 |
コア | GA |
az apim graphql resolver |
Azure API Management GraphQL API のリゾルバーを管理します。 |
コア | GA |
az apim graphql resolver create |
GraphQL API で新しいリゾルバーを作成するか、既存の競合回避モジュールを更新します。 |
コア | GA |
az apim graphql resolver delete |
GraphQL API で指定したリゾルバーを削除します。 |
コア | GA |
az apim graphql resolver list |
指定した GraphQL API のリゾルバーのコレクションを一覧表示します。 |
コア | GA |
az apim graphql resolver policy |
Azure API Management GraphQL API のリゾルバー ポリシーを管理します。 |
コア | GA |
az apim graphql resolver policy create |
GraphQL API リゾルバー レベルのポリシー構成を作成または更新します。 |
コア | GA |
az apim graphql resolver policy delete |
GraphQL Api リゾルバーでポリシー構成を削除します。 |
コア | GA |
az apim graphql resolver policy list |
GraphQL API リゾルバー レベルでポリシー構成の一覧を取得します。 |
コア | GA |
az apim graphql resolver policy show |
GraphQL API リゾルバー レベルでポリシー構成を取得します。 |
コア | GA |
az apim graphql resolver show |
識別子で指定された GraphQL API リゾルバーの詳細を取得します。 |
コア | GA |
az apim list |
API Management サービス インスタンスを一覧表示します。 |
コア | GA |
az apim nv |
Azure API Management の名前付き値を管理します。 |
コア | GA |
az apim nv create |
API Management の名前付き値を作成します。 |
コア | GA |
az apim nv delete |
API Management の名前付き値を削除します。 |
コア | GA |
az apim nv list |
API Management の名前付き値を一覧表示します。 |
コア | GA |
az apim nv show |
API Management の名前付き値の詳細を表示します。 |
コア | GA |
az apim nv show-secret |
API Management の名前付き値のシークレットを取得します。 |
コア | GA |
az apim nv update |
API Management の名前付き値を更新します。 |
コア | GA |
az apim nv wait |
apim の名前付き値の条件が満たされるまで、CLI を待機状態にします。 |
コア | GA |
az apim product |
Azure API Management 製品を管理します。 |
コア | GA |
az apim product api |
Azure API Management 製品の API を管理します。 |
コア | GA |
az apim product api add |
指定した製品に API を追加します。 |
コア | GA |
az apim product api check |
識別子で指定された API エンティティが Product エンティティに関連付けられていることを確認します。 |
コア | GA |
az apim product api delete |
指定された製品から指定された API を削除します。 |
コア | GA |
az apim product api list |
製品に関連付けられている API のコレクションを一覧表示します。 |
コア | GA |
az apim product create |
製品を作成します。 |
コア | GA |
az apim product delete |
製品を削除します。 |
コア | GA |
az apim product list |
指定されたサービス インスタンスにおける製品のコレクションを一覧表示します。 |
コア | GA |
az apim product show |
識別子で指定された製品の詳細を取得します。 |
コア | GA |
az apim product update |
既存の製品の詳細を更新します。 |
コア | GA |
az apim product wait |
apim 製品の条件が満たされるまで、CLI を待機状態にします。 |
コア | GA |
az apim restore |
現在のサービスでApiManagementService_Backup操作を使用して作成された API Management サービスのバックアップを復元します。 これは実行時間の長い操作であり、完了までに数分かかる場合があります。 |
コア | GA |
az apim show |
API Management サービス インスタンスの詳細を表示します。 |
コア | GA |
az apim update |
API Management サービス インスタンスを更新します。 |
コア | GA |
az apim wait |
APIM の条件が満たされるまで、CLI を待機状態にします。 |
コア | GA |
az apim apply-network-updates
仮想ネットワークで実行されている API Management リソースを更新して、更新されたネットワーク設定を選択します。
az apim apply-network-updates --name
--resource-group
[--location]
[--no-wait]
例
API Management サービス インスタンスの仮想ネットワーク設定を更新する
az apim apply-network-updates --name MyApim -g MyResourceGroup
必須のパラメーター
API Management サービス インスタンスの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
Location。 値のソース: az account list-locations
az configure --defaults location=<location>
を使用して、既定の場所を構成できます。
実行時間の長い操作の終了を待機しません。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apim backup
特定の Azure ストレージ アカウントへの API Management サービスのバックアップを作成します。 これは実行時間の長い操作であり、完了までに数分かかる場合があります。
az apim backup --backup-name
--container-name
--name
--resource-group
--storage-account-key
--storage-account-name
[--no-wait]
例
API Management サービス インスタンスのバックアップを作成する
az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup --storage-account-name mystorageaccount --storage-account-container backups --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==
必須のパラメーター
作成するバックアップ ファイルの名前。
バックアップの配置に使用するストレージ アカウント コンテナーの名前。
API Management サービス インスタンスの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
バックアップの配置に使用するストレージ アカウントのアクセス キー。
バックアップの配置に使用するストレージ アカウントの名前。
省略可能のパラメーター
実行時間の長い操作の終了を待機しません。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apim check-name
サービス名を使用できるかどうかを確認します。
az apim check-name --name
必須のパラメーター
API Management サービス インスタンスの名前。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apim create
API Management サービス インスタンスの作成。
az apim create --name
--publisher-email
--publisher-name
--resource-group
[--disable-gateway {false, true}]
[--enable-client-certificate {false, true}]
[--enable-managed-identity {false, true}]
[--location]
[--no-wait]
[--public-network-access {false, true}]
[--sku-capacity]
[--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
[--tags]
[--virtual-network {External, Internal, None}]
例
開発者層 API Management サービスを作成します。
az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft
従量課金レベルの API Management サービスを作成します。
az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
--publisher-email email@mydomain.com --publisher-name Microsoft
必須のパラメーター
作成するサービス インスタンスの一意の名前。
ゲートウェイホスト名として https://my-api-servicename.azure-api.net含まれるので、名前はグローバルに一意である必要があります' '。 例を参照してください。
すべてのシステム通知を受信する電子メール アドレス。
開発者ポータルと電子メール通知で使用する組織の名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
マスター リージョンのゲートウェイを無効にします。 複数の場所にデプロイされた Api Management サービスに対してのみ有効です。
ゲートウェイに対する各要求にクライアント証明書を提示し、ゲートウェイのポリシーで証明書を認証できるようにします。
他の Azure リソースにアクセスするための API Management サービスのマネージド ID を作成します。 従量課金 SKU サービスにのみ使用されます。
Location。 値のソース: az account list-locations
az configure --defaults location=<location>
を使用して、既定の場所を構成できます。
実行時間の長い操作の終了を待機しません。
この API Management サービスに対してパブリック エンドポイント アクセスが許可されているかどうか。 true に設定すると、プライベート エンドポイントが排他的アクセス方法になります。
SKU のデプロイ済みユニットの数。
API Management インスタンスの SKU。
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
仮想ネットワークの種類。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apim delete
API Management サービスを削除します。
az apim delete --name
--resource-group
[--no-wait]
[--yes]
例
API Management サービスを削除します。
az apim delete -n MyApim -g MyResourceGroup
必須のパラメーター
API Management サービス インスタンスの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
実行時間の長い操作の終了を待機しません。
確認のダイアログを表示しません。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apim list
API Management サービス インスタンスを一覧表示します。
az apim list [--resource-group]
省略可能のパラメーター
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apim restore
現在のサービスでApiManagementService_Backup操作を使用して作成された API Management サービスのバックアップを復元します。 これは実行時間の長い操作であり、完了までに数分かかる場合があります。
az apim restore --backup-name
--container-name
--name
--resource-group
--storage-account-key
--storage-account-name
[--no-wait]
例
API Management サービス インスタンスのバックアップを復元します
az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup --storage-account-name mystorageaccount --storage-account-container backups --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==
必須のパラメーター
復元するバックアップ ファイルの名前。
バックアップの取得元として使用されるストレージ アカウント コンテナーの名前。
API Management サービス インスタンスの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
バックアップの取得元として使用されるストレージ アカウントのアクセス キー。
バックアップの取得元として使用されるストレージ アカウントの名前。
省略可能のパラメーター
実行時間の長い操作の終了を待機しません。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apim show
API Management サービス インスタンスの詳細を表示します。
az apim show --name
--resource-group
必須のパラメーター
API Management サービス インスタンスの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apim update
API Management サービス インスタンスを更新します。
az apim update --name
--resource-group
[--add]
[--disable-gateway {false, true}]
[--enable-client-certificate {false, true}]
[--enable-managed-identity {false, true}]
[--force-string]
[--no-wait]
[--public-network-access {false, true}]
[--publisher-email]
[--publisher-name]
[--remove]
[--set]
[--sku-capacity]
[--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
[--tags]
[--virtual-network {External, Internal, None}]
必須のパラメーター
API Management サービス インスタンスの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>
。
マスター リージョンのゲートウェイを無効にします。 複数の場所にデプロイされた Api Management サービスに対してのみ有効です。
ゲートウェイに対する各要求にクライアント証明書を提示し、ゲートウェイのポリシーで証明書を認証できるようにします。
他の Azure リソースにアクセスするための API Management サービスのマネージド ID を作成します。 従量課金 SKU サービスにのみ使用されます。
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
実行時間の長い操作の終了を待機しません。
この API Management サービスに対してパブリック エンドポイント アクセスが許可されているかどうか。 true に設定すると、プライベート エンドポイントが排他的アクセス方法になります。
すべてのシステム通知を受信する電子メール アドレス。
開発者ポータルと電子メール通知で使用する組織の名前。
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>
。
SKU のデプロイ済みユニットの数。
API Management インスタンスの SKU。
スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。
仮想ネットワークの種類。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az apim wait
APIM の条件が満たされるまで、CLI を待機状態にします。
az apim wait --name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
例
apim の条件が満たされるまで、CLI を待機状態にします。 (自動生成)
az apim wait --created --name MyApim --resource-group MyResourceGroup
必須のパラメーター
API Management サービス インスタンスの名前。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
省略可能のパラメーター
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
削除されるまで待ちます。
リソースが存在するまで待ちます。
ポーリング間隔 (秒単位)。
最大待機時間 (秒単位)。
provisioningState が 'Succeeded' で更新されるまで待ちます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI