Skip to content

fix: BCPNFR1 update to include RDT and remove CARML note #2132

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
eriqua merged 2 commits into from
Jun 20, 2025
Merged

fix: BCPNFR1 update to include RDT and remove CARML note #2132

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b4a1c2
BCPNFR1 update to include RDT
eriqua Jun 13, 2025
28be4a5
title update
eriqua Jun 19, 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
16 changes: 8 additions & 8 deletions docs/content/specs-defs/includes/bicep/shared/non-functional/BCPNFR1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: BCPNFR1 - User-defined types - General
title: BCPNFR1 - Complex data types - General
description: Module Specification for the Azure Verified Modules (AVM) program
url: /spec/BCPNFR1
type: default
Expand All @@ -18,22 +18,22 @@ tags: [
priority: 11010
---

## ID: BCPNFR1 - Inputs - User-defined types - General
## ID: BCPNFR1 - Category: Inputs - Complex data types - General

To simplify the consumption experience for module consumers when interacting with complex data types input parameters, mainly objects and arrays, the Bicep feature of [User-Defined Types](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/user-defined-data-types) **MUST** be used and declared.
To simplify the consumption experience for module consumers when interacting with complex data types input parameters, mainly objects and arrays, the Bicep features of Resource-Derived Types or [User-Defined Types](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/user-defined-data-types) **MUST** be used and declared.

{{% notice style="tip" %}}

User-Defined Types are GA in Bicep as of version v0.21.1, please ensure you have this version installed as a minimum.
User-Defined Types are GA in Bicep as of version v0.21.1, Resource-Derived Types are GA as of version v0.34.1, please ensure you have this version(s) installed as a minimum.

{{% /notice %}}

[User-Defined Types](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/user-defined-data-types) allow intellisense support in supported IDEs (e.g. Visual Studio Code) for complex input parameters using arrays and objects.
Resource-Derived Types and User-Defined Types allow intellisense support in supported IDEs (e.g. Visual Studio Code) for complex input parameters using objects and array of objects.

{{% notice style="important" title="CARML Migration Exemption" %}}
{{% notice style="important" title="v0.x Exemption" %}}

While the [transition of CARML]({{% siteparam base %}}/faq/#carml-evolution) modules into AVM is complete, retrofitting [User-Defined Types](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/user-defined-data-types) for all modules will take a considerable amount of time.
While we allow the release of major versions, starting with v1.0.0, retrofitting Resource-Derived Types and User-Defined Types for all modules will take a considerable amount of time.

Therefore, the addition of [User-Defined Types](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/user-defined-data-types) is currently **NOT** mandated/enforced. However, past their initial release, all modules **MUST** implement [User-Defined Types](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/user-defined-data-types) prior to the release of their next version.
Therefore, the addition of these features is currently **NOT** mandated/enforced. However, all modules **MUST** implement Resource-Derived Types and User-Defined Types prior to the release of their v1.0.0 version.

{{% /notice %}}