az network manager ipam-pool

Note

This reference is part of the virtual-network-manager extension for the Azure CLI (version 2.75.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 update

Update the 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 --network-manager-name
                                    --name --pool-name
                                    --resource-group
                                    [--acquire-policy-token]
                                    [--change-reference]
                                    [--description]
                                    [--display-name]
                                    [--if-match]
                                    [--location]
                                    [--max-allocation-size]
                                    [--min-allocation-size]
                                    [--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

--address-prefixes

List of IP address prefixes of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--manager-name --network-manager-name

The name of the network manager.

--name --pool-name -n

IP Address Manager Pool resource name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--description

Description of the resource.

Property Value
Parameter group: Properties Arguments
--display-name

String representing a friendly name for the resource.

Property Value
Parameter group: Properties Arguments
--if-match

The entity state (ETag) version of the pool to update. This value can be omitted or set to "*" to apply the operation unconditionally.

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property Value
Parameter group: Body Arguments
--max-allocation-size

Maximum number of IP addresses allowed for allocations from this IpamPool to be compliant. Must be greater than or equal to the minimum allocation size. If not specified or empty, no maximum is enforced.

Property Value
Parameter group: Properties Arguments
--min-allocation-size

Minimum number of IP addresses required for allocations from this IpamPool to be compliant. Must be less than or equal to the maximum allocation size. If not specified or empty, no minimum is enforced.

Property Value
Parameter group: Properties Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--parent-pool-name

String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.

Property Value
Parameter group: Properties Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network manager ipam-pool delete

Delete the Pool resource.

az network manager ipam-pool delete [--acquire-policy-token]
                                    [--change-reference]
                                    [--ids]
                                    [--if-match]
                                    [--manager-name --network-manager-name]
                                    [--name --pool-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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--if-match

The entity state (ETag) version of the pool to update. This value can be omitted or set to "*" to apply the operation unconditionally.

--manager-name --network-manager-name

The name of the network manager.

Property Value
Parameter group: Resource Id Arguments
--name --pool-name -n

Pool resource name.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network manager ipam-pool get-pool-usage

Get the Pool Usage.

az network manager ipam-pool get-pool-usage [--acquire-policy-token]
                                            [--change-reference]
                                            [--ids]
                                            [--manager-name --network-manager-name]
                                            [--name --pool-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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--manager-name --network-manager-name

The name of the network manager.

Property Value
Parameter group: Resource Id Arguments
--name --pool-name -n

Pool resource name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network manager ipam-pool list

List list of Pool resources at Network Manager level.

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]

Examples

IpamPools_List

az network manager ipam-pool list --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --subscription "00000000-0000-0000-0000-000000000000"

Required Parameters

--manager-name --network-manager-name

The name of the network manager.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

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

--max-items

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.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
--skip

Optional num entries to skip.

Property Value
Default value: 0
--skip-token

Optional skip token.

--sort-key

Optional key by which to sort.

--sort-value

Optional sort value for pagination.

--top

Optional num entries to show.

Property Value
Default value: 50
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network manager ipam-pool list-associated-resource

List Associated Resource in the Pool.

az network manager ipam-pool list-associated-resource --manager-name --network-manager-name
                                                      --name --pool-name
                                                      --resource-group
                                                      [--acquire-policy-token]
                                                      [--change-reference]
                                                      [--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

--manager-name --network-manager-name

The name of the network manager.

--name --pool-name -n

Pool resource name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--max-items

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.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network manager ipam-pool show

Get the specific Pool resource.

az network manager ipam-pool show [--ids]
                                  [--manager-name --network-manager-name]
                                  [--name --pool-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

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

--ids

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.

Property Value
Parameter group: Resource Id Arguments
--manager-name --network-manager-name

The name of the network manager.

Property Value
Parameter group: Resource Id Arguments
--name --pool-name -n

Pool resource name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network manager ipam-pool update

Update the Pool resource.

az network manager ipam-pool update [--acquire-policy-token]
                                    [--add]
                                    [--address-prefixes]
                                    [--change-reference]
                                    [--description]
                                    [--display-name]
                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--ids]
                                    [--if-match]
                                    [--manager-name --network-manager-name]
                                    [--max-allocation-size]
                                    [--min-allocation-size]
                                    [--name --pool-name]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--parent-pool-name]
                                    [--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--add

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>.

Property Value
Parameter group: Generic Update Arguments
--address-prefixes

List of IP address prefixes of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--description

Description of the resource.

Property Value
Parameter group: Properties Arguments
--display-name

String representing a friendly name for the resource.

Property Value
Parameter group: Properties Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--if-match

The entity state (ETag) version of the pool to update. This value can be omitted or set to "*" to apply the operation unconditionally.

--manager-name --network-manager-name

The name of the network manager.

Property Value
Parameter group: Resource Id Arguments
--max-allocation-size

Maximum number of IP addresses allowed for allocations from this IpamPool. Must be greater than or equal to the minimum allocation size. Omit to leave the current value unchanged; pass an empty string to clear it.

Property Value
Parameter group: Properties Arguments
--min-allocation-size

Minimum number of IP addresses allowed for allocations from this IpamPool. Must be less than or equal to the maximum allocation size. Omit to leave the current value unchanged; pass an empty string to clear it.

Property Value
Parameter group: Properties Arguments
--name --pool-name -n

Pool resource name.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--parent-pool-name

String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.

Property Value
Parameter group: Properties Arguments
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network manager ipam-pool wait

Place the CLI in a waiting state until a condition is met.

az network manager ipam-pool wait [--acquire-policy-token]
                                  [--change-reference]
                                  [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--ids]
                                  [--interval]
                                  [--manager-name --network-manager-name]
                                  [--name --pool-name]
                                  [--resource-group]
                                  [--subscription]
                                  [--timeout]
                                  [--updated]

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--manager-name --network-manager-name

The name of the network manager.

Property Value
Parameter group: Resource Id Arguments
--name --pool-name -n

Pool resource name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False