Microsoft.Cache redisEnterprise 2020-10-01-preview

Bicep resource definition

The redisEnterprise resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cache/redisEnterprise resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Cache/redisEnterprise@2020-10-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  properties: {
    minimumTlsVersion: 'string'
  }
  zones: [
    'string'
  ]
}

Property values

redisEnterprise

Name Description Value
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The SKU to create, which affects price, performance, and features. Sku (required)
properties Other properties of the cluster. ClusterProperties
zones The zones where this cluster will be deployed. string[]

ClusterProperties

Name Description Value
minimumTlsVersion The minimum TLS version for the cluster to support, e.g. '1.2' string

Sku

Name Description Value
capacity The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs. int
name The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.) 'EnterpriseFlash_F1500'
'EnterpriseFlash_F300'
'EnterpriseFlash_F700'
'Enterprise_E10'
'Enterprise_E100'
'Enterprise_E20'
'Enterprise_E50' (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Redis Enterprise with Vector DB

Deploy to Azure
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

ARM template resource definition

The redisEnterprise resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cache/redisEnterprise resource, add the following JSON to your template.

{
  "type": "Microsoft.Cache/redisEnterprise",
  "apiVersion": "2020-10-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "properties": {
    "minimumTlsVersion": "string"
  },
  "zones": [ "string" ]
}

Property values

redisEnterprise

Name Description Value
type The resource type 'Microsoft.Cache/redisEnterprise'
apiVersion The resource api version '2020-10-01-preview'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The SKU to create, which affects price, performance, and features. Sku (required)
properties Other properties of the cluster. ClusterProperties
zones The zones where this cluster will be deployed. string[]

ClusterProperties

Name Description Value
minimumTlsVersion The minimum TLS version for the cluster to support, e.g. '1.2' string

Sku

Name Description Value
capacity The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs. int
name The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.) 'EnterpriseFlash_F1500'
'EnterpriseFlash_F300'
'EnterpriseFlash_F700'
'Enterprise_E10'
'Enterprise_E100'
'Enterprise_E20'
'Enterprise_E50' (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Redis Enterprise with Vector DB

Deploy to Azure
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

Terraform (AzAPI provider) resource definition

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.

Resource format

To create a Microsoft.Cache/redisEnterprise resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cache/redisEnterprise@2020-10-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      minimumTlsVersion = "string"
    }
    zones = [
      "string"
    ]
    sku = {
      capacity = int
      name = "string"
    }
  })
}

Property values

redisEnterprise

Name Description Value
type The resource type "Microsoft.Cache/redisEnterprise@2020-10-01-preview"
name The resource name string (required)
location The geo-location where the resource lives string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
sku The SKU to create, which affects price, performance, and features. Sku (required)
properties Other properties of the cluster. ClusterProperties
zones The zones where this cluster will be deployed. string[]

ClusterProperties

Name Description Value
minimumTlsVersion The minimum TLS version for the cluster to support, e.g. '1.2' string

Sku

Name Description Value
capacity The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs. int
name The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.) "EnterpriseFlash_F1500"
"EnterpriseFlash_F300"
"EnterpriseFlash_F700"
"Enterprise_E10"
"Enterprise_E100"
"Enterprise_E20"
"Enterprise_E50" (required)