Microsoft.Network publicIPPrefixes 2020-05-01

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@2020-05-01' = {
  scope: resourceSymbolicName or scope
  ___location: 'string'
  name: 'string'
  properties: {
    ipTags: [
      {
        ipTagType: 'string'
        tag: 'string'
      }
    ]
    prefixLength: int
    publicIPAddressVersion: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Property Values

Microsoft.Network/publicIPPrefixes

IpTag

PublicIPPrefixPropertiesFormat

PublicIPPrefixSku

ResourceTags

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

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": "2020-05-01",
  "name": "string",
  "___location": "string",
  "properties": {
    "ipTags": [
      {
        "ipTagType": "string",
        "tag": "string"
      }
    ],
    "prefixLength": "int",
    "publicIPAddressVersion": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property Values

Microsoft.Network/publicIPPrefixes

IpTag

PublicIPPrefixPropertiesFormat

PublicIPPrefixSku

ResourceTags

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	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

Terraform (AzAPI provider) 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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/publicIPPrefixes@2020-05-01"
  name = "string"
  parent_id = "string"
  ___location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      ipTags = [
        {
          ipTagType = "string"
          tag = "string"
        }
      ]
      prefixLength = int
      publicIPAddressVersion = "string"
    }
    sku = {
      name = "string"
    }
    zones = [
      "string"
    ]
  }
}

Property Values

Microsoft.Network/publicIPPrefixes

IpTag

PublicIPPrefixPropertiesFormat

PublicIPPrefixSku

ResourceTags

Usage Examples

Terraform Samples

A basic example of deploying Public IP Prefix.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "___location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  ___location = var.___location
}

resource "azapi_resource" "publicIPPrefix" {
  type      = "Microsoft.Network/publicIPPrefixes@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location
  body = {
    properties = {
      prefixLength           = 30
      publicIPAddressVersion = "IPv4"
    }
    sku = {
      name = "Standard"
    }
    zones = [
      "1",
    ]
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.