az network manager ipam-pool
Note
このリファレンスは、Azure CLI (バージョン 2.75.0 以降) の virtual-network-manager 拡張機能の一部です。 拡張機能は、az network manager ipam-pool コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
ネットワークを使用して IPAM プールを管理します。
コマンド
az network manager ipam-pool create
プール リソースを作成します。
az network manager ipam-pool create --address-prefixes
--manager-name --network-manager-name
--name --pool-name
--resource-group
[--description]
[--display-name]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--parent-pool-name]
[--tags]
例
IpamPools_Create
az network manager ipam-pool create --name "myIpamPool" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --address-prefixes "['10.0.0.0/16', '10.1.0.0/16']" --parent-pool-name "myParentIpamPool" --display-name "myIpamPoolDisplayName" --description "New Description"
必須のパラメーター
リソースの IP アドレス プレフィックスの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
ネットワーク マネージャーの名前。
IP アドレス マネージャー プールリソース名。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
リソースの説明。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
リソースのフレンドリ名を表す文字列。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
リソースが存在する地理的な場所 を指定しない場合は、リソース グループの場所が使用されます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Body Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
親 IpamPool リソース名を表す文字列。 空の場合、IpamPool はルート プールになります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Body Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network manager ipam-pool delete
プール リソースを削除します。
az network manager ipam-pool delete [--ids]
[--manager-name --network-manager-name]
[--name --pool-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
例
IpamPools_Delete
az network manager ipam-pool delete --name "myIpamPool" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup"
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
ネットワーク マネージャーの名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
プール リソース名。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
確認を求めないでください。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network manager ipam-pool get-pool-usage
プールの使用状況を取得します。
az network manager ipam-pool get-pool-usage [--ids]
[--manager-name --network-manager-name]
[--name --pool-name]
[--resource-group]
[--subscription]
例
IpamPools_GetPoolUsage
az network manager ipam-pool get-pool-usage --name "myIpamPool" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --subscription "00000000-0000-0000-0000-000000000000"
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
ネットワーク マネージャーの名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
プール リソース名。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network manager ipam-pool list
ネットワーク マネージャー レベルのプール リソースの一覧を表示します。
az network manager ipam-pool list --manager-name --network-manager-name
--resource-group
[--max-items]
[--next-token]
[--skip]
[--skip-token]
[--sort-key]
[--sort-value]
[--top]
例
IpamPools_List
az network manager ipam-pool list --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --subscription "00000000-0000-0000-0000-000000000000"
必須のパラメーター
ネットワーク マネージャーの名前。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Pagination Arguments |
ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Pagination Arguments |
省略可能なスキップするエントリ数。
| プロパティ | 値 |
|---|---|
| 規定値: | 0 |
省略可能なスキップ トークン。
並べ替えに使用する省略可能なキー。
改ページ位置のオプションの並べ替え値。
表示するオプションの num エントリ。
| プロパティ | 値 |
|---|---|
| 規定値: | 50 |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network manager ipam-pool list-associated-resource
プール内の関連付けられているリソースを一覧表示します。
az network manager ipam-pool list-associated-resource --manager-name --network-manager-name
--name --pool-name
--resource-group
[--max-items]
[--next-token]
例
IpamPools_ListAssociatedResources
az network manager ipam-pool list-associated-resource --name "myIpamPool" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --subscription "00000000-0000-0000-0000-000000000000"
必須のパラメーター
ネットワーク マネージャーの名前。
プール リソース名。
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Pagination Arguments |
ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Pagination Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network manager ipam-pool show
特定のプール リソースを取得します。
az network manager ipam-pool show [--ids]
[--manager-name --network-manager-name]
[--name --pool-name]
[--resource-group]
[--subscription]
例
IpamPools_Get
az network manager ipam-pool show --name "myIpamPool" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --subscription "00000000-0000-0000-0000-000000000000"
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
ネットワーク マネージャーの名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
プール リソース名。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network manager ipam-pool update
プール リソースを更新します。
az network manager ipam-pool update [--add]
[--address-prefixes]
[--description]
[--display-name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--if-match]
[--manager-name --network-manager-name]
[--name --pool-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--parent-pool-name]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]
例
IpamPools_Update
az network manager ipam-pool update --name "myIpamPool" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --subscription "00000000-0000-0000-0000-000000000000" --display-name "myIpamPoolDisplayName" --description --address-prefixes "['10.0.0.0/16']" "New Description" --tags ""
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
リソースの IP アドレス プレフィックスの一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
リソースの説明。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
リソースのフレンドリ名を表す文字列。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
更新するプールのエンティティ状態 (ETag) バージョン。 操作を無条件に適用するには、この値を省略するか、"*" に設定できます。
ネットワーク マネージャーの名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
プール リソース名。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
親 IpamPool リソース名を表す文字列。 空の場合、IpamPool はルート プールになります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Properties Arguments |
リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Generic Update Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Body Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az network manager ipam-pool wait
条件が満たされるまで CLI を待機状態にします。
az network manager ipam-pool wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--manager-name --network-manager-name]
[--name --pool-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
削除されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
リソースが存在するまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
ポーリング間隔 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 30 |
ネットワーク マネージャーの名前。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
プール リソース名。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Resource Id Arguments |
最大待機時間 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 3600 |
provisioningState が 'Succeeded' で更新されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |