Microsoft.Network publicIPPrefixes template reference
-
- 2 minutes to read
-
To create a Microsoft.Network/publicIPPrefixes resource, add the following JSON to the resources section of your template.
{
"name": "string",
"type": "Microsoft.Network/publicIPPrefixes",
"apiVersion": "2019-08-01",
"location": "string",
"tags": {},
"sku": {
"name": "Standard"
},
"properties": {
"publicIPAddressVersion": "string",
"ipTags": [
{
"ipTagType": "string",
"tag": "string"
}
],
"prefixLength": "integer",
"ipPrefix": "string",
"publicIPAddresses": [
{
"id": "string"
}
],
"resourceGuid": "string"
},
"zones": [
"string"
]
}
Property values
The following tables describe the values you need to set in the schema.
Microsoft.Network/publicIPPrefixes object
Name |
Type |
Required |
Value |
name |
string |
Yes |
The name of the public IP prefix. |
type |
enum |
Yes |
Microsoft.Network/publicIPPrefixes |
apiVersion |
enum |
Yes |
2019-08-01 |
location |
string |
Yes |
Resource location. |
tags |
object |
No |
Resource tags. |
sku |
object |
No |
The public IP prefix SKU. - PublicIPPrefixSku object |
properties |
object |
Yes |
Public IP prefix properties. - PublicIPPrefixPropertiesFormat object |
zones |
array |
No |
A list of availability zones denoting the IP allocated for the resource needs to come from. - string |
PublicIPPrefixSku object
Name |
Type |
Required |
Value |
name |
enum |
No |
Name of a public IP prefix SKU. - Standard |
Name |
Type |
Required |
Value |
publicIPAddressVersion |
enum |
No |
The public IP address version. - IPv4 or IPv6 |
ipTags |
array |
No |
The list of tags associated with the public IP prefix. - IpTag object |
prefixLength |
integer |
No |
The Length of the Public IP Prefix. |
ipPrefix |
string |
No |
The allocated Prefix. |
publicIPAddresses |
array |
No |
The list of all referenced PublicIPAddresses. - ReferencedPublicIpAddress object |
resourceGuid |
string |
No |
The resource GUID property of the public IP prefix resource. |
IpTag object
Name |
Type |
Required |
Value |
ipTagType |
string |
No |
The IP tag type. Example: FirstPartyUsage. |
tag |
string |
No |
The value of the IP tag associated with the public IP. Example: SQL. |
ReferencedPublicIpAddress object
Name |
Type |
Required |
Value |
id |
string |
No |
The PublicIPAddress Reference. |
Quickstart templates
The following quickstart templates deploy this resource type.