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

Microsoft.Cache redisEnterprise 2023-10-01-preview

Bicep 资源定义

redisEnterprise 资源类型可以使用面向以下对象的操作进行部署:

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

资源格式

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

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

属性值

redisEnterprise

名称 说明
name 资源名称 字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 要创建的 SKU,这会影响价格、性能和功能。 需要 sku ()
标识 资源的标识。 ManagedServiceIdentity
properties 群集的其他属性。 ClusterProperties
zones 部署此群集可用性区域。 string[]

ManagedServiceIdentity

名称 说明 Value
type ) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。 “None”
“SystemAssigned”
“SystemAssigned, UserAssigned”
“UserAssigned” (必需)
userAssignedIdentities 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将是采用以下格式的 ARM 资源 ID:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是请求中) ({} 空对象。 UserAssignedIdentities

UserAssignedIdentities

名称 说明
{customized property} UserAssignedIdentity

UserAssignedIdentity

此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。

ClusterProperties

名称 说明
加密 群集的静态加密配置。 ClusterPropertiesEncryption
minimumTlsVersion 要支持的群集的最低 TLS 版本,例如“1.2” '1.0'
'1.1'
'1.2'

ClusterPropertiesEncryption

名称 说明
customerManagedKeyEncryption 资源的所有客户管理的密钥加密属性。 将此设置为空对象以使用 Microsoft 管理的密钥加密。 ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

名称 说明
keyEncryptionKeyIdentity 客户管理的密钥设置的所有标识配置,定义应使用哪个标识对密钥保管库进行身份验证。 ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...
keyEncryptionKeyUrl 密钥加密密钥 URL,仅限版本控制。 示例:https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 字符串

ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

名称 说明
IdentityType 此 API 版本仅支持 userAssignedIdentity;将来可能支持其他类型 “systemAssignedIdentity”
“userAssignedIdentity”
userAssignedIdentityResourceId 用户分配的标识,用于访问密钥加密密钥 URL。 例如:/subscriptions/{sub uuid}/resourceGroups/{resource group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId。 字符串

SKU

名称 说明
容量 RedisEnterprise 群集的大小。 默认值为 2 或 3,具体取决于 SKU。 对于企业 SKU,有效值为 (2、4、6、...) ,Flash SKU 的有效值为 (3、9、15、...) 。 int
name 要部署的 RedisEnterprise 群集的类型。 可能的值: (Enterprise_E10、EnterpriseFlash_F300等 ) “EnterpriseFlash_F1500”
“EnterpriseFlash_F300”
“EnterpriseFlash_F700”
“Enterprise_E10”
“Enterprise_E100”
“Enterprise_E20”
“Enterprise_E200”
“Enterprise_E400”
“Enterprise_E5”
需要“Enterprise_E50” ()

快速入门模板

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

模板 说明
Redis Enterprise with Vector DB

部署到 Azure
此模板创建一个 Redis 缓存,该缓存可用作通过索引存储和查询嵌入的矢量 DB。 对于此功能,Redis 搜索模块已在 Azure Redis 中激活

ARM 模板资源定义

redisEnterprise 资源类型可以使用面向以下对象的操作进行部署:

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

资源格式

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

{
  "type": "Microsoft.Cache/redisEnterprise",
  "apiVersion": "2023-10-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "encryption": {
      "customerManagedKeyEncryption": {
        "keyEncryptionKeyIdentity": {
          "identityType": "string",
          "userAssignedIdentityResourceId": "string"
        },
        "keyEncryptionKeyUrl": "string"
      }
    },
    "minimumTlsVersion": "string"
  },
  "zones": [ "string" ]
}

属性值

redisEnterprise

名称 说明 Value
type 资源类型 “Microsoft.Cache/redisEnterprise”
apiVersion 资源 API 版本 '2023-10-01-preview'
name 资源名称 字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 要创建的 SKU,这会影响价格、性能和功能。 需要 sku ()
标识 资源的标识。 ManagedServiceIdentity
properties 群集的其他属性。 ClusterProperties
zones 部署此群集可用性区域。 string[]

ManagedServiceIdentity

名称 说明 Value
type ) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。 “None”
“SystemAssigned”
“SystemAssigned, UserAssigned”
“UserAssigned” (必需)
userAssignedIdentities 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将是采用以下格式的 ARM 资源 ID:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是请求中) ({} 空对象。 UserAssignedIdentities

UserAssignedIdentities

名称 说明
{customized property} UserAssignedIdentity

UserAssignedIdentity

此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。

ClusterProperties

名称 说明
加密 群集的静态加密配置。 ClusterPropertiesEncryption
minimumTlsVersion 群集支持的最低 TLS 版本,例如“1.2” '1.0'
'1.1'
'1.2'

ClusterPropertiesEncryption

名称 说明
customerManagedKeyEncryption 资源的所有客户管理的密钥加密属性。 将此设置为空对象以使用 Microsoft 管理的密钥加密。 ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

名称 说明
keyEncryptionKeyIdentity 客户管理的密钥设置的所有标识配置,定义应使用哪个标识进行身份验证密钥保管库。 ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...
keyEncryptionKeyUrl 密钥加密密钥 URL,仅限版本。 示例:https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 字符串

ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

名称 说明
IdentityType 此 API 版本仅支持 userAssignedIdentity;将来可能支持其他类型 “systemAssignedIdentity”
“userAssignedIdentity”
userAssignedIdentityResourceId 用户分配的标识用于访问密钥加密密钥 URL。 例如:/subscriptions/{sub uuid}/resourceGroups/{resource group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId。 字符串

SKU

名称 说明
容量 RedisEnterprise 群集的大小。 默认为 2 或 3,具体取决于 SKU。 对于企业 SKU,有效值为 (2、4、6、...) ,Flash SKU 的有效值为 (3、9、15、...) 。 int
name 要部署的 RedisEnterprise 群集的类型。 可能的值: (Enterprise_E10、EnterpriseFlash_F300等 ) “EnterpriseFlash_F1500”
“EnterpriseFlash_F300”
“EnterpriseFlash_F700”
“Enterprise_E10”
“Enterprise_E100”
“Enterprise_E20”
“Enterprise_E200”
“Enterprise_E400”
“Enterprise_E5”
“Enterprise_E50” (必需)

快速入门模板

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

模板 说明
Redis Enterprise with Vector DB

部署到 Azure
此模板创建一个 Redis 缓存,该缓存可用作矢量 DB,通过索引存储和查询嵌入内容。 对于此功能,Redis 搜索模块已在 Azure Redis 中激活

Terraform (AzAPI 提供程序) 资源定义

redisEnterprise 资源类型可以通过针对以下操作进行部署:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cache/redisEnterprise@2023-10-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      encryption = {
        customerManagedKeyEncryption = {
          keyEncryptionKeyIdentity = {
            identityType = "string"
            userAssignedIdentityResourceId = "string"
          }
          keyEncryptionKeyUrl = "string"
        }
      }
      minimumTlsVersion = "string"
    }
    zones = [
      "string"
    ]
    sku = {
      capacity = int
      name = "string"
    }
  })
}

属性值

redisEnterprise

名称 说明 Value
type 资源类型 “Microsoft.Cache/redisEnterprise@2023-10-01-preview”
name 资源名称 字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
parent_id 若要部署到资源组,请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
sku 要创建的 SKU,这会影响价格、性能和功能。 需要 sku ()
标识 资源的标识。 ManagedServiceIdentity
properties 群集的其他属性。 ClusterProperties
zones 部署此群集可用性区域。 string[]

ManagedServiceIdentity

名称 说明 Value
type ) 允许 SystemAssigned 和 UserAssigned 类型的托管服务标识 (的类型。 “SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned” (必需)
identity_ids 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将是采用以下格式的 ARM 资源 ID:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是请求中) ({} 空对象。 用户标识 ID 的数组。

UserAssignedIdentities

名称 说明
{customized property} UserAssignedIdentity

UserAssignedIdentity

此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。

ClusterProperties

名称 说明
加密 群集的静态加密配置。 ClusterPropertiesEncryption
minimumTlsVersion 要支持的群集的最低 TLS 版本,例如“1.2” "1.0"
"1.1"
"1.2"

ClusterPropertiesEncryption

名称 说明
customerManagedKeyEncryption 资源的所有客户管理的密钥加密属性。 将此设置为空对象以使用 Microsoft 管理的密钥加密。 ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

名称 说明
keyEncryptionKeyIdentity 客户管理的密钥设置的所有标识配置,定义应使用哪个标识对密钥保管库进行身份验证。 ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...
keyEncryptionKeyUrl 密钥加密密钥 URL,仅限版本控制。 示例:https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 string

ClusterPropertiesEncryptionCustomerManagedKeyEncrypt...

名称 说明
IdentityType 此 API 版本仅支持 userAssignedIdentity;将来可能支持其他类型 “systemAssignedIdentity”
“userAssignedIdentity”
userAssignedIdentityResourceId 用户分配的标识,用于访问密钥加密密钥 URL。 例如:/subscriptions/{sub uuid}/resourceGroups/{resource group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId。 string

SKU

名称 说明
容量 RedisEnterprise 群集的大小。 默认值为 2 或 3,具体取决于 SKU。 对于企业 SKU,有效值为 (2、4、6、...) ,Flash SKU 的有效值为 (3、9、15、...) 。 int
name 要部署的 RedisEnterprise 群集的类型。 可能的值: (Enterprise_E10、EnterpriseFlash_F300等 ) “EnterpriseFlash_F1500”
“EnterpriseFlash_F300”
“EnterpriseFlash_F700”
“Enterprise_E10”
“Enterprise_E100”
“Enterprise_E20”
“Enterprise_E200”
“Enterprise_E400”
“Enterprise_E5”
“Enterprise_E50” (必需)