Skip to content

feat: Align public IP module params with 2025-01-01 API types #6368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChrisSidebotham merged 2 commits into from
Jan 6, 2026
+32 −265
Merged

feat: Align public IP module params with 2025-01-01 API types #6368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7195c8f
Replace user-defined types with resourceInput types
krbar Dec 17, 2025
b887f18
Update version/readme/changelog/ARM
krbar Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions avm/res/network/public-ip-address/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

The latest version of the changelog can be found [here](https://github.com/Azure/bicep-registry-modules/blob/main/avm/res/network/public-ip-address/CHANGELOG.md).

## 0.11.0

### Changes

- Replaced custom types for `ipTags`, `dnsSettings` and `ddosSettings` with direct references to the resource input types from the `Microsoft.Network/publicIPAddresses@2025-01-01` API version.

### Breaking Changes

- Parameters `ipTags`, `dnsSettings`, and `ddosSettings` now use resource input types from the `Microsoft.Network/publicIPAddresses@2025-01-01` API version instead of custom-defined types.

## 0.10.0

### Changes
Expand Down
117 changes: 0 additions & 117 deletions avm/res/network/public-ip-address/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -663,51 +663,6 @@ The DDoS protection plan configuration associated with the public IP address.
- Required: No
- Type: object

**Required parameters**

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`protectionMode`](#parameter-ddossettingsprotectionmode) | string | The DDoS protection policy customizations. |

**Optional parameters**

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`ddosProtectionPlan`](#parameter-ddossettingsddosprotectionplan) | object | The DDoS protection plan associated with the public IP address. |

### Parameter: `ddosSettings.protectionMode`

The DDoS protection policy customizations.

- Required: Yes
- Type: string
- Allowed:
```Bicep
[
'Enabled'
]
```

### Parameter: `ddosSettings.ddosProtectionPlan`

The DDoS protection plan associated with the public IP address.

- Required: No
- Type: object

**Required parameters**

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`id`](#parameter-ddossettingsddosprotectionplanid) | string | The resource ID of the DDOS protection plan associated with the public IP address. |

### Parameter: `ddosSettings.ddosProtectionPlan.id`

The resource ID of the DDOS protection plan associated with the public IP address.

- Required: Yes
- Type: string

### Parameter: `deleteOption`

The delete option for the public IP address.
Expand Down Expand Up @@ -875,57 +830,6 @@ The DNS settings of the public IP address.
- Required: No
- Type: object

**Required parameters**

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`domainNameLabel`](#parameter-dnssettingsdomainnamelabel) | 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. |

**Optional parameters**

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`domainNameLabelScope`](#parameter-dnssettingsdomainnamelabelscope) | string | 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. |
| [`fqdn`](#parameter-dnssettingsfqdn) | string | The 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`](#parameter-dnssettingsreversefqdn) | 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. |

### Parameter: `dnsSettings.domainNameLabel`

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.

- Required: Yes
- Type: string

### Parameter: `dnsSettings.domainNameLabelScope`

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.

- Required: No
- Type: string
- Allowed:
```Bicep
[
'NoReuse'
'ResourceGroupReuse'
'SubscriptionReuse'
'TenantReuse'
]
```

### Parameter: `dnsSettings.fqdn`

The 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.

- Required: No
- Type: string

### Parameter: `dnsSettings.reverseFqdn`

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.

- Required: No
- Type: string

### Parameter: `enableTelemetry`

Enable/Disable usage telemetry for module.
Expand All @@ -949,27 +853,6 @@ The list of tags associated with the public IP address.
- Required: No
- Type: array

**Required parameters**

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`ipTagType`](#parameter-iptagsiptagtype) | string | The IP tag type. |
| [`tag`](#parameter-iptagstag) | string | The IP tag. |

### Parameter: `ipTags.ipTagType`

The IP tag type.

- Required: Yes
- Type: string

### Parameter: `ipTags.tag`

The IP tag.

- Required: Yes
- Type: string

### Parameter: `location`

Location for all resources.
Expand Down
45 changes: 3 additions & 42 deletions avm/res/network/public-ip-address/main.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ param availabilityZones int[] = [
param publicIPAddressVersion string = 'IPv4'

@description('Optional. The DNS settings of the public IP address.')
param dnsSettings dnsSettingsType?
param dnsSettings resourceInput<'Microsoft.Network/publicIPAddresses@2025-01-01'>.properties.dnsSettings?

@description('Optional. The list of tags associated with the public IP address.')
param ipTags ipTagType[]?
param ipTags resourceInput<'Microsoft.Network/publicIPAddresses@2025-01-01'>.properties.ipTags?

import { lockType } from 'br/public:avm/utl/types/avm-common-types:0.6.1'
@description('Optional. The lock settings of the service.')
Expand All @@ -58,7 +58,7 @@ param skuName string = 'Standard'
param skuTier string = 'Regional'

@description('Optional. The DDoS protection plan configuration associated with the public IP address.')
param ddosSettings ddosSettingsType?
param ddosSettings resourceInput<'Microsoft.Network/publicIPAddresses@2025-01-01'>.properties.ddosSettings?

@description('Optional. The delete option for the public IP address.')
@allowed([
Expand Down Expand Up @@ -246,42 +246,3 @@ output ipAddress string = publicIpAddress.properties.?ipAddress ?? ''

@description('The location the resource was deployed into.')
output location string = publicIpAddress.location

// ================ //
// Definitions //
// ================ //

@export()
type dnsSettingsType = {
@description('Required. 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.')
domainNameLabel: string

@description('Optional. 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.')
domainNameLabelScope: ('NoReuse' | 'ResourceGroupReuse' | 'SubscriptionReuse' | 'TenantReuse')?

@description('Optional. The 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.')
fqdn: string?

@description('Optional. 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.')
reverseFqdn: string?
}

@export()
type ddosSettingsType = {
@description('Optional. The DDoS protection plan associated with the public IP address.')
ddosProtectionPlan: {
@description('Required. The resource ID of the DDOS protection plan associated with the public IP address.')
id: string
}?
@description('Required. The DDoS protection policy customizations.')
protectionMode: 'Enabled'
}

@export()
type ipTagType = {
@description('Required. The IP tag type.')
ipTagType: string

@description('Required. The IP tag.')
tag: string
}
123 changes: 18 additions & 105 deletions avm/res/network/public-ip-address/main.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,105 +6,12 @@
"_generator": {
"name": "bicep",
"version": "0.39.26.7824",
"templateHash": "2127232527712631807"
"templateHash": "4769782033235146336"
},
"name": "Public IP Addresses",
"description": "This module deploys a Public IP Address."
},
"definitions": {
"dnsSettingsType": {
"type": "object",
"properties": {
"domainNameLabel": {
"type": "string",
"metadata": {
"description": "Required. 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": {
"type": "string",
"allowedValues": [
"NoReuse",
"ResourceGroupReuse",
"SubscriptionReuse",
"TenantReuse"
],
"nullable": true,
"metadata": {
"description": "Optional. 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."
}
},
"fqdn": {
"type": "string",
"nullable": true,
"metadata": {
"description": "Optional. The 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": {
"type": "string",
"nullable": true,
"metadata": {
"description": "Optional. 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."
}
}
},
"metadata": {
"__bicep_export!": true
}
},
"ddosSettingsType": {
"type": "object",
"properties": {
"ddosProtectionPlan": {
"type": "object",
"properties": {
"id": {
"type": "string",
"metadata": {
"description": "Required. The resource ID of the DDOS protection plan associated with the public IP address."
}
}
},
"nullable": true,
"metadata": {
"description": "Optional. The DDoS protection plan associated with the public IP address."
}
},
"protectionMode": {
"type": "string",
"allowedValues": [
"Enabled"
],
"metadata": {
"description": "Required. The DDoS protection policy customizations."
}
}
},
"metadata": {
"__bicep_export!": true
}
},
"ipTagType": {
"type": "object",
"properties": {
"ipTagType": {
"type": "string",
"metadata": {
"description": "Required. The IP tag type."
}
},
"tag": {
"type": "string",
"metadata": {
"description": "Required. The IP tag."
}
}
},
"metadata": {
"__bicep_export!": true
}
},
"diagnosticSettingFullType": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -396,21 +303,24 @@
}
},
"dnsSettings": {
"$ref": "#/definitions/dnsSettingsType",
"nullable": true,
"type": "object",
"metadata": {
"__bicep_resource_derived_type!": {
"source": "Microsoft.Network/publicIPAddresses@2025-01-01#properties/properties/properties/dnsSettings"
},
"description": "Optional. The DNS settings of the public IP address."
}
},
"nullable": true
},
"ipTags": {
"type": "array",
"items": {
"$ref": "#/definitions/ipTagType"
},
"nullable": true,
"metadata": {
"__bicep_resource_derived_type!": {
"source": "Microsoft.Network/publicIPAddresses@2025-01-01#properties/properties/properties/ipTags"
},
"description": "Optional. The list of tags associated with the public IP address."
}
},
"nullable": true
},
"lock": {
"$ref": "#/definitions/lockType",
Expand Down Expand Up @@ -442,11 +352,14 @@
}
},
"ddosSettings": {
"$ref": "#/definitions/ddosSettingsType",
"nullable": true,
"type": "object",
"metadata": {
"__bicep_resource_derived_type!": {
"source": "Microsoft.Network/publicIPAddresses@2025-01-01#properties/properties/properties/ddosSettings"
},
"description": "Optional. The DDoS protection plan configuration associated with the public IP address."
}
},
"nullable": true
},
"deleteOption": {
"type": "string",
Expand Down
2 changes: 1 addition & 1 deletion avm/res/network/public-ip-address/version.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"$schema": "https://aka.ms/bicep-registry-module-version-file-schema#",
"version": "0.10"
"version": "0.11"
}