Share via

Microsoft.Network publicIPPrefixes 2023-06-01

  • Article

Bicep resource definition

The publicIPPrefixes resource type can be deployed with operations that target:

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@2023-06-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  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: 'string'
      }
      tags: {
        {customized property}: 'string'
      }
      zones: [
        'string'
      ]
    }
    prefixLength: int
    publicIPAddressVersion: 'string'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Property values

ExtendedLocation

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

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

Microsoft.Network/publicIPPrefixes

Name Description Value
extendedLocation The extended location of the public ip address. ExtendedLocation
location Resource location. string
name The resource name string (required)
properties Public IP prefix properties. PublicIPPrefixPropertiesFormat
sku The public IP prefix SKU. PublicIPPrefixSku
tags Resource tags Dictionary of tag names and values. See Tags in templates
zones A list of availability zones denoting the IP allocated for the resource needs to come from. 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. ResourceTags
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'

PublicIPPrefixPropertiesFormat

Name Description Value
customIPPrefix The customIpPrefix that this prefix is associated with. SubResource
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'

PublicIPPrefixSku

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

ResourceTags

Name Description Value

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
AKS Cluster with a NAT Gateway and an Application Gateway This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections.
Create an Azure Firewall with multiple IP public addresses This template creates an Azure Firewall with two public IP addresses and two Windows Server 2019 servers to test.
VMSS with Public IP Prefix Template for deploying VMSS with Public IP Prefix

ARM template resource definition

The publicIPPrefixes resource type can be deployed with operations that target:

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": "2023-06-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "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": "string"
      },
      "tags": {
        "{customized property}": "string"
      },
      "zones": [ "string" ]
    },
    "prefixLength": "int",
    "publicIPAddressVersion": "string"
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property values

ExtendedLocation

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

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

Microsoft.Network/publicIPPrefixes

Name Description Value
apiVersion The api version '2023-06-01'
extendedLocation The extended location of the public ip address. ExtendedLocation
location Resource location. string
name The resource name string (required)
properties Public IP prefix properties. PublicIPPrefixPropertiesFormat
sku The public IP prefix SKU. PublicIPPrefixSku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Network/publicIPPrefixes'
zones A list of availability zones denoting the IP allocated for the resource needs to come from. 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. ResourceTags
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'

PublicIPPrefixPropertiesFormat

Name Description Value
customIPPrefix The customIpPrefix that this prefix is associated with. SubResource
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'

PublicIPPrefixSku

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

ResourceTags

Name Description Value

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string

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.
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.
VMSS with Public IP Prefix

Deploy to Azure		 Template for deploying VMSS with Public IP Prefix

Terraform (AzAPI provider) resource definition

The publicIPPrefixes resource type can be deployed with operations that target:

  • 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@2023-06-01"
  name = "string"
  extendedLocation = {
    name = "string"
    type = "string"
  }
  location = "string"
  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 = "string"
        }
        tags = {
          {customized property} = "string"
        }
        zones = [
          "string"
        ]
      }
      prefixLength = int
      publicIPAddressVersion = "string"
    }
  })
  sku = {
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  zones = [
    "string"
  ]
}

Property values

ExtendedLocation

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

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

Microsoft.Network/publicIPPrefixes

Name Description Value
extendedLocation The extended location of the public ip address. ExtendedLocation
location Resource location. string
name The resource name string (required)
properties Public IP prefix properties. PublicIPPrefixPropertiesFormat
sku The public IP prefix SKU. PublicIPPrefixSku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/publicIPPrefixes@2023-06-01"
zones A list of availability zones denoting the IP allocated for the resource needs to come from. 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. ResourceTags
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'

PublicIPPrefixPropertiesFormat

Name Description Value
customIPPrefix The customIpPrefix that this prefix is associated with. SubResource
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'

PublicIPPrefixSku

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

ResourceTags

Name Description Value

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string