Public IP Prefixes - Create Or Update
Creates or updates a static or dynamic public IP prefix.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}?api-version=2024-05-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
public
|
path | True |
string |
The name of the public IP prefix. |
resource
|
path | True |
string |
The name of the resource group. |
subscription
|
path | True |
string |
The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Client API version. |
Request Body
Name | Type | Description |
---|---|---|
extendedLocation |
The extended location of the public ip address. |
|
id |
string |
Resource ID. |
location |
string |
Resource location. |
properties.customIPPrefix |
The customIpPrefix that this prefix is associated with. |
|
properties.ipTags |
Ip |
The list of tags associated with the public IP prefix. |
properties.natGateway |
NatGateway of Public IP Prefix. |
|
properties.prefixLength |
integer (int32) |
The Length of the Public IP Prefix. |
properties.publicIPAddressVersion |
The public IP address version. |
|
sku |
The public IP prefix SKU. |
|
tags |
object |
Resource tags. |
zones |
string[] |
A list of availability zones denoting the IP allocated for the resource needs to come from. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Update successful. The operation returns the resulting PublicIPPrefix resource. |
|
201 Created |
Create successful. The operation returns the resulting PublicIPPrefix resource. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Create public IP prefix allocation method |
Create public IP prefix defaults |
Create public IP prefix allocation method
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix?api-version=2024-05-01
{
"location": "westus",
"properties": {
"publicIPAddressVersion": "IPv4",
"prefixLength": 30
},
"sku": {
"name": "Standard",
"tier": "Regional"
}
}
Sample response
{
"name": "test-ipprefix",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix",
"etag": "W/\"00000000-0000-0000-0000-00000000\"",
"location": "westus",
"zones": [
"1"
],
"properties": {
"provisioningState": "Succeeded",
"resourceGuid": "00000000-0000-0000-0000-00000000",
"publicIPAddressVersion": "IPv4",
"prefixLength": 30,
"ipPrefix": "192.168.254.2/30",
"ipTags": []
},
"sku": {
"name": "Standard",
"tier": "Regional"
},
"type": "Microsoft.Network/publicIPPrefixes"
}
{
"name": "test-ipprefix",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ipprefix",
"etag": "W/\"00000000-0000-0000-0000-00000000\"",
"location": "westus",
"zones": [
"1"
],
"properties": {
"provisioningState": "Succeeded",
"resourceGuid": "00000000-0000-0000-0000-00000000",
"publicIPAddressVersion": "IPv4",
"prefixLength": 30,
"ipPrefix": "192.168.254.2/30",
"ipTags": []
},
"sku": {
"name": "Standard",
"tier": "Regional"
},
"type": "Microsoft.Network/publicIPPrefixes"
}
Create public IP prefix defaults
Sample request
Sample response
{
"name": "test-ipprefix",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix",
"etag": "W/\"00000000-0000-0000-0000-00000000\"",
"location": "westus",
"properties": {
"provisioningState": "Succeeded",
"resourceGuid": "00000000-0000-0000-0000-00000000",
"publicIPAddressVersion": "IPv4",
"prefixLength": 30,
"ipPrefix": "192.168.254.2/30",
"ipTags": []
},
"sku": {
"name": "Standard"
},
"type": "Microsoft.Network/publicIPPrefixes"
}
{
"name": "test-ipprefix",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix",
"etag": "W/\"00000000-0000-0000-0000-00000000\"",
"location": "westus",
"properties": {
"provisioningState": "Succeeded",
"resourceGuid": "00000000-0000-0000-0000-00000000",
"publicIPAddressVersion": "IPv4",
"prefixLength": 30,
"ipPrefix": "192.168.254.2/30",
"ipTags": []
},
"sku": {
"name": "Standard"
},
"type": "Microsoft.Network/publicIPPrefixes"
}
Definitions
Name | Description |
---|---|
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
Extended |
ExtendedLocation complex type. |
Extended |
The type of the extended location. |
Ip |
Contains the IpTag associated with the object. |
IPVersion |
IP address version. |
Nat |
Nat Gateway resource. |
Nat |
SKU of nat gateway. |
Nat |
Name of Nat Gateway SKU. |
Provisioning |
The current provisioning state. |
Public |
Public IP prefix resource. |
Public |
SKU of a public IP prefix. |
Public |
Name of a public IP prefix SKU. |
Public |
Tier of a public IP prefix SKU. |
Referenced |
Reference to a public IP address. |
Sub |
Reference to another subresource. |
CloudError
An error response from the service.
Name | Type | Description |
---|---|---|
error |
Cloud error body. |
CloudErrorBody
An error response from the service.
Name | Type | Description |
---|---|---|
code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
details |
A list of additional details about the error. |
|
message |
string |
A message describing the error, intended to be suitable for display in a user interface. |
target |
string |
The target of the particular error. For example, the name of the property in error. |
ExtendedLocation
ExtendedLocation complex type.
Name | Type | Description |
---|---|---|
name |
string |
The name of the extended location. |
type |
The type of the extended location. |
ExtendedLocationTypes
The type of the extended location.
Value | Description |
---|---|
EdgeZone |
IpTag
Contains the IpTag associated with the object.
Name | Type | Description |
---|---|---|
ipTagType |
string |
The IP tag type. Example: FirstPartyUsage. |
tag |
string |
The value of the IP tag associated with the public IP. Example: SQL. |
IPVersion
IP address version.
Value | Description |
---|---|
IPv4 | |
IPv6 |
NatGateway
Nat Gateway resource.
Name | Type | Description |
---|---|---|
etag |
string |
A unique read-only string that changes whenever the resource is updated. |
id |
string |
Resource ID. |
location |
string |
Resource location. |
name |
string |
Resource name. |
properties.idleTimeoutInMinutes |
integer (int32) |
The idle timeout of the nat gateway. |
properties.provisioningState |
The provisioning state of the NAT gateway resource. |
|
properties.publicIpAddresses |
An array of public ip addresses associated with the nat gateway resource. |
|
properties.publicIpPrefixes |
An array of public ip prefixes associated with the nat gateway resource. |
|
properties.resourceGuid |
string |
The resource GUID property of the NAT gateway resource. |
properties.subnets |
An array of references to the subnets using this nat gateway resource. |
|
sku |
The nat gateway SKU. |
|
tags |
object |
Resource tags. |
type |
string |
Resource type. |
zones |
string[] |
A list of availability zones denoting the zone in which Nat Gateway should be deployed. |
NatGatewaySku
SKU of nat gateway.
Name | Type | Description |
---|---|---|
name |
Name of Nat Gateway SKU. |
NatGatewaySkuName
Name of Nat Gateway SKU.
Value | Description |
---|---|
Standard |
ProvisioningState
The current provisioning state.
Value | Description |
---|---|
Deleting | |
Failed | |
Succeeded | |
Updating |
PublicIPPrefix
Public IP prefix resource.
Name | Type | Description |
---|---|---|
etag |
string |
A unique read-only string that changes whenever the resource is updated. |
extendedLocation |
The extended location of the public ip address. |
|
id |
string |
Resource ID. |
location |
string |
Resource location. |
name |
string |
Resource name. |
properties.customIPPrefix |
The customIpPrefix that this prefix is associated with. |
|
properties.ipPrefix |
string |
The allocated Prefix. |
properties.ipTags |
Ip |
The list of tags associated with the public IP prefix. |
properties.loadBalancerFrontendIpConfiguration |
The reference to load balancer frontend IP configuration associated with the public IP prefix. |
|
properties.natGateway |
NatGateway of Public IP Prefix. |
|
properties.prefixLength |
integer (int32) |
The Length of the Public IP Prefix. |
properties.provisioningState |
The provisioning state of the public IP prefix resource. |
|
properties.publicIPAddressVersion |
The public IP address version. |
|
properties.publicIPAddresses |
The list of all referenced PublicIPAddresses. |
|
properties.resourceGuid |
string |
The resource GUID property of the public IP prefix resource. |
sku |
The public IP prefix SKU. |
|
tags |
object |
Resource tags. |
type |
string |
Resource type. |
zones |
string[] |
A list of availability zones denoting the IP allocated for the resource needs to come from. |
PublicIPPrefixSku
SKU of a public IP prefix.
Name | Type | Description |
---|---|---|
name |
Name of a public IP prefix SKU. |
|
tier |
Tier of a public IP prefix SKU. |
PublicIPPrefixSkuName
Name of a public IP prefix SKU.
Value | Description |
---|---|
Standard |
PublicIPPrefixSkuTier
Tier of a public IP prefix SKU.
Value | Description |
---|---|
Global | |
Regional |
ReferencedPublicIpAddress
Reference to a public IP address.
Name | Type | Description |
---|---|---|
id |
string |
The PublicIPAddress Reference. |
SubResource
Reference to another subresource.
Name | Type | Description |
---|---|---|
id |
string |
Resource ID. |