# BCPNFR4 - Parameter Input Examples

Module Specification for the Azure Verified Modules (AVM) program

ID: BCPNFR4 - Category: Documentation - Parameter Input Examples Bicep modules MAY provide parameter input examples for parameters using the metadata.example property via the @metadata() decorator.
Example:
@metadata({ example: &#39;uksouth&#39; }) @description(&#39;Optional. Location for all resources.&#39;) param location string = resourceGroup().location @metadata({ example: &#39;&#39;&#39; { keyName: &#39;myKey&#39; keyVaultResourceId: &#39;/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/my-rg/providers/Microsoft.KeyVault/vaults/myvault&#39; keyVersion: &#39;6d143c1a0a6a453daffec4001e357de0&#39; userAssignedIdentityResourceId &#39;/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/my-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity&#39; } &#39;&#39;&#39; }) @description(&#39;Optional. The customer managed key definition.&#39;) param customerManagedKey customerManagedKeyType It is planned that these examples are automatically added to the module readme&rsquo;s parameter descriptions when running either the Set-ModuleReadMe or Set-AVMModule scripts (available in the utilities folder).


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