Share via


Microsoft.Cache redisEnterprise 2020-10-01-preview

Choose a deployment language

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.

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

Property Values

ClusterProperties

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

Microsoft.Cache/redisEnterprise

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (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 zones where this cluster will be deployed. 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)

TrackedResourceTags

Name Description Value

Usage Examples

Azure Verified Modules

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

Azure Quickstart Samples

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

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.

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

Property Values

ClusterProperties

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

Microsoft.Cache/redisEnterprise

Name Description Value
apiVersion The api version '2020-10-01-preview'
location The geo-location where the resource lives string (required)
name The resource name string (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 zones where this cluster will be deployed. 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)

TrackedResourceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure 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.

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

Property Values

ClusterProperties

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

Microsoft.Cache/redisEnterprise

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (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@2020-10-01-preview"
zones The zones where this cluster will be deployed. 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)

TrackedResourceTags

Name Description Value