Bicep Module Documentation

← Back to Overview

Module public-ip-address

publicIPAddress

Property Value Description
general (required) general
resourceName string Name of the resource the PIP will be attached to
index int The index of the resource
sku 'Global'
'Regional'
The public IP address sku (default: Regional)
zones string[] Zones where the public IP address should be deployed [Array of strings]
allocationMethod 'Dynamic'
'Static'
The public IP address version (default: Static)
addressVersion 'IPv4'
'IPv6'
The public IP address version (default: IPv4)
ddosSettings ddosSettings The DDoS protection custom policy associated with the public IP address.
dnsSettings dnsSettings The FQDN of the DNS record associated with the public IP address.

ddosSettings

Property Value Description
ddosProtectionPlanId string DDoS protection plan associated with this public ip address [ResourceId]
protectionMode 'Disabled'
'Enabled'
'VirtualNetworkInherited'
The DDoS protection mode of the public IP

dnsSettings

Property Value Description
domainNameLabel (required) string 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.
domainNameLabelScope 'NoReuse'
'ResourceGroupReuse'
'SubscriptionReuse'
'TenantReuse'
The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN.
reverseFqdn string 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.

naming

Property Value Description
forceFunctionAsFullName bool Use the function value as the full name of the resource
abbreviation string Override the abbreviation of this resource with this parameter
environment string The resource environment (for example: dev, tst, acc, prd)
location string The resource location (for example: weu, we, westeurope)
customer string The name of the customer
delimiter string The delimiter between resources (default: -)
nameFormat Array containing any of:
'abbreviation'
'customer'
'environment'
'function'
'location'
'param1'
'param2'
'param3'
'useCaseName'
The order of the array defines the order of elements in the naming scheme
param1 string Extra parameter self defined
param2 string Extra parameter self defined
param3 string Extra parameter self defined
function (required) string Function of the resource [can be app, db, security,...]
useCaseName string Name of the use case [can be hub, spoke,...]
suffix string Suffix for the resource, if empty non will be appended, otherwise will be added to the end [can be index, ...]
forceDefaultNaming bool Force the CAF naming instead of default company naming

resourceLock

Property Value Description
name string Character limit: 1-90. Valid characters: Alphanumerics, periods, underscores, hyphens, and parenthesis. Can't end in period.
level (required) 'CanNotDelete'
'ReadOnly'
The level of the lock. Possible values are: CanNotDelete and ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it. Read-Only locks must be commented to be able to deploy again
notes string Notes about the lock. Maximum of 512 characters.
owners resourceLockOwner[] The owners of the lock

resourceLockOwner

Property Value Description
applicationId (required) string The application ID of the lock owner.

roleAssignment

Property Value Description
principalId (required) string The principal ID
roleDefinitionId (required) string The role definition ID, data file can be used for this
condition string Condition on the role assignment
conditionVersion string Version of the condition. Currently the only accepted value is "2.0"
delegatedManagedIdentityResourceId string Id of the delegated managed identity resource
description string Description of role assignment

general

Property Value Description
tags object Tags of the resource [hashtable]
location (required) string Location of the resource
naming (required) naming Naming module of the resource
resourceGroupName (required) string Name of the resource group where the resource should be located
sharedNaming (required) naming Reference to the default naming
roleAssignments roleAssignment[] Role assignments on the resource
resourceLocks resourceLock[] Resource Locks on the resource

Changelog

4.1.0 (2025-10-08)

Features

  • update resource api version

4.0.1 (2025-09-24)

Bug Fixes

  • remove deployment name + cleanup

4.0.0 (2025-09-24)

⚠ BREAKING CHANGES

  • remove deprecated outputs

Bug Fixes

  • remove deprecated outputs

3.1.0 (2025-03-26)

Features

  • add resourceName output

3.0.0 (2025-01-24)

⚠ BREAKING CHANGES

  • add all dns settings

Features

  • add all dns settings