Del via

az network custom-ip prefix

  • Reference

Manage custom IP prefix resources.

Commands

Name Description Type Status
az network custom-ip prefix create

Create a custom IP prefix resource.

 Core GA
az network custom-ip prefix delete

Delete a custom IP prefix resource.

 Core GA
az network custom-ip prefix list

List custom IP prefix resources.

 Core GA
az network custom-ip prefix show

Get the details of a custom IP prefix resource.

 Core GA
az network custom-ip prefix update

Update a custom IP prefix resource.

 Core GA
az network custom-ip prefix wait

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

 Core GA

az network custom-ip prefix create

Edit

Create a custom IP prefix resource.

az network custom-ip prefix create --name
                                   --resource-group
                                   [--asn]
                                   [--authorization-message]
                                   [--cidr]
                                   [--cip-prefix-parent]
                                   [--express-route-advertise {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--geo {AFRI, APAC, AQ, EURO, GLOBAL, LATAM, ME, NAM, OCEANIA}]
                                   [--is-parent {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--location]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--prefix-type {Child, Parent, Singular}]
                                   [--signed-message]
                                   [--tags]
                                   [--zone]

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

--asn

The ASN for CIDR advertising. Should be an integer as string.

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

--express-route-advertise --is-advertised

Whether to do express route advertise.

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

The Geo for CIDR advertising. Should be an Geo code.

Accepted values: AFRI, APAC, AQ, EURO, GLOBAL, LATAM, ME, NAM, OCEANIA
--is-parent

Denotes that resource is being created as a Parent CustomIpPrefix.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--prefix-type

Type of custom IP prefix. Should be Singular, Parent, or Child.

Accepted values: Child, Parent, Singular
--signed-message

Signed message for WAN validation.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--zone -z

Space-separated list of availability zones into which to provision the resource. Allowed values: 1, 2, 3. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Edit

Delete a custom IP prefix resource.

az network custom-ip prefix delete [--ids]
                                   [--name]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--resource-group]
                                   [--subscription]

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.

--no-wait

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

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

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

Edit

List custom IP prefix resources.

az network custom-ip prefix list [--max-items]
                                 [--next-token]
                                 [--resource-group]

Examples

List custom IP prefix resources.

az network custom-ip prefix list --resource-group MyResourceGroup

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.

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

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

Edit

Get the details of a custom IP prefix resource.

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

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

Expand referenced resources. Default value is None.

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

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

Edit

Update a custom IP prefix resource.

az network custom-ip prefix update [--add]
                                   [--authorization-message]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--name]
                                   [--no-internet-advertise {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--remove]
                                   [--resource-group]
                                   [--set]
                                   [--signed-message]
                                   [--state {commission, decommission, deprovision, provision}]
                                   [--subscription]
                                   [--tags]

Examples

Update a custom IP prefix resource.

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

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.

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.

--name -n

The name of the custom IP prefix.

--no-internet-advertise

Whether to Advertise the range to Internet.

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

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

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

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> 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=<value>.

--signed-message

Signed message for WAN validation.

--state

Commissioned State of the custom ip prefix.

Accepted values: commission, decommission, deprovision, provision
--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Edit

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

az network custom-ip prefix wait [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--expand]
                                 [--ids]
                                 [--interval]
                                 [--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
--expand

Expand referenced resources. Default value is None.

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

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