Microsoft.Cache redisEnterprise 2024-10-01

아티클
12/09/2024

Bicep resource definition

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.

Resource format

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

resource symbolicname 'Microsoft.Cache/redisEnterprise@2024-10-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    encryption: {
      customerManagedKeyEncryption: {
        keyEncryptionKeyIdentity: {
          identityType: 'string'
          userAssignedIdentityResourceId: 'string'
        }
        keyEncryptionKeyUrl: 'string'
      }
    }
    minimumTlsVersion: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Property values

ClusterProperties

Name	Description	Value
encryption	Encryption-at-rest configuration for the cluster.	ClusterPropertiesEncryption
minimumTlsVersion	The minimum TLS version for the cluster to support, e.g. '1.2'	'1.0' '1.1' '1.2'

ClusterPropertiesEncryption

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

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

ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity

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

ManagedServiceIdentity

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

Microsoft.Cache/redisEnterprise

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 = `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$` (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[]

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_E1' 'Enterprise_E10' 'Enterprise_E100' 'Enterprise_E20' 'Enterprise_E200' 'Enterprise_E400' 'Enterprise_E5' 'Enterprise_E50' (required)

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

Quickstart samples

The following quickstart samples deploy 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:

Resource groups - See resource group deployment commands

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": "2024-10-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "encryption": {
      "customerManagedKeyEncryption": {
        "keyEncryptionKeyIdentity": {
          "identityType": "string",
          "userAssignedIdentityResourceId": "string"
        },
        "keyEncryptionKeyUrl": "string"
      }
    },
    "minimumTlsVersion": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Property values

ClusterProperties

Name	Description	Value
encryption	Encryption-at-rest configuration for the cluster.	ClusterPropertiesEncryption
minimumTlsVersion	The minimum TLS version for the cluster to support, e.g. '1.2'	'1.0' '1.1' '1.2'

ClusterPropertiesEncryption

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

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

ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity

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

ManagedServiceIdentity

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

Microsoft.Cache/redisEnterprise

Name	Description	Value
apiVersion	The api version	'2024-10-01'
identity	The identity of the resource.	ManagedServiceIdentity
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Pattern = `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$` (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[]

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_E1' 'Enterprise_E10' 'Enterprise_E100' 'Enterprise_E20' 'Enterprise_E200' 'Enterprise_E400' 'Enterprise_E5' 'Enterprise_E50' (required)

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

Quickstart templates

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

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@2024-10-01"
  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"
        }
      }
      minimumTlsVersion = "string"
    }
  })
}

Property values

ClusterProperties

Name	Description	Value
encryption	Encryption-at-rest configuration for the cluster.	ClusterPropertiesEncryption
minimumTlsVersion	The minimum TLS version for the cluster to support, e.g. '1.2'	'1.0' '1.1' '1.2'

ClusterPropertiesEncryption

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

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

ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity

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

ManagedServiceIdentity

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

Microsoft.Cache/redisEnterprise

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 = `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$` (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-10-01"
zones	The Availability 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_E1' 'Enterprise_E10' 'Enterprise_E100' 'Enterprise_E20' 'Enterprise_E200' 'Enterprise_E400' 'Enterprise_E5' 'Enterprise_E50' (required)

TrackedResourceTags

Name	Description	Value

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

다음을 통해 공유

Microsoft.Cache redisEnterprise 2024-10-01

Bicep resource definition

Resource format

Property values

ClusterProperties

ClusterPropertiesEncryption

ClusterPropertiesEncryptionCustomerManagedKeyEncryption

ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity

ManagedServiceIdentity

Microsoft.Cache/redisEnterprise

Sku

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Quickstart samples

ARM template resource definition

Resource format

Property values

ClusterProperties

ClusterPropertiesEncryption

ClusterPropertiesEncryptionCustomerManagedKeyEncryption

ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity

ManagedServiceIdentity

Microsoft.Cache/redisEnterprise

Sku

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

ClusterProperties

ClusterPropertiesEncryption

ClusterPropertiesEncryptionCustomerManagedKeyEncryption

ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity

ManagedServiceIdentity

Microsoft.Cache/redisEnterprise

Sku

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

피드백

추가 리소스