az apim

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

コマンド

名前	説明	型	状態
az apim api	Azure API Management API を管理します。	Core	GA
az apim api create	API Management API を作成します。	Core	GA
az apim api delete	API Management API を削除します。	Core	GA
az apim api export	API Management API をエクスポートします。	Core	GA
az apim api import	API Management API をインポートします。	Core	GA
az apim api list	API Management API を一覧表示します。	Core	GA
az apim api operation	Azure API Management API 操作を管理します。	Core	GA
az apim api operation create	API で新しい操作を作成します。	Core	GA
az apim api operation delete	API で指定された操作を削除します。	Core	GA
az apim api operation list	指定した API の操作のコレクションを一覧表示します。	Core	GA
az apim api operation show	識別子で指定された API 操作の詳細を取得します。	Core	GA
az apim api operation update	識別子で指定された API の操作の詳細を更新します。	Core	GA
az apim api release	Azure API Management API リリースを管理します。	Core	GA
az apim api release create	API の新しいリリースを作成します。	Core	GA
az apim api release delete	API で指定したリリースを削除します。	Core	GA
az apim api release list	API のすべてのリリースを一覧表示します。	Core	GA
az apim api release show	API リリースの詳細を返します。	Core	GA
az apim api release update	識別子で指定された API のリリースの詳細を更新します。	Core	GA
az apim api revision	Azure API Management API リビジョンを管理します。	Core	GA
az apim api revision create	API リビジョンを作成します。	Core	GA
az apim api revision list	API のすべてのリビジョンを一覧表示します。	Core	GA
az apim api schema	Azure API Management API スキーマを管理します。	Core	GA
az apim api schema create	API Management API スキーマを作成します。	Core	GA
az apim api schema delete	API Management API スキーマを削除します。	Core	GA
az apim api schema get-etag	API Management API スキーマの etag を取得します。	Core	GA
az apim api schema list	API Management API スキーマを一覧表示します。	Core	GA
az apim api schema show	API Management API スキーマの詳細を表示します。	Core	GA
az apim api schema wait	apim api スキーマの条件が満たされるまで、CLI を待機状態にします。	Core	GA
az apim api show	API Management API の詳細を表示します。	Core	GA
az apim api update	API Management API を更新します。	Core	GA
az apim api versionset	Azure API Management API バージョンセットを管理します。	Core	GA
az apim api versionset create	API バージョンセットを作成します。	Core	GA
az apim api versionset delete	特定の API バージョンセットを削除します。	Core	GA
az apim api versionset list	指定したサービスインスタンス内の API バージョンセットのコレクションを一覧表示します。	Core	GA
az apim api versionset show	識別子で指定された API バージョンセットの詳細を取得します。	Core	GA
az apim api versionset update	識別子で指定された Api VersionSet の詳細を更新します。	Core	GA
az apim api wait	apim API の条件が満たされるまで、CLI を待機状態にします。	Core	GA
az apim apply-network-updates	仮想ネットワークで実行されている API Management リソースを更新して、更新されたネットワーク設定を選択します。	Core	GA
az apim backup	特定の Azure ストレージアカウントへの API Management サービスのバックアップを作成します。これは実行時間の長い操作であり、完了までに数分かかる場合があります。	Core	GA
az apim check-name	サービス名を使用できるかどうかを確認します。	Core	GA
az apim create	API Management サービスインスタンスを作成します。	Core	GA
az apim delete	API Management サービスを削除します。	Core	GA
az apim deletedservice	論理的に削除された Azure API Management サービスを管理します。	Core	GA
az apim deletedservice list	特定のサブスクリプションの削除を取り消す際に使用できる、論理的に削除されたすべての Api Management サービスインスタンスを一覧表示します。	Core	GA
az apim deletedservice purge	論理的に削除された Api Management サービスインスタンスを消去します (削除を取り消すオプションなしで削除します)。	Core	GA
az apim deletedservice show	名前で削除を取り消して使用できる論理的に削除された Api Management サービスインスタンスを取得します。	Core	GA
az apim graphql	Azure API Management GraphQL API を管理します。	Core	GA
az apim graphql resolver	Azure API Management GraphQL API のリゾルバーを管理します。	Core	GA
az apim graphql resolver create	GraphQL API で新しいリゾルバーを作成するか、既存の競合回避モジュールを更新します。	Core	GA
az apim graphql resolver delete	GraphQL API で指定したリゾルバーを削除します。	Core	GA
az apim graphql resolver list	指定した GraphQL API のリゾルバーのコレクションを一覧表示します。	Core	GA
az apim graphql resolver policy	Azure API Management GraphQL API のリゾルバーポリシーを管理します。	Core	GA
az apim graphql resolver policy create	GraphQL API リゾルバーレベルのポリシー構成を作成または更新します。	Core	GA
az apim graphql resolver policy delete	GraphQL Api リゾルバーでポリシー構成を削除します。	Core	GA
az apim graphql resolver policy list	GraphQL API リゾルバーレベルでポリシー構成の一覧を取得します。	Core	GA
az apim graphql resolver policy show	GraphQL API リゾルバーレベルでポリシー構成を取得します。	Core	GA
az apim graphql resolver show	識別子で指定された GraphQL API リゾルバーの詳細を取得します。	Core	GA
az apim list	API Management サービスインスタンスを一覧表示します。	Core	GA
az apim nv	Azure API Management の名前付き値を管理します。	Core	GA
az apim nv create	API Management の名前付き値を作成します。	Core	GA
az apim nv delete	API Management の名前付き値を削除します。	Core	GA
az apim nv list	API Management の名前付き値を一覧表示します。	Core	GA
az apim nv show	API Management の名前付き値の詳細を表示します。	Core	GA
az apim nv show-secret	API Management の名前付き値のシークレットを取得します。	Core	GA
az apim nv update	API Management の名前付き値を更新します。	Core	GA
az apim nv wait	apim の名前付き値の条件が満たされるまで、CLI を待機状態にします。	Core	GA
az apim product	Azure API Management 製品を管理します。	Core	GA
az apim product api	Azure API Management 製品の API を管理します。	Core	GA
az apim product api add	指定した製品に API を追加します。	Core	GA
az apim product api check	識別子で指定された API エンティティが Product エンティティに関連付けられていることを確認します。	Core	GA
az apim product api delete	指定した製品から指定した API を削除します。	Core	GA
az apim product api list	製品に関連付けられている API のコレクションを一覧表示します。	Core	GA
az apim product create	製品を作成します。	Core	GA
az apim product delete	Delete product.	Core	GA
az apim product list	指定したサービスインスタンス内の製品のコレクションを一覧表示します。	Core	GA
az apim product show	識別子で指定された製品の詳細を取得します。	Core	GA
az apim product update	既存の製品の詳細を更新します。	Core	GA
az apim product wait	apim 製品の条件が満たされるまで、CLI を待機状態にします。	Core	GA
az apim restore	現在のサービスでApiManagementService_Backup操作を使用して作成された API Management サービスのバックアップを復元します。これは実行時間の長い操作であり、完了までに数分かかる場合があります。	Core	GA
az apim show	API Management サービスインスタンスの詳細を表示します。	Core	GA
az apim update	API Management サービスインスタンスを更新します。	Core	GA
az apim wait	APIM の条件が満たされるまで、CLI を待機状態にします。	Core	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

必須のパラメーター

--name -n

API Management サービスインスタンスの名前。

--resource-group -g

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--location -l

Location. 値のソース: az account list-locations az configure --defaults location=<location>を使用して、既定の場所を構成できます。

--no-wait

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

プロパティ	値
規定値:	False

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 apim backup

編集

特定の Azure ストレージアカウントへの API Management サービスのバックアップを作成します。これは実行時間の長い操作であり、完了までに数分かかる場合があります。

az apim backup --backup-name
               --container-name --storage-account-container
               --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==

必須のパラメーター

--backup-name

作成するバックアップファイルの名前。

--container-name --storage-account-container

バックアップの配置に使用するストレージアカウントコンテナーの名前。

--name -n

API Management サービスインスタンスの名前。

--resource-group -g

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

--storage-account-key

バックアップの配置に使用するストレージアカウントのアクセスキー。

プロパティ	値
Parameter group:	Storage Arguments

--storage-account-name

バックアップの配置に使用するストレージアカウントの名前。

プロパティ	値
Parameter group:	Storage Arguments

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

プロパティ	値
規定値:	False

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 apim check-name

編集

サービス名を使用できるかどうかを確認します。

az apim check-name --name

必須のパラメーター

--name -n

API Management サービスインスタンスの名前。

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 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

必須のパラメーター

--name -n

作成するサービスインスタンスの一意の名前。

名前は、ゲートウェイホスト名と同様に含まれるので、グローバルに一意である必要があります'' https://my-api-servicename.azure-api.net。 See examples.

--publisher-email

すべてのシステム通知を受信する電子メールアドレス。

--publisher-name

開発者ポータルと電子メール通知で使用する組織の名前。

--resource-group -g

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--disable-gateway

マスターリージョンのゲートウェイを無効にします。複数の場所にデプロイされた Api Management サービスに対してのみ有効です。

プロパティ	値
指定可能な値:	false, true

--enable-client-certificate

ゲートウェイに対する各要求にクライアント証明書を提示し、ゲートウェイのポリシーで証明書を認証できるようにします。

プロパティ	値
指定可能な値:	false, true

--enable-managed-identity

他の Azure リソースにアクセスするための API Management サービスのマネージド ID を作成します。従量課金 SKU サービスにのみ使用されます。

プロパティ	値
規定値:	False
指定可能な値:	false, true

--location -l

Location. 値のソース: az account list-locations az configure --defaults location=<location>を使用して、既定の場所を構成できます。

--no-wait

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

プロパティ	値
規定値:	False

--public-network-access

この API Management サービスに対してパブリックエンドポイントアクセスが許可されているかどうか。 true に設定すると、プライベートエンドポイントが排他的アクセス方法になります。

プロパティ	値
指定可能な値:	false, true

--sku-capacity

SKU のデプロイ済みユニットの数。

プロパティ	値
規定値:	1

--sku-name

API Management インスタンスの SKU。

プロパティ	値
規定値:	Developer
指定可能な値:	Basic, Consumption, Developer, Isolated, Premium, Standard

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--virtual-network -v

仮想ネットワークの種類。

プロパティ	値
規定値:	None
指定可能な値:	External, Internal, None

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 apim delete

編集

API Management サービスを削除します。

az apim delete --name
               --resource-group
               [--no-wait]
               [--yes]

例

API Management サービスを削除します。

az apim delete -n MyApim -g MyResourceGroup

必須のパラメーター

--name -n

API Management サービスインスタンスの名前。

--resource-group -g

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

プロパティ	値
規定値:	False

--yes -y

確認を求めないでください。

プロパティ	値
規定値:	False

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 apim list

編集

API Management サービスインスタンスを一覧表示します。

az apim list [--resource-group]

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 apim restore

編集

現在のサービスでApiManagementService_Backup操作を使用して作成された API Management サービスのバックアップを復元します。これは実行時間の長い操作であり、完了までに数分かかる場合があります。

az apim restore --backup-name
                --container-name --storage-account-container
                --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==

必須のパラメーター

--backup-name

復元するバックアップファイルの名前。

--container-name --storage-account-container

バックアップの取得元として使用されるストレージアカウントコンテナーの名前。

--name -n

API Management サービスインスタンスの名前。

--resource-group -g

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

--storage-account-key

バックアップの取得元として使用されるストレージアカウントのアクセスキー。

プロパティ	値
Parameter group:	Storage Arguments

--storage-account-name

バックアップの取得元として使用されるストレージアカウントの名前。

プロパティ	値
Parameter group:	Storage Arguments

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

プロパティ	値
規定値:	False

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 apim show

編集

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

az apim show --name
             --resource-group

必須のパラメーター

--name -n

API Management サービスインスタンスの名前。

--resource-group -g

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

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 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}]

必須のパラメーター

--name -n

API Management サービスインスタンスの名前。

--resource-group -g

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	[]

--disable-gateway

マスターリージョンのゲートウェイを無効にします。複数の場所にデプロイされた Api Management サービスに対してのみ有効です。

プロパティ	値
指定可能な値:	false, true

--enable-client-certificate

ゲートウェイに対する各要求にクライアント証明書を提示し、ゲートウェイのポリシーで証明書を認証できるようにします。

プロパティ	値
指定可能な値:	false, true

--enable-managed-identity

他の Azure リソースにアクセスするための API Management サービスのマネージド ID を作成します。従量課金 SKU サービスにのみ使用されます。

プロパティ	値
指定可能な値:	false, true

--force-string

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

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	False

--no-wait

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

プロパティ	値
規定値:	False

--public-network-access

プロパティ	値
指定可能な値:	false, true

--publisher-email

すべてのシステム通知を受信する電子メールアドレス。

--publisher-name

開発者ポータルと電子メール通知で使用する組織の名前。

--remove

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

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	[]

--set

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

プロパティ	値
Parameter group:	Generic Update Arguments
規定値:	[]

--sku-capacity

SKU のデプロイ済みユニットの数。

--sku-name

API Management インスタンスの SKU。

プロパティ	値
指定可能な値:	Basic, Consumption, Developer, Isolated, Premium, Standard

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--virtual-network -v

仮想ネットワークの種類。

プロパティ	値
指定可能な値:	External, Internal, None

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 apim wait

編集

APIM の条件が満たされるまで、CLI を待機状態にします。

az apim wait --name
             --resource-group
             [--created]
             [--custom]
             [--deleted]
             [--exists]
             [--interval]
             [--timeout]
             [--updated]

例

apim の条件が満たされるまで、CLI を待機状態にします。 (autogenerated)

az apim wait --created --name MyApim --resource-group MyResourceGroup

必須のパラメーター

--name -n

API Management サービスインスタンスの名前。

--resource-group -g

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

プロパティ	値
Parameter group:	Wait Condition Arguments

--deleted

削除されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--exists

リソースが存在するまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--interval

ポーリング間隔 (秒単位)。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	30

--timeout

最大待機時間 (秒単位)。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

グローバルパラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 apim

コマンド

az apim apply-network-updates

例

必須のパラメーター

省略可能のパラメーター

az apim backup

例

必須のパラメーター

省略可能のパラメーター

az apim check-name

必須のパラメーター

az apim create

例

必須のパラメーター

省略可能のパラメーター

az apim delete

例

必須のパラメーター

省略可能のパラメーター

az apim list

省略可能のパラメーター

az apim restore

例

必須のパラメーター

省略可能のパラメーター

az apim show

必須のパラメーター

az apim update

必須のパラメーター

省略可能のパラメーター

az apim wait

例

必須のパラメーター

省略可能のパラメーター

フィードバック