az network manager ipam-pool static-cidr

  • Preview
  • Reference

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 static-cidr command. Learn more about extensions.

Command group 'az network manager ipam-pool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage static cidr with network.

Commands

Name Description Type Status
az network manager ipam-pool static-cidr create

Create the Static CIDR resource.

 Extension Preview
az network manager ipam-pool static-cidr delete

Delete the Static CIDR resource.

 Extension Preview
az network manager ipam-pool static-cidr list

List list of Static CIDR resources at Network Manager level.

 Extension Preview
az network manager ipam-pool static-cidr show

Get the specific Static CIDR resource.

 Extension Preview
az network manager ipam-pool static-cidr wait

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

 Extension Preview

az network manager ipam-pool static-cidr create

Preview

Command group 'az network manager ipam-pool static-cidr' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create the Static CIDR resource.

az network manager ipam-pool static-cidr create --manager-name
                                                --name
                                                --pool-name
                                                --resource-group
                                                [--address-prefixes]
                                                [--allocate]
                                                [--description]

Examples

StaticCidrs_Create

az network manager ipam-pool static-cidr create --name "myStaticCidr" --pool-name "myIpamPool" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --subscription "00000000-0000-0000-0000-000000000000" --address-prefixes "['10.0.0.0/24']" --number-of-ip-addresses-to-allocate "256" --description "New Static Cidr Description"

Required Parameters

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

The name of the network manager.

--name --static-cidr-name -n

Static Cidr allocation name.

--pool-name

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

--address-prefixes

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

--allocate --number-of-ip-addresses-to-allocate -a

Number of IP addresses to allocate for a static CIDR resource. The IP addresses will be assigned based on IpamPools available space.

--description

Description of the resource.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network manager ipam-pool static-cidr delete

Preview

Command group 'az network manager ipam-pool static-cidr' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the Static CIDR resource.

az network manager ipam-pool static-cidr delete [--ids]
                                                [--manager-name]
                                                [--name]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--pool-name]
                                                [--resource-group]
                                                [--subscription]
                                                [--yes]

Examples

StaticCidrs_Delete

az network manager ipam-pool static-cidr delete --name "myStaticCidr" --pool-name "myIpamPool" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --subscription "00000000-0000-0000-0000-000000000000"

Optional Parameters

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

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

The name of the network manager.

--name --static-cidr-name -n

StaticCidr resource name to delete.

--no-wait

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

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

Pool resource name.

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network manager ipam-pool static-cidr list

Preview

Command group 'az network manager ipam-pool static-cidr' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List list of Static CIDR resources at Network Manager level.

az network manager ipam-pool static-cidr list --manager-name
                                              --pool-name
                                              --resource-group
                                              [--max-items]
                                              [--next-token]
                                              [--skip]
                                              [--skip-token]
                                              [--sort-key]
                                              [--sort-value]
                                              [--top]

Examples

StaticCidrs_List

az network manager ipam-pool static-cidr list --pool-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.

--pool-name

Pool resource name.

--resource-group -g

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

Optional Parameters

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

--next-token

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

--skip

Optional num entries to skip.

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.

Default value: 50
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network manager ipam-pool static-cidr show

Preview

Command group 'az network manager ipam-pool static-cidr' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the specific Static CIDR resource.

az network manager ipam-pool static-cidr show [--ids]
                                              [--manager-name]
                                              [--name]
                                              [--pool-name]
                                              [--resource-group]
                                              [--subscription]

Examples

StaticCidrs_Get

az network manager ipam-pool static-cidr show --name "myStaticCidr" --pool-name "myIpamPool" --network-manager-name "myAVNM" --resource-group "myAVNMResourceGroup" --subscription "00000000-0000-0000-0000-000000000000"

Optional Parameters

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

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

The name of the network manager.

--name --static-cidr-name -n

StaticCidr resource name to retrieve.

--pool-name

Pool resource name.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network manager ipam-pool static-cidr wait

Preview

Command group 'az network manager ipam-pool static-cidr' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az network manager ipam-pool static-cidr wait [--created]
                                              [--custom]
                                              [--deleted]
                                              [--exists]
                                              [--ids]
                                              [--interval]
                                              [--manager-name]
                                              [--name]
                                              [--pool-name]
                                              [--resource-group]
                                              [--subscription]
                                              [--timeout]
                                              [--updated]

Optional Parameters

--created

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

Default value: 30
--manager-name --network-manager-name

The name of the network manager.

--name --static-cidr-name -n

StaticCidr resource name to retrieve.

--pool-name

Pool resource name.

--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.