az network custom-ip prefix

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Manage custom IP prefix resources.

Commands

az network custom-ip prefix create	Create a custom IP prefix resource.
az network custom-ip prefix delete	Delete a custom IP prefix resource.
az network custom-ip prefix list	List custom IP prefix resources.
az network custom-ip prefix show	Get the details of a custom IP prefix resource.
az network custom-ip prefix update	Update a custom IP prefix resource.
az network custom-ip prefix wait	Place the CLI in a waiting state until a condition of the custom ip prefix is met.

az network custom-ip prefix create

Create a custom IP prefix resource.

az network custom-ip prefix create --name
                                   --resource-group
                                   [--authorization-message]
                                   [--cidr]
                                   [--cip-prefix-parent]
                                   [--location]
                                   [--no-wait]
                                   [--signed-message]
                                   [--tags]
                                   [--zone {1, 2, 3}]

Examples

Create a custom IP prefix resource.

az network custom-ip prefix create --location westus2 --name MyCustomIpPrefix --resource-group MyResourceGroup

Required Parameters

--name -n

The name of the custom IP prefix.

--resource-group -g

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

Optional Parameters

--authorization-message

Authorization message for WAN validation.

--cidr

The prefix range in CIDR notation. Should include the start address and the prefix length.

--cip-prefix-parent -c

The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

--signed-message

Signed message for WAN validation.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--zone -z

Space-separated list of availability zones into which to provision the resource.

accepted values: 1, 2, 3

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.

--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 custom-ip prefix delete

Delete a custom IP prefix resource.

az network custom-ip prefix delete [--ids]
                                   [--name]
                                   [--resource-group]

Examples

Delete a custom IP prefix resource.

az network custom-ip prefix delete --name MyCustomIpPrefix --resource-group MyResourceGroup

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.

--name -n

The name of the custom IP prefix.

--resource-group -g

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

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.

--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 custom-ip prefix list

List custom IP prefix resources.

az network custom-ip prefix list [--resource-group]

Optional Parameters

--resource-group -g

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

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.

--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 custom-ip prefix show

Get the details of a custom IP prefix resource.

az network custom-ip prefix show [--expand]
                                 [--ids]
                                 [--name]
                                 [--resource-group]

Examples

Get the details of a custom IP prefix resource.

az network custom-ip prefix show --name MyCustomIpPrefix --resource-group MyResourceGroup --subscription MySubscription

Optional Parameters

--expand

Expands referenced resources.

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

--name -n

The name of the custom IP prefix.

--resource-group -g

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

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.

--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 custom-ip prefix update

Update a custom IP prefix resource.

az network custom-ip prefix update [--add]
                                   [--authorization-message]
                                   [--force-string]
                                   [--ids]
                                   [--name]
                                   [--no-wait]
                                   [--remove]
                                   [--resource-group]
                                   [--set]
                                   [--signed-message]
                                   [--state {commission, decommission, deprovision, provision}]
                                   [--tags]

Examples

Update a custom IP prefix resource.

az network custom-ip prefix update --name MyCustomIpPrefix --resource-group MyResourceGroup --tags foo=doo

Optional Parameters

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

--authorization-message

Authorization message for WAN validation.

--force-string

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

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

--name -n

The name of the custom IP prefix.

--no-wait

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

--remove

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

--resource-group -g

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

--set

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

--signed-message

Signed message for WAN validation.

--state

Commissioned State of the custom ip prefix.

accepted values: commission, decommission, deprovision, provision

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.

--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 custom-ip prefix wait

Place the CLI in a waiting state until a condition of the custom ip prefix is met.

az network custom-ip prefix wait [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--expand]
                                 [--ids]
                                 [--interval]
                                 [--name]
                                 [--resource-group]
                                 [--timeout]
                                 [--updated]

Examples

Wait for custom ip prefix to return as created.

az network custom-ip prefix wait --name MyCustomIpPrefix --resource-group MyResourceGroup --created

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--expand

Expands referenced resources.

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

--name -n

The name of the custom IP prefix.

--resource-group -g

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

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

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.

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