Microsoft.Network publicIPPrefixes 2018-08-01

• Latest
• 2024-05-01
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01
• 2019-02-01
• 2018-12-01
• 2018-11-01
• 2018-10-01
• 2018-08-01
• 2018-07-01

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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@2018-08-01' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    ipPrefix: 'string'
    ipTags: [
      {
        ipTagType: 'string'
        tag: 'string'
      }
    ]
    prefixLength: int
    provisioningState: 'string'
    publicIPAddresses: [
      {
        id: 'string'
      }
    ]
    publicIPAddressVersion: 'string'
    resourceGuid: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Property values

IpTag

Name	Description	Value
ipTagType	Gets or sets the ipTag type: Example FirstPartyUsage.	string
tag	Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc	string

Microsoft.Network/publicIPPrefixes

Name	Description	Value
etag	A unique read-only string that changes whenever the resource is updated.	string
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[]

PublicIPPrefixPropertiesFormat

Name	Description	Value
ipPrefix	The allocated Prefix	string
ipTags	The list of tags associated with the public IP prefix.	IpTag[]
prefixLength	The Length of the Public IP Prefix.	int
provisioningState	The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
publicIPAddresses	The list of all referenced PublicIPAddresses	ReferencedPublicIpAddress[]
publicIPAddressVersion	The public IP address version. Possible values are: 'IPv4' and 'IPv6'.	'IPv4' 'IPv6'
resourceGuid	The resource GUID property of the public IP prefix resource.	string

PublicIPPrefixSku

Name	Description	Value
name	Name of a public IP prefix SKU.	'Standard'

ReferencedPublicIpAddress

Name	Description	Value
id	The PublicIPAddress Reference	string

ResourceTags

Name	Description	Value

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:

• Resource groups - See resource group deployment commands

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": "2018-08-01",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "ipPrefix": "string",
    "ipTags": [
      {
        "ipTagType": "string",
        "tag": "string"
      }
    ],
    "prefixLength": "int",
    "provisioningState": "string",
    "publicIPAddresses": [
      {
        "id": "string"
      }
    ],
    "publicIPAddressVersion": "string",
    "resourceGuid": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property values

IpTag

Name	Description	Value
ipTagType	Gets or sets the ipTag type: Example FirstPartyUsage.	string
tag	Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc	string

Microsoft.Network/publicIPPrefixes

Name	Description	Value
apiVersion	The api version	'2018-08-01'
etag	A unique read-only string that changes whenever the resource is updated.	string
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[]

PublicIPPrefixPropertiesFormat

Name	Description	Value
ipPrefix	The allocated Prefix	string
ipTags	The list of tags associated with the public IP prefix.	IpTag[]
prefixLength	The Length of the Public IP Prefix.	int
provisioningState	The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
publicIPAddresses	The list of all referenced PublicIPAddresses	ReferencedPublicIpAddress[]
publicIPAddressVersion	The public IP address version. Possible values are: 'IPv4' and 'IPv6'.	'IPv4' 'IPv6'
resourceGuid	The resource GUID property of the public IP prefix resource.	string

PublicIPPrefixSku

Name	Description	Value
name	Name of a public IP prefix SKU.	'Standard'

ReferencedPublicIpAddress

Name	Description	Value
id	The PublicIPAddress Reference	string

ResourceTags

Name	Description	Value

Quickstart templates

The following 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:

• 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@2018-08-01"
  name = "string"
  etag = "string"
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  zones = [
    "string"
  ]
  body = jsonencode({
    properties = {
      ipPrefix = "string"
      ipTags = [
        {
          ipTagType = "string"
          tag = "string"
        }
      ]
      prefixLength = int
      provisioningState = "string"
      publicIPAddresses = [
        {
          id = "string"
        }
      ]
      publicIPAddressVersion = "string"
      resourceGuid = "string"
    }
  })
}

Property values

IpTag

Name	Description	Value
ipTagType	Gets or sets the ipTag type: Example FirstPartyUsage.	string
tag	Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc	string

Microsoft.Network/publicIPPrefixes

Name	Description	Value
etag	A unique read-only string that changes whenever the resource is updated.	string
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@2018-08-01"
zones	A list of availability zones denoting the IP allocated for the resource needs to come from.	string[]

PublicIPPrefixPropertiesFormat

Name	Description	Value
ipPrefix	The allocated Prefix	string
ipTags	The list of tags associated with the public IP prefix.	IpTag[]
prefixLength	The Length of the Public IP Prefix.	int
provisioningState	The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.	string
publicIPAddresses	The list of all referenced PublicIPAddresses	ReferencedPublicIpAddress[]
publicIPAddressVersion	The public IP address version. Possible values are: 'IPv4' and 'IPv6'.	'IPv4' 'IPv6'
resourceGuid	The resource GUID property of the public IP prefix resource.	string

PublicIPPrefixSku

Name	Description	Value
name	Name of a public IP prefix SKU.	'Standard'

ReferencedPublicIpAddress

Name	Description	Value
id	The PublicIPAddress Reference	string

ResourceTags

Name	Description	Value