Microsoft.Network publicIPAddresses template reference

Template format

To create a Microsoft.Network/publicIPAddresses resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Network/publicIPAddresses",
  "apiVersion": "2019-04-01",
  "location": "string",
  "tags": {},
  "sku": {
    "name": "string"
  },
  "properties": {
    "publicIPAllocationMethod": "string",
    "publicIPAddressVersion": "string",
    "dnsSettings": {
      "domainNameLabel": "string",
      "fqdn": "string",
      "reverseFqdn": "string"
    },
    "ddosSettings": {
      "ddosCustomPolicy": {
        "id": "string"
      },
      "protectionCoverage": "string"
    },
    "ipTags": [
      {
        "ipTagType": "string",
        "tag": "string"
      }
    ],
    "ipAddress": "string",
    "publicIPPrefix": {
      "id": "string"
    },
    "idleTimeoutInMinutes": "integer",
    "resourceGuid": "string"
  },
  "zones": [
    "string"
  ]
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Network/publicIPAddresses object

Name Type Required Value
name string Yes
type enum Yes Microsoft.Network/publicIPAddresses
apiVersion enum Yes 2019-04-01
location string No Resource location.
tags object No Resource tags.
sku object No The public IP address SKU. - PublicIPAddressSku object
properties object Yes Public IP address properties. - PublicIPAddressPropertiesFormat object
zones array No A list of availability zones denoting the IP allocated for the resource needs to come from. - string

PublicIPAddressSku object

Name Type Required Value
name enum No Name of a public IP address SKU. - Basic or Standard

PublicIPAddressPropertiesFormat object

Name Type Required Value
publicIPAllocationMethod enum No The public IP address allocation method. - Static or Dynamic
publicIPAddressVersion enum No The public IP address version. - IPv4 or IPv6
dnsSettings object No The FQDN of the DNS record associated with the public IP address. - PublicIPAddressDnsSettings object
ddosSettings object No The DDoS protection custom policy associated with the public IP address. - DdosSettings object
ipTags array No The list of tags associated with the public IP address. - IpTag object
ipAddress string No The IP address associated with the public IP address resource.
publicIPPrefix object No The Public IP Prefix this Public IP Address should be allocated from. - SubResource object
idleTimeoutInMinutes integer No The idle timeout of the public IP address.
resourceGuid string No The resource GUID property of the public IP resource.

PublicIPAddressDnsSettings object

Name Type Required Value
domainNameLabel string No Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.
fqdn string No Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.
reverseFqdn string No Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

DdosSettings object

Name Type Required Value
ddosCustomPolicy object No The DDoS custom policy associated with the public IP. - SubResource object
protectionCoverage enum No The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. - Basic or Standard

IpTag object

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

SubResource object

Name Type Required Value
id string No Resource ID.

Quickstart templates

The following quickstart templates deploy this resource type.