Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az network public-ip prefix

Manage public IP prefix resources.

Commands

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

az network public-ip prefix create

Edit

Create a public IP prefix resource.

az network public-ip prefix create --name
 --resource-group
 [--acquire-policy-token]
 [--change-reference]
 [--custom-ip-prefix-name]
 [--edge-zone]
 [--ip-tags]
 [--length]
 [--location]
 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
 [--sku {Standard, StandardV2}]
 [--tags]
 [--tier {Global, Regional}]
 [--version {IPv4, IPv6}]
 [--zone]

Examples

Create a public IP prefix resource. (autogenerated)

az network public-ip prefix create --length 28 --location westus2 --name MyPublicIPPrefix --resource-group MyResourceGroup

Required Parameters

--name -n

The name of the public IP prefix.

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

--custom-ip-prefix-name

A custom prefix from which the public prefix derived. If you'd like to cross subscription, please use Resource ID instead.

--edge-zone

The name of edge zone.

--ip-tags

The list of tags associated with the public IP prefix in 'TYPE=VAL' format. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--length

Length of the prefix (i.e. XX.XX.XX.XX/<Length>).

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

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

--sku

Name of a public IP prefix SKU.

Property	Value
Parameter group:	Sku Arguments
Default value:	Standard
Accepted values:	Standard, StandardV2

--tags

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

--tier

Tier of a public IP prefix SKU.

Property	Value
Accepted values:	Global, Regional

--version

IP address type. Allowed values: IPv4, IPv6.

Property	Value
Default value:	IPv4
Accepted values:	IPv4, IPv6

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

az network public-ip prefix delete

Edit

Delete a public IP prefix resource.

az network public-ip prefix delete [--acquire-policy-token]
 [--change-reference]
 [--ids]
 [--name]
 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
 [--resource-group]
 [--subscription]

Examples

Delete a public IP prefix resource. (autogenerated)

az network public-ip prefix delete --name MyPublicIPPrefix --resource-group MyResourceGroup

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

--name -n

The name of the public IP prefix.

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

az network public-ip prefix list

Edit

List public IP prefix resources.

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

Examples

List public IP prefix resource.

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

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

--resource-group -g

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

az network public-ip prefix show

Edit

Get the details of a public IP prefix resource.

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

Examples

Get the details of a public IP prefix resource. (autogenerated)

az network public-ip prefix show --name MyPublicIPPrefix --resource-group MyResourceGroup --subscription MySubscription

Optional Parameters

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

--expand

Expands referenced resources.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The name of the public IP prefix.

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

az network public-ip prefix update

Edit

Update a public IP prefix resource.

az network public-ip prefix update [--acquire-policy-token]
 [--add]
 [--change-reference]
 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
 [--ids]
 [--name]
 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
 [--remove]
 [--resource-group]
 [--set]
 [--subscription]
 [--tags]

Examples

Update a public IP prefix resource. (autogenerated)

az network public-ip prefix update --name MyPublicIPPrefix --resource-group MyResourceGroup --set useRemoteGateways=true

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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy 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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The name of the public IP prefix.

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

--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:	Parameters Arguments

az network public-ip prefix wait

Edit

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

az network public-ip prefix wait [--acquire-policy-token]
 [--change-reference]
 [--created]
 [--custom]
 [--deleted]
 [--exists]
 [--expand]
 [--ids]
 [--interval]
 [--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

--expand

Expands referenced resources.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name -n

The name of the public IP prefix.

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

Feedback

Was this page helpful?

URL: https://learn.microsoft.com/en-us/cli/azure/network/public-ip/prefix?view=azure-cli-latest

⇱ az network public-ip prefix | Microsoft Learn

az network public-ip prefix

Commands

az network public-ip prefix create

Examples

Required Parameters

Optional Parameters

az network public-ip prefix delete

Examples

Optional Parameters

az network public-ip prefix list

Examples

Optional Parameters

az network public-ip prefix show

Examples

Optional Parameters

az network public-ip prefix update

Examples

Optional Parameters

az network public-ip prefix wait

Optional Parameters

Feedback