# BCPNFR3 - Usage Example formats

Module Specification for the Azure Verified Modules (AVM) program

ID: BCPNFR3 - Category: Documentation - Usage Example formats Usage examples for Bicep modules MUST be provided in the following formats:
Bicep file (orchestration module style) - .bicep
module <resourceName> 'br/public:avm/[res|ptn|utl]/<publishedModuleName>:>version<' = { name: '${uniqueString(deployment().name, location)}-test-<uniqueIdentifier>' params: { (...) } } JSON / ARM Template Parameter Files - .json
{ "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", "contentVersion": "1.0.0.0", "parameters": { (...) } } Note The above formats are currently automatically taken & generated from the tests/e2e tests. It is enough to run the Set-ModuleReadMe or Set-AVMModule functions (from the utilities folder) to update the usage examples in the readme(s).
Note Bicep Parameter Files (.bicepparam) are being reviewed and considered by the AVM team for the usability and features at this time and will likely be added in the future.


---
Source: https://raw.githubusercontent.com/Azure/Azure-Verified-Modules/refs/heads/main/docs/content/specs-defs/includes/bicep/shared/non-functional/BCPNFR3.md
Last Modified: 0001-01-01