你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Cache redisEnterprise 2024-06-01-preview

• 最新
• 2024-10-01
• 2024-09-01-preview
• 2024-06-01-preview
• 2024-03-01-preview
• 2024-02-01
• 2023-11-01
• 2023-10-01-preview
• 2023-08-01-preview
• 2023-07-01
• 2023-03-01-preview
• 2022-11-01-preview
• 2022-01-01
• 2021-08-01
• 2021-03-01
• 2021-02-01-preview
• 2020-10-01-preview

Bicep 资源定义

可以使用目标操作部署 redisEnterprise 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Cache/redisEnterprise 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Cache/redisEnterprise@2024-06-01-preview' = {
  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'
  ]
}

属性值

ClusterProperties

名字	描述	价值
加密	群集的静态加密配置。	ClusterPropertiesEncryption
minimumTlsVersion	要支持的群集的最低 TLS 版本，例如“1.2”	'1.0' '1.1' '1.2'

ClusterPropertiesEncryption

名字	描述	价值
customerManagedKeyEncryption	资源的所有客户管理的密钥加密属性。 将此设置为空对象，以使用Microsoft管理的密钥加密。	ClusterPropertiesEncryptionCustomerManagedKeyEncryption

ClusterPropertiesEncryptionCustomerManagedKeyEncryption

名字	描述	价值
keyEncryptionKeyIdentity	客户管理的密钥设置的所有标识配置，用于定义应用于向 Key Vault 进行身份验证的标识。	ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity
keyEncryptionKeyUrl	密钥加密密钥 URL，仅版本控制。 例如：https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78	字符串

ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity

名字	描述	价值
identityType	此 API 版本仅支持 userAssignedIdentity;将来可能支持其他类型的	“systemAssignedIdentity” “userAssignedIdentity”
userAssignedIdentityResourceId	用户分配的标识用于访问密钥加密密钥 URL。 例如：/subscriptions/<sub uuid>/resourceGroups/<资源组>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId。	字符串

ManagedServiceIdentity

名字	描述	价值
类型	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”（必需）
userAssignedIdentities	与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象（{}）。	UserAssignedIdentities

Microsoft.Cache/redisEnterprise

名字	描述	价值
身份	资源的标识。	ManagedServiceIdentity
位置	资源所在的地理位置	string （必需）
名字	资源名称	字符串 约束： 模式 = ^[A-Za-z0-9]{1,60}$ （必需）
性能	群集的其他属性。	ClusterProperties
sku	要创建的 SKU 会影响价格、性能和功能。	Sku（必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
区	将部署此群集的可用性区域。	string[]

Sku

名字	描述	价值
能力	RedisEnterprise 群集的大小。 默认为 2 或 3，具体取决于 SKU。 对于企业 SKU，有效值为（2、4、6、...），对于 Flash SKU 为 （3、9、15、...）。	int
名字	要部署的 RedisEnterprise 群集的类型。 可能的值：（Enterprise_E10、EnterpriseFlash_F300等）	“EnterpriseFlash_F1500” “EnterpriseFlash_F300” “EnterpriseFlash_F700” “Enterprise_E1” “Enterprise_E10” “Enterprise_E100” “Enterprise_E20” “Enterprise_E5” “Enterprise_E50”（必需）

TrackedResourceTags

名字	描述	价值

UserAssignedIdentities

名字	描述	价值

UserAssignedIdentity

名字	描述	价值

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
使用 Vector DB Redis Enterprise	此模板创建一个 Redis 缓存，该缓存可用作 Vector DB，用于通过索引存储和查询嵌入。 对于此功能，Redis 搜索模块在 Azure Redis 中激活

ARM 模板资源定义

可以使用目标操作部署 redisEnterprise 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Cache/redisEnterprise 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Cache/redisEnterprise",
  "apiVersion": "2024-06-01-preview",
  "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" ]
}

属性值

ClusterProperties

名字	描述	价值
加密	群集的静态加密配置。	ClusterPropertiesEncryption
minimumTlsVersion	要支持的群集的最低 TLS 版本，例如“1.2”	'1.0' '1.1' '1.2'

ClusterPropertiesEncryption

名字	描述	价值
customerManagedKeyEncryption	资源的所有客户管理的密钥加密属性。 将此设置为空对象，以使用Microsoft管理的密钥加密。	ClusterPropertiesEncryptionCustomerManagedKeyEncryption

ClusterPropertiesEncryptionCustomerManagedKeyEncryption

名字	描述	价值
keyEncryptionKeyIdentity	客户管理的密钥设置的所有标识配置，用于定义应用于向 Key Vault 进行身份验证的标识。	ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity
keyEncryptionKeyUrl	密钥加密密钥 URL，仅版本控制。 例如：https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78	字符串

ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity

名字	描述	价值
identityType	此 API 版本仅支持 userAssignedIdentity;将来可能支持其他类型的	“systemAssignedIdentity” “userAssignedIdentity”
userAssignedIdentityResourceId	用户分配的标识用于访问密钥加密密钥 URL。 例如：/subscriptions/<sub uuid>/resourceGroups/<资源组>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId。	字符串

ManagedServiceIdentity

名字	描述	价值
类型	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”（必需）
userAssignedIdentities	与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象（{}）。	UserAssignedIdentities

Microsoft.Cache/redisEnterprise

名字	描述	价值
apiVersion	API 版本	'2024-06-01-preview'
身份	资源的标识。	ManagedServiceIdentity
位置	资源所在的地理位置	string （必需）
名字	资源名称	字符串 约束： 模式 = ^[A-Za-z0-9]{1,60}$ （必需）
性能	群集的其他属性。	ClusterProperties
sku	要创建的 SKU 会影响价格、性能和功能。	Sku（必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.Cache/redisEnterprise”
区	将部署此群集的可用性区域。	string[]

Sku

名字	描述	价值
能力	RedisEnterprise 群集的大小。 默认为 2 或 3，具体取决于 SKU。 对于企业 SKU，有效值为（2、4、6、...），对于 Flash SKU 为 （3、9、15、...）。	int
名字	要部署的 RedisEnterprise 群集的类型。 可能的值：（Enterprise_E10、EnterpriseFlash_F300等）	“EnterpriseFlash_F1500” “EnterpriseFlash_F300” “EnterpriseFlash_F700” “Enterprise_E1” “Enterprise_E10” “Enterprise_E100” “Enterprise_E20” “Enterprise_E5” “Enterprise_E50”（必需）

TrackedResourceTags

名字	描述	价值

UserAssignedIdentities

名字	描述	价值

UserAssignedIdentity

名字	描述	价值

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
使用 Vector DB Redis Enterprise	此模板创建一个 Redis 缓存，该缓存可用作 Vector DB，用于通过索引存储和查询嵌入。 对于此功能，Redis 搜索模块在 Azure Redis 中激活

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 redisEnterprise 资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Cache/redisEnterprise 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cache/redisEnterprise@2024-06-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"
        }
      }
      minimumTlsVersion = "string"
    }
  })
}

属性值

ClusterProperties

名字	描述	价值
加密	群集的静态加密配置。	ClusterPropertiesEncryption
minimumTlsVersion	要支持的群集的最低 TLS 版本，例如“1.2”	'1.0' '1.1' '1.2'

ClusterPropertiesEncryption

名字	描述	价值
customerManagedKeyEncryption	资源的所有客户管理的密钥加密属性。 将此设置为空对象，以使用Microsoft管理的密钥加密。	ClusterPropertiesEncryptionCustomerManagedKeyEncryption

ClusterPropertiesEncryptionCustomerManagedKeyEncryption

名字	描述	价值
keyEncryptionKeyIdentity	客户管理的密钥设置的所有标识配置，用于定义应用于向 Key Vault 进行身份验证的标识。	ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity
keyEncryptionKeyUrl	密钥加密密钥 URL，仅版本控制。 例如：https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78	字符串

ClusterPropertiesEncryptionCustomerManagedKeyEncryptionKeyIdentity

名字	描述	价值
identityType	此 API 版本仅支持 userAssignedIdentity;将来可能支持其他类型的	“systemAssignedIdentity” “userAssignedIdentity”
userAssignedIdentityResourceId	用户分配的标识用于访问密钥加密密钥 URL。 例如：/subscriptions/<sub uuid>/resourceGroups/<资源组>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId。	字符串

ManagedServiceIdentity

名字	描述	价值
类型	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”（必需）
userAssignedIdentities	与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象（{}）。	UserAssignedIdentities

Microsoft.Cache/redisEnterprise

名字	描述	价值
身份	资源的标识。	ManagedServiceIdentity
位置	资源所在的地理位置	string （必需）
名字	资源名称	字符串 约束： 模式 = ^[A-Za-z0-9]{1,60}$ （必需）
性能	群集的其他属性。	ClusterProperties
sku	要创建的 SKU 会影响价格、性能和功能。	Sku（必需）
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Cache/redisEnterprise@2024-06-01-preview”
区	将部署此群集的可用性区域。	string[]

Sku

名字	描述	价值
能力	RedisEnterprise 群集的大小。 默认为 2 或 3，具体取决于 SKU。 对于企业 SKU，有效值为（2、4、6、...），对于 Flash SKU 为 （3、9、15、...）。	int
名字	要部署的 RedisEnterprise 群集的类型。 可能的值：（Enterprise_E10、EnterpriseFlash_F300等）	“EnterpriseFlash_F1500” “EnterpriseFlash_F300” “EnterpriseFlash_F700” “Enterprise_E1” “Enterprise_E10” “Enterprise_E100” “Enterprise_E20” “Enterprise_E5” “Enterprise_E50”（必需）

TrackedResourceTags

名字	描述	价值

UserAssignedIdentities

名字	描述	价值

UserAssignedIdentity

名字	描述	价值