Bicep Module Documentation
← Back to Overview
Module app-configuration
appConfiguration
| Property | Value | Description |
|---|---|---|
| general (required) | general | |
| skuName | 'Developer' 'Free' 'Premium' 'Standard' |
Name of the Sku. (default: Standard) |
| identity | identity | |
| createMode | 'Default' 'Recover' |
Indicates whether the configuration store need to be recovered. (default: Default) |
| disableLocalAuth | bool | Disables all authentication methods other than AAD authentication. |
| dataPlaneProxy | dataPlaneProxy | Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). |
| enablePurgeProtection | bool | Property specifying whether protection against purge is enabled for this configuration store. (default: false) |
| encryption | encryption | The encryption settings of the configuration store. |
| publicNetworkAccess | 'Disabled' 'Enabled' |
Control permission for data plane traffic coming from public networks while private endpoint is enabled. (default: Enabled) |
| softDeleteRetentionInDays | int | The amount of time in days that the configuration store will be retained when it is soft deleted. |
| replicas | appConfigurationReplica[] | Replicas in the app configuration |
| keyValues | appConfigurationKeyValue[] | Key values in the app configuration |
| privateLink | privateLink | Settings for the private endpoint and private link for this resource |
identity
| Property | Value | Description |
|---|---|---|
| type | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
The types of identities associated with this resource. (default: none) |
| userAssignedIdentities | string[] | Resource IDs of User Assigned Identities to associate with this resource |
dataPlaneProxy
| Property | Value | Description |
|---|---|---|
| authenticationMode (required) | 'Local' 'Pass-through' |
|
| privateLinkDelegation | 'Disabled' 'Enabled' |
The data plane proxy private link delegation. This property manages if a request from delegated Azure Resource Manager (ARM) private link is allowed when the data plane resource requires private link. |
keyVaultProperties
| Property | Value | Description |
|---|---|---|
| identityClientId (required) | string | The client id of the identity which will be used to access key vault. |
| keyIdentifier (required) | string | The URI of the key vault key used to encrypt data. |
encryption
| Property | Value | Description |
|---|---|---|
| keyVaultProperties (required) | keyVaultProperties |
appConfigurationReplica
| Property | Value | Description |
|---|---|---|
| replicaName (required) | string | Replica Name eg https://appcs-xxx-xxx-xxx-{replicaname}.azconfig.io |
| location (required) | string | Replica location |
appConfigurationKeyValue
| Property | Value | Description |
|---|---|---|
| name (required) | string | The resource name |
| contentType | string | The content type of the key-values value. Providing a proper content-type can enable transformations of values when they are retrieved by applications. |
| value (required) | string | The value of the key-value. |
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 |
privateLink
| Property | Value | Description |
|---|---|---|
| pepNaming | naming | Name of the private endpoint |
| nicNaming | naming | Name of the network interface of the private endpoint |
| privateLinkNaming | naming | Name of the private link connection |
| subnets (required) | subnets[] | Id of the subnets and optionally the name of the resourcegroup in which the private endpoint should be created |
| dnsZoneIds (required) | string[] | List of DNS zone ids that need to be linked |
subnets
| Property | Value | Description |
|---|---|---|
| resourceGroupName | string | Resourcegroup (default: resourcegroup defined here => resourceGroup of pep resource => resourceGroup of subnet) |
| id (required) | string | Id of the subnet |
| location | string | Location if Vnet is in different location |
Changelog
6.1.0 (2025-10-06)
Features
- update resource api versions
6.0.1 (2025-09-24)
Bug Fixes
- remove deployment name + cleanup
6.0.0 (2025-09-24)
⚠ BREAKING CHANGES
- remove deprecated outputs
Bug Fixes
- remove deprecated outputs
5.2.0 (2025-08-21)
Features
- add Developer and Premium sku
5.1.1 (2025-04-11)
Bug Fixes
- naming connected resources when forceFunctionAsFullName or forceDefaultNaming is true
5.1.0 (2025-03-26)
Features
- add resourceName output
5.0.0 (2025-03-17)
⚠ BREAKING CHANGES
- remove role-assignment principalType parameter
Features
- remove role-assignment principalType parameter
4.0.0 (2025-01-03)
⚠ BREAKING CHANGES
- use new toObject function for UserAssignedIdentities. Only breaking when using managed identities.
Features
- use new toObject function for UserAssignedIdentities. Only breaking when using managed identities.