Microsoft.Cache redisEnterprise 2024-09-01-preview
The redisEnterprise resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
To create a Microsoft.Cache/redisEnterprise resource, add the following Bicep to your template.
Bicep
resource symbolicname 'Microsoft.Cache/redisEnterprise@2024-09-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
encryption: {
customerManagedKeyEncryption: {
keyEncryptionKeyIdentity: {
identityType: 'string'
userAssignedIdentityResourceId: 'string'
}
keyEncryptionKeyUrl: 'string'
}
}
highAvailability: 'string'
minimumTlsVersion: 'string'
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
zones: [
'string'
]
}
| Name | Description | Value |
|---|---|---|
| encryption | Encryption-at-rest configuration for the cluster. | ClusterPropertiesEncryption |
| highAvailability | Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. | 'Disabled' 'Enabled' |
| minimumTlsVersion | The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions. | '1.0' '1.1' '1.2' |
| Name | Description | Value |
|---|---|---|
| customerManagedKeyEncryption | All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. | ClusterPropertiesEncryptionCustomerManagedKeyEncryption |
| Name | Description | Value |
|---|---|---|
| keyEncryptionKeyIdentity | All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. | ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity |
| keyEncryptionKeyUrl | Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 | string |
| Name | Description | Value |
|---|---|---|
| identityType | Only userAssignedIdentity is supported in this API version; other types may be supported in the future | 'systemAssignedIdentity' 'userAssignedIdentity' |
| userAssignedIdentityResourceId | User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/<sub uuid>/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. | string |
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
| Name | Description | Value |
|---|---|---|
| identity | The identity of the resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[A-Za-z0-9]{1,60}$ (required) |
| properties | Other properties of the cluster. | ClusterProperties |
| sku | The SKU to create, which affects price, performance, and features. | Sku (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| zones | The Availability Zones where this cluster will be deployed. | string[] |
| Name | Description | Value |
|---|---|---|
| capacity | This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs. | int |
| name | The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. | 'Balanced_B0' 'Balanced_B1' 'Balanced_B10' 'Balanced_B100' 'Balanced_B1000' 'Balanced_B150' 'Balanced_B20' 'Balanced_B250' 'Balanced_B3' 'Balanced_B350' 'Balanced_B5' 'Balanced_B50' 'Balanced_B500' 'Balanced_B700' 'ComputeOptimized_X10' 'ComputeOptimized_X100' 'ComputeOptimized_X150' 'ComputeOptimized_X20' 'ComputeOptimized_X250' 'ComputeOptimized_X3' 'ComputeOptimized_X350' 'ComputeOptimized_X5' 'ComputeOptimized_X50' 'ComputeOptimized_X500' 'ComputeOptimized_X700' 'EnterpriseFlash_F1500' 'EnterpriseFlash_F300' 'EnterpriseFlash_F700' 'Enterprise_E1' 'Enterprise_E10' 'Enterprise_E100' 'Enterprise_E20' 'Enterprise_E200' 'Enterprise_E400' 'Enterprise_E5' 'Enterprise_E50' 'FlashOptimized_A1000' 'FlashOptimized_A1500' 'FlashOptimized_A2000' 'FlashOptimized_A250' 'FlashOptimized_A4500' 'FlashOptimized_A500' 'FlashOptimized_A700' 'MemoryOptimized_M10' 'MemoryOptimized_M100' 'MemoryOptimized_M1000' 'MemoryOptimized_M150' 'MemoryOptimized_M1500' 'MemoryOptimized_M20' 'MemoryOptimized_M2000' 'MemoryOptimized_M250' 'MemoryOptimized_M350' 'MemoryOptimized_M50' 'MemoryOptimized_M500' 'MemoryOptimized_M700' (required) |
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Redis Enterprise Cache | AVM Resource Module for Redis Enterprise Cache |
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Redis Enterprise with Vector DB | This template creates a Redis Cache that can be used as Vector DB to store and query embeddings via indexes. For this feature, the Redis Search module is activated in Azure Redis |
The redisEnterprise resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
To create a Microsoft.Cache/redisEnterprise resource, add the following JSON to your template.
JSON
{
"type": "Microsoft.Cache/redisEnterprise",
"apiVersion": "2024-09-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"encryption": {
"customerManagedKeyEncryption": {
"keyEncryptionKeyIdentity": {
"identityType": "string",
"userAssignedIdentityResourceId": "string"
},
"keyEncryptionKeyUrl": "string"
}
},
"highAvailability": "string",
"minimumTlsVersion": "string"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
},
"zones": [ "string" ]
}
| Name | Description | Value |
|---|---|---|
| encryption | Encryption-at-rest configuration for the cluster. | ClusterPropertiesEncryption |
| highAvailability | Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. | 'Disabled' 'Enabled' |
| minimumTlsVersion | The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions. | '1.0' '1.1' '1.2' |
| Name | Description | Value |
|---|---|---|
| customerManagedKeyEncryption | All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. | ClusterPropertiesEncryptionCustomerManagedKeyEncryption |
| Name | Description | Value |
|---|---|---|
| keyEncryptionKeyIdentity | All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. | ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity |
| keyEncryptionKeyUrl | Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 | string |
| Name | Description | Value |
|---|---|---|
| identityType | Only userAssignedIdentity is supported in this API version; other types may be supported in the future | 'systemAssignedIdentity' 'userAssignedIdentity' |
| userAssignedIdentityResourceId | User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/<sub uuid>/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. | string |
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-09-01-preview' |
| identity | The identity of the resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[A-Za-z0-9]{1,60}$ (required) |
| properties | Other properties of the cluster. | ClusterProperties |
| sku | The SKU to create, which affects price, performance, and features. | Sku (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Cache/redisEnterprise' |
| zones | The Availability Zones where this cluster will be deployed. | string[] |
| Name | Description | Value |
|---|---|---|
| capacity | This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs. | int |
| name | The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. | 'Balanced_B0' 'Balanced_B1' 'Balanced_B10' 'Balanced_B100' 'Balanced_B1000' 'Balanced_B150' 'Balanced_B20' 'Balanced_B250' 'Balanced_B3' 'Balanced_B350' 'Balanced_B5' 'Balanced_B50' 'Balanced_B500' 'Balanced_B700' 'ComputeOptimized_X10' 'ComputeOptimized_X100' 'ComputeOptimized_X150' 'ComputeOptimized_X20' 'ComputeOptimized_X250' 'ComputeOptimized_X3' 'ComputeOptimized_X350' 'ComputeOptimized_X5' 'ComputeOptimized_X50' 'ComputeOptimized_X500' 'ComputeOptimized_X700' 'EnterpriseFlash_F1500' 'EnterpriseFlash_F300' 'EnterpriseFlash_F700' 'Enterprise_E1' 'Enterprise_E10' 'Enterprise_E100' 'Enterprise_E20' 'Enterprise_E200' 'Enterprise_E400' 'Enterprise_E5' 'Enterprise_E50' 'FlashOptimized_A1000' 'FlashOptimized_A1500' 'FlashOptimized_A2000' 'FlashOptimized_A250' 'FlashOptimized_A4500' 'FlashOptimized_A500' 'FlashOptimized_A700' 'MemoryOptimized_M10' 'MemoryOptimized_M100' 'MemoryOptimized_M1000' 'MemoryOptimized_M150' 'MemoryOptimized_M1500' 'MemoryOptimized_M20' 'MemoryOptimized_M2000' 'MemoryOptimized_M250' 'MemoryOptimized_M350' 'MemoryOptimized_M50' 'MemoryOptimized_M500' 'MemoryOptimized_M700' (required) |
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Redis Enterprise with Vector DB |
This template creates a Redis Cache that can be used as Vector DB to store and query embeddings via indexes. For this feature, the Redis Search module is activated in Azure Redis |
The redisEnterprise resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
To create a Microsoft.Cache/redisEnterprise resource, add the following Terraform to your template.
Terraform
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Cache/redisEnterprise@2024-09-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
zones = [
"string"
]
body = jsonencode({
properties = {
encryption = {
customerManagedKeyEncryption = {
keyEncryptionKeyIdentity = {
identityType = "string"
userAssignedIdentityResourceId = "string"
}
keyEncryptionKeyUrl = "string"
}
}
highAvailability = "string"
minimumTlsVersion = "string"
}
})
}
| Name | Description | Value |
|---|---|---|
| encryption | Encryption-at-rest configuration for the cluster. | ClusterPropertiesEncryption |
| highAvailability | Enabled by default. If highAvailability is disabled, the data set is not replicated. This affects the availability SLA, and increases the risk of data loss. | 'Disabled' 'Enabled' |
| minimumTlsVersion | The minimum TLS version for the cluster to support, e.g. '1.2'. Newer versions can be added in the future. Note that TLS 1.0 and TLS 1.1 are now completely obsolete -- you cannot use them. They are mentioned only for the sake of consistency with old API versions. | '1.0' '1.1' '1.2' |
| Name | Description | Value |
|---|---|---|
| customerManagedKeyEncryption | All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. | ClusterPropertiesEncryptionCustomerManagedKeyEncryption |
| Name | Description | Value |
|---|---|---|
| keyEncryptionKeyIdentity | All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. | ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity |
| keyEncryptionKeyUrl | Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 | string |
| Name | Description | Value |
|---|---|---|
| identityType | Only userAssignedIdentity is supported in this API version; other types may be supported in the future | 'systemAssignedIdentity' 'userAssignedIdentity' |
| userAssignedIdentityResourceId | User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/<sub uuid>/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. | string |
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
| Name | Description | Value |
|---|---|---|
| identity | The identity of the resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[A-Za-z0-9]{1,60}$ (required) |
| properties | Other properties of the cluster. | ClusterProperties |
| sku | The SKU to create, which affects price, performance, and features. | Sku (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Cache/redisEnterprise@2024-09-01-preview" |
| zones | The Availability Zones where this cluster will be deployed. | string[] |
| Name | Description | Value |
|---|---|---|
| capacity | This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs. | int |
| name | The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. | 'Balanced_B0' 'Balanced_B1' 'Balanced_B10' 'Balanced_B100' 'Balanced_B1000' 'Balanced_B150' 'Balanced_B20' 'Balanced_B250' 'Balanced_B3' 'Balanced_B350' 'Balanced_B5' 'Balanced_B50' 'Balanced_B500' 'Balanced_B700' 'ComputeOptimized_X10' 'ComputeOptimized_X100' 'ComputeOptimized_X150' 'ComputeOptimized_X20' 'ComputeOptimized_X250' 'ComputeOptimized_X3' 'ComputeOptimized_X350' 'ComputeOptimized_X5' 'ComputeOptimized_X50' 'ComputeOptimized_X500' 'ComputeOptimized_X700' 'EnterpriseFlash_F1500' 'EnterpriseFlash_F300' 'EnterpriseFlash_F700' 'Enterprise_E1' 'Enterprise_E10' 'Enterprise_E100' 'Enterprise_E20' 'Enterprise_E200' 'Enterprise_E400' 'Enterprise_E5' 'Enterprise_E50' 'FlashOptimized_A1000' 'FlashOptimized_A1500' 'FlashOptimized_A2000' 'FlashOptimized_A250' 'FlashOptimized_A4500' 'FlashOptimized_A500' 'FlashOptimized_A700' 'MemoryOptimized_M10' 'MemoryOptimized_M100' 'MemoryOptimized_M1000' 'MemoryOptimized_M150' 'MemoryOptimized_M1500' 'MemoryOptimized_M20' 'MemoryOptimized_M2000' 'MemoryOptimized_M250' 'MemoryOptimized_M350' 'MemoryOptimized_M50' 'MemoryOptimized_M500' 'MemoryOptimized_M700' (required) |
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|
| Name | Description | Value |
|---|