Bicep Module Documentation
← Back to Overview
Module redis-cache
redisCache
| Property | Value | Description |
|---|---|---|
| general (required) | general | |
| identity | identity | |
| encryption | encryption | Properties of BYOK Encryption description |
| enableNonSslPort | bool | Specifies whether the non-ssl Redis server port (6379) is enabled. |
| minimumTlsVersion | '1.0' '1.1' '1.2' |
The minimum TLS version for the cluster to support (default: 1.2) |
| publicNetworkAccess | 'Disabled' 'Enabled' 'SecuredByPerimeter' |
This determines if traffic is allowed over public network. By default it is enabled. |
| privateLink | privateLink | Settings for the private endpoint and private link for this resource |
| redisConfiguration | object | All Redis Settings. |
| redisVersion | string | Redis version. This should be in the form major[.minor] (only major is required) or the value latest which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is latest. |
| replicasPerMaster | int | The number of replicas to be created per primary. |
| replicasPerPrimary | int | The number of replicas to be created per primary. |
| shardCount | int | The number of shards to be created on a Premium Cluster Cache. |
| sku (required) | redisSku | The SKU of the Redis cache to deploy. |
| staticIP | string | Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default. |
| subnetId | string | The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network,ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1 |
| updateChannel | 'Preview' 'Stable' |
Optional: Specifies the update channel for the monthly Redis updates your Redis Cache will receive. Caches using Preview update channel get latest Redis updates at least 4 weeks ahead of Stable channel caches. Default value is Stable. |
identity
| Property | Value | Description |
|---|---|---|
| userAssignedIdentity (required) | string |
encryption
| Property | Value | Description |
|---|---|---|
| keySource (required) | 'Microsoft.KeyVault' | Enumerates the possible value of keySource for Encryption |
| keyVaultProperties (required) | keyVaultProperties[] | Properties of KeyVault |
| requireInfrastructureEncryption | bool | Enable Infrastructure Encryption (Double Encryption) |
redisSku
| Property | Value | Description |
|---|---|---|
| capacity (required) | int | The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4). |
| family (required) | 'C' 'P' |
The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). |
| name (required) | 'Basic' 'Premium' 'Standard' |
The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) |
keyVaultProperties
| Property | Value | Description |
|---|---|---|
| identity | identity | |
| keyName (required) | string | Name of the Key from KeyVault |
| keyVaultUri (required) | string | Uri of KeyVault |
| keyVersion (required) | string | Version of KeyVault |
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
4.3.0 (2025-10-06)
Features
- update resource api version
4.2.1 (2025-09-24)
Bug Fixes
- remove deployment name + cleanup
4.2.0 (2025-09-01)
Features
- add secure outputs
4.1.1 (2025-04-11)
Bug Fixes
- naming connected resources when forceFunctionAsFullName or forceDefaultNaming is true
4.1.0 (2025-03-26)
Features
- add resourceName output
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.