Microsoft.Network publicIPPrefixes

Template format

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": "2020-07-01",
  "location": "string",
  "tags": {},
  "extendedLocation": {
    "name": "string",
    "type": "EdgeZone"
  },
  "sku": {
    "name": "Standard",
    "tier": "string"
  },
  "properties": {
    "publicIPAddressVersion": "string",
    "ipTags": [
      {
        "ipTagType": "string",
        "tag": "string"
      }
    ],
    "prefixLength": "integer",
    "customIPPrefix": {
      "id": "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 2020-07-01
location string Yes Resource location.
tags object No Resource tags.
extendedLocation object No The extended location of the public ip address. - ExtendedLocation object
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

ExtendedLocation object

Name Type Required Value
name string Yes The name of the extended location.
type enum Yes The type of the extended location. - EdgeZone

PublicIPPrefixSku object

Name Type Required Value
name enum No Name of a public IP prefix SKU. - Standard
tier enum No Tier of a public IP prefix SKU. - Regional or Global

PublicIPPrefixPropertiesFormat object

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.
customIPPrefix object No The customIpPrefix that this prefix is associated with. - SubResource object

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.

SubResource object

Name Type Required Value
id string No Resource ID.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Virtual Network NAT

Deploy to Azure
Deploy a NAT gateway and virtual machine
VMSS with Public IP Prefix

Deploy to Azure
Template for deploying VMSS with Public IP Prefix
Create an Azure Firewall with multiple IP public addresses

Deploy to Azure
This template creates an Azure Firewall with two public IP addresses and two Windows Server 2019 servers to test.