az network manager ipam-pool
Note
This reference is part of the virtual-network-manager extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az network manager ipam-pool command. Learn more about extensions.
Manage IPAM pool with network.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az network manager ipam-pool create |
Create the Pool resource. |
Extension | GA |
| az network manager ipam-pool delete |
Delete the Pool resource. |
Extension | GA |
| az network manager ipam-pool get-pool-usage |
Get the Pool Usage. |
Extension | GA |
| az network manager ipam-pool list |
List list of Pool resources at Network Manager level. |
Extension | GA |
| az network manager ipam-pool list-associated-resource |
List Associated Resource in the Pool. |
Extension | GA |
| az network manager ipam-pool show |
Get the specific Pool resource. |
Extension | GA |
| az network manager ipam-pool static-cidr |
Manage static cidr with network. |
Extension | GA |
| az network manager ipam-pool static-cidr create |
Create the Static CIDR resource. |
Extension | GA |
| az network manager ipam-pool static-cidr delete |
Delete the Static CIDR resource. |
Extension | GA |
| az network manager ipam-pool static-cidr list |
List list of Static CIDR resources at Network Manager level. |
Extension | GA |
| az network manager ipam-pool static-cidr show |
Get the specific Static CIDR resource. |
Extension | GA |
| az network manager ipam-pool static-cidr wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az network manager ipam-pool update |
Update the Pool resource. |
Extension | GA |
| az network manager ipam-pool wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az network manager ipam-pool create
Create the Pool resource.
az network manager ipam-pool create --address-prefixes
--manager-name
--name
--resource-group
[--description]
[--display-name]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--parent-pool-name]
[--tags]Examples
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"Required Parameters
List of IP address prefixes of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the network manager.
IP Address Manager Pool resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Description of the resource.
String representing a friendly name for the resource.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network manager ipam-pool delete
Delete the Pool resource.
az network manager ipam-pool delete [--ids]
[--manager-name]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]Examples
IpamPools_Delete
az network manager ipam-pool delete --name "myIpamPool" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup"Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the network manager.
Pool resource name.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network manager ipam-pool get-pool-usage
Get the Pool Usage.
az network manager ipam-pool get-pool-usage [--ids]
[--manager-name]
[--name]
[--resource-group]
[--subscription]Examples
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"Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the network manager.
Pool resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network manager ipam-pool list
List list of Pool resources at Network Manager level.
az network manager ipam-pool list --manager-name
--resource-group
[--max-items]
[--next-token]
[--skip]
[--skip-token]
[--sort-key]
[--sort-value]
[--top]Examples
IpamPools_List
az network manager ipam-pool list --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --subscription "00000000-0000-0000-0000-000000000000"Required Parameters
The name of the network manager.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Optional num entries to skip.
Optional skip token.
Optional key by which to sort.
Optional sort value for pagination.
Optional num entries to show.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network manager ipam-pool list-associated-resource
List Associated Resource in the Pool.
az network manager ipam-pool list-associated-resource --manager-name
--name
--resource-group
[--max-items]
[--next-token]Examples
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"Required Parameters
The name of the network manager.
Pool resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network manager ipam-pool show
Get the specific Pool resource.
az network manager ipam-pool show [--ids]
[--manager-name]
[--name]
[--resource-group]
[--subscription]Examples
IpamPools_Get
az network manager ipam-pool show --name "myIpamPool" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --subscription "00000000-0000-0000-0000-000000000000"Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the network manager.
Pool resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network manager ipam-pool update
Update the Pool resource.
az network manager ipam-pool update [--add]
[--description]
[--display-name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--manager-name]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]Examples
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 "New Description" --tags ""Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
Description of the resource.
String representing a friendly name for the resource.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the network manager.
Pool resource name.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network manager ipam-pool wait
Place the CLI in a waiting state until a condition is met.
az network manager ipam-pool wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--manager-name]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
The name of the network manager.
Pool resource name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
