Microsoft.Network publicIPPrefixes

Bicep resource definition

The publicIPPrefixes resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/publicIPPrefixes resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/publicIPPrefixes@2022-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'Standard'
    tier: 'string'
  }
  extendedLocation: {
    name: 'string'
    type: 'EdgeZone'
  }
  properties: {
    customIPPrefix: {
      id: 'string'
    }
    ipTags: [
      {
        ipTagType: 'string'
        tag: 'string'
      }
    ]
    natGateway: {
      id: 'string'
      location: 'string'
      properties: {
        idleTimeoutInMinutes: int
        publicIpAddresses: [
          {
            id: 'string'
          }
        ]
        publicIpPrefixes: [
          {
            id: 'string'
          }
        ]
      }
      sku: {
        name: 'Standard'
      }
      tags: {}
      zones: [
        'string'
      ]
    }
    prefixLength: int
    publicIPAddressVersion: 'string'
  }
  zones: [
    'string'
  ]
}

Property values

publicIPPrefixes

Name Description Value
name The resource name string (required)

Character limit: 1-80

Valid characters:
Alphanumerics, underscores, periods, and hyphens.

Start with alphanumeric. End alphanumeric or underscore.
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The public IP prefix SKU. PublicIPPrefixSku
extendedLocation The extended location of the public ip address. ExtendedLocation
properties Public IP prefix properties. PublicIPPrefixPropertiesFormat
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. 'EdgeZone'

PublicIPPrefixPropertiesFormat

Name Description Value
customIPPrefix The customIpPrefix that this prefix is associated with. object
ipTags The list of tags associated with the public IP prefix. IpTag[]
natGateway NatGateway of Public IP Prefix. NatGateway
prefixLength The Length of the Public IP Prefix. int
publicIPAddressVersion The public IP address version. 'IPv4'
'IPv6'

SubResource

Name Description Value
id Resource ID. string

IpTag

Name Description Value
ipTagType The IP tag type. Example: FirstPartyUsage. string
tag The value of the IP tag associated with the public IP. Example: SQL. string

NatGateway

Name Description Value
id Resource ID. string
location Resource location. string
properties Nat Gateway properties. NatGatewayPropertiesFormat
sku The nat gateway SKU. NatGatewaySku
tags Resource tags. object
zones A list of availability zones denoting the zone in which Nat Gateway should be deployed. string[]

NatGatewayPropertiesFormat

Name Description Value
idleTimeoutInMinutes The idle timeout of the nat gateway. int
publicIpAddresses An array of public ip addresses associated with the nat gateway resource. SubResource[]
publicIpPrefixes An array of public ip prefixes associated with the nat gateway resource. SubResource[]

NatGatewaySku

Name Description Value
name Name of Nat Gateway SKU. 'Standard'

PublicIPPrefixSku

Name Description Value
name Name of a public IP prefix SKU. 'Standard'
tier Tier of a public IP prefix SKU. 'Global'
'Regional'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
AKS Cluster with a NAT Gateway and an Application Gateway

Deploy to Azure
This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections.
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.
Virtual Network NAT with VM

Deploy to Azure
Deploy a NAT gateway and virtual machine

ARM template resource definition

The publicIPPrefixes resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/publicIPPrefixes resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/publicIPPrefixes",
  "apiVersion": "2022-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "Standard",
    "tier": "string"
  },
  "extendedLocation": {
    "name": "string",
    "type": "EdgeZone"
  },
  "properties": {
    "customIPPrefix": {
      "id": "string"
    },
    "ipTags": [
      {
        "ipTagType": "string",
        "tag": "string"
      }
    ],
    "natGateway": {
      "id": "string",
      "location": "string",
      "properties": {
        "idleTimeoutInMinutes": "int",
        "publicIpAddresses": [
          {
            "id": "string"
          }
        ],
        "publicIpPrefixes": [
          {
            "id": "string"
          }
        ]
      },
      "sku": {
        "name": "Standard"
      },
      "tags": {},
      "zones": [ "string" ]
    },
    "prefixLength": "int",
    "publicIPAddressVersion": "string"
  },
  "zones": [ "string" ]
}

Property values

publicIPPrefixes

Name Description Value
type The resource type 'Microsoft.Network/publicIPPrefixes'
apiVersion The resource api version '2022-05-01'
name The resource name string (required)

Character limit: 1-80

Valid characters:
Alphanumerics, underscores, periods, and hyphens.

Start with alphanumeric. End alphanumeric or underscore.
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The public IP prefix SKU. PublicIPPrefixSku
extendedLocation The extended location of the public ip address. ExtendedLocation
properties Public IP prefix properties. PublicIPPrefixPropertiesFormat
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. 'EdgeZone'

PublicIPPrefixPropertiesFormat

Name Description Value
customIPPrefix The customIpPrefix that this prefix is associated with. object
ipTags The list of tags associated with the public IP prefix. IpTag[]
natGateway NatGateway of Public IP Prefix. NatGateway
prefixLength The Length of the Public IP Prefix. int
publicIPAddressVersion The public IP address version. 'IPv4'
'IPv6'

SubResource

Name Description Value
id Resource ID. string

IpTag

Name Description Value
ipTagType The IP tag type. Example: FirstPartyUsage. string
tag The value of the IP tag associated with the public IP. Example: SQL. string

NatGateway

Name Description Value
id Resource ID. string
location Resource location. string
properties Nat Gateway properties. NatGatewayPropertiesFormat
sku The nat gateway SKU. NatGatewaySku
tags Resource tags. object
zones A list of availability zones denoting the zone in which Nat Gateway should be deployed. string[]

NatGatewayPropertiesFormat

Name Description Value
idleTimeoutInMinutes The idle timeout of the nat gateway. int
publicIpAddresses An array of public ip addresses associated with the nat gateway resource. SubResource[]
publicIpPrefixes An array of public ip prefixes associated with the nat gateway resource. SubResource[]

NatGatewaySku

Name Description Value
name Name of Nat Gateway SKU. 'Standard'

PublicIPPrefixSku

Name Description Value
name Name of a public IP prefix SKU. 'Standard'
tier Tier of a public IP prefix SKU. 'Global'
'Regional'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
AKS Cluster with a NAT Gateway and an Application Gateway

Deploy to Azure
This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections.
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.
Virtual Network NAT with VM

Deploy to Azure
Deploy a NAT gateway and virtual machine

Terraform (AzAPI provider) resource definition

The publicIPPrefixes resource type can be deployed to:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Network/publicIPPrefixes resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/publicIPPrefixes@2022-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      customIPPrefix = {
        id = "string"
      }
      ipTags = [
        {
          ipTagType = "string"
          tag = "string"
        }
      ]
      natGateway = {
        id = "string"
        location = "string"
        properties = {
          idleTimeoutInMinutes = int
          publicIpAddresses = [
            {
              id = "string"
            }
          ]
          publicIpPrefixes = [
            {
              id = "string"
            }
          ]
        }
        sku = {
          name = "Standard"
        }
        tags = {}
        zones = [
          "string"
        ]
      }
      prefixLength = int
      publicIPAddressVersion = "string"
    }
    zones = [
      "string"
    ]
    sku = {
      name = "Standard"
      tier = "string"
    }
    extendedLocation = {
      name = "string"
      type = "EdgeZone"
    }
  })
}

Property values

publicIPPrefixes

Name Description Value
type The resource type "Microsoft.Network/publicIPPrefixes@2022-05-01"
name The resource name string (required)

Character limit: 1-80

Valid characters:
Alphanumerics, underscores, periods, and hyphens.

Start with alphanumeric. End alphanumeric or underscore.
location Resource location. string
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
sku The public IP prefix SKU. PublicIPPrefixSku
extendedLocation The extended location of the public ip address. ExtendedLocation
properties Public IP prefix properties. PublicIPPrefixPropertiesFormat
zones A list of availability zones denoting the IP allocated for the resource needs to come from. string[]

ExtendedLocation

Name Description Value
name The name of the extended location. string
type The type of the extended location. "EdgeZone"

PublicIPPrefixPropertiesFormat

Name Description Value
customIPPrefix The customIpPrefix that this prefix is associated with. object
ipTags The list of tags associated with the public IP prefix. IpTag[]
natGateway NatGateway of Public IP Prefix. NatGateway
prefixLength The Length of the Public IP Prefix. int
publicIPAddressVersion The public IP address version. "IPv4"
"IPv6"

SubResource

Name Description Value
id Resource ID. string

IpTag

Name Description Value
ipTagType The IP tag type. Example: FirstPartyUsage. string
tag The value of the IP tag associated with the public IP. Example: SQL. string

NatGateway

Name Description Value
id Resource ID. string
location Resource location. string
properties Nat Gateway properties. NatGatewayPropertiesFormat
sku The nat gateway SKU. NatGatewaySku
tags Resource tags. object
zones A list of availability zones denoting the zone in which Nat Gateway should be deployed. string[]

NatGatewayPropertiesFormat

Name Description Value
idleTimeoutInMinutes The idle timeout of the nat gateway. int
publicIpAddresses An array of public ip addresses associated with the nat gateway resource. SubResource[]
publicIpPrefixes An array of public ip prefixes associated with the nat gateway resource. SubResource[]

NatGatewaySku

Name Description Value
name Name of Nat Gateway SKU. "Standard"

PublicIPPrefixSku

Name Description Value
name Name of a public IP prefix SKU. "Standard"
tier Tier of a public IP prefix SKU. "Global"
"Regional"