通过

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

Microsoft.Cache redisEnterprise/databases 2023-07-01

  • 项目

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.Cache/redisEnterprise/databases@2023-07-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    clientProtocol: 'string'
    clusteringPolicy: 'string'
    evictionPolicy: 'string'
    geoReplication: {
      groupNickname: 'string'
      linkedDatabases: [
        {
          id: 'string'
        }
      ]
    }
    modules: [
      {
        args: 'string'
        name: 'string'
      }
    ]
    persistence: {
      aofEnabled: bool
      aofFrequency: 'string'
      rdbEnabled: bool
      rdbFrequency: 'string'
    }
    port: int
  }
}

属性值

DatabaseProperties

名字 描述 价值
clientProtocol 指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。 默认值为 TLS 加密。 “Encrypted”
“纯文本”
clusteringPolicy 群集策略 - 默认值为 OSSCluster。 在创建时指定。 “EnterpriseCluster”
“OSSCluster”
evictionPolicy Redis 逐出策略 - 默认值为 VolatileLRU “AllKeysLFU”
“AllKeysLRU”
“AllKeysRandom”
“NoEviction”
“VolatileLFU”
“VolatileLRU”
“VolatileRandom”
“VolatileTTL”
geoReplication 用于为此数据库配置异地复制的可选属性集。 DatabasePropertiesGeoReplication
模块 在此数据库中启用的可选 redis 模块集 - 只能在创建时添加模块。 模块[]
坚持 持久性设置 持久性
港口 数据库终结点的 TCP 端口。 在创建时指定。 默认为可用端口。 int

DatabasePropertiesGeoReplication

名字 描述 价值
groupNickname 链接数据库资源组的名称 字符串
linkedDatabases 要链接到此数据库的数据库资源列表 LinkedDatabase[]

LinkedDatabase

名字 描述 价值
id 要链接到此数据库的数据库资源的资源 ID。 字符串

Microsoft.Cache/redisEnterprise/databases

名字 描述 价值
名字 资源名称 string （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：redisEnterprise
性能 数据库的其他属性。 DatabaseProperties

模块

名字 描述 价值
args 模块的配置选项，例如“ERROR_RATE 0.01 INITIAL_SIZE 400”。 字符串
名字 模块的名称，例如“RedisBloom”、“RediSearch”、“RedisTimeSeries” string （必需）

坚持

名字 描述 价值
aofEnabled 设置是否启用 AOF。 bool
aofFrequency 设置将数据写入磁盘的频率。 “1s”
“always”
rdbEnabled 设置是否启用 RDB。 bool
rdbFrequency 设置创建数据库快照的频率。 “12h”
“1h”
“6h”

快速入门示例

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

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

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.Cache/redisEnterprise/databases",
  "apiVersion": "2023-07-01",
  "name": "string",
  "properties": {
    "clientProtocol": "string",
    "clusteringPolicy": "string",
    "evictionPolicy": "string",
    "geoReplication": {
      "groupNickname": "string",
      "linkedDatabases": [
        {
          "id": "string"
        }
      ]
    },
    "modules": [
      {
        "args": "string",
        "name": "string"
      }
    ],
    "persistence": {
      "aofEnabled": "bool",
      "aofFrequency": "string",
      "rdbEnabled": "bool",
      "rdbFrequency": "string"
    },
    "port": "int"
  }
}

属性值

DatabaseProperties

名字 描述 价值
clientProtocol 指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。 默认值为 TLS 加密。 “Encrypted”
“纯文本”
clusteringPolicy 群集策略 - 默认值为 OSSCluster。 在创建时指定。 “EnterpriseCluster”
“OSSCluster”
evictionPolicy Redis 逐出策略 - 默认值为 VolatileLRU “AllKeysLFU”
“AllKeysLRU”
“AllKeysRandom”
“NoEviction”
“VolatileLFU”
“VolatileLRU”
“VolatileRandom”
“VolatileTTL”
geoReplication 用于为此数据库配置异地复制的可选属性集。 DatabasePropertiesGeoReplication
模块 在此数据库中启用的可选 redis 模块集 - 只能在创建时添加模块。 模块[]
坚持 持久性设置 持久性
港口 数据库终结点的 TCP 端口。 在创建时指定。 默认为可用端口。 int

DatabasePropertiesGeoReplication

名字 描述 价值
groupNickname 链接数据库资源组的名称 字符串
linkedDatabases 要链接到此数据库的数据库资源列表 LinkedDatabase[]

LinkedDatabase

名字 描述 价值
id 要链接到此数据库的数据库资源的资源 ID。 字符串

Microsoft.Cache/redisEnterprise/databases

名字 描述 价值
apiVersion API 版本 '2023-07-01'
名字 资源名称 string （必需）
性能 数据库的其他属性。 DatabaseProperties
类型 资源类型 “Microsoft.Cache/redisEnterprise/databases”

模块

名字 描述 价值
args 模块的配置选项，例如“ERROR_RATE 0.01 INITIAL_SIZE 400”。 字符串
名字 模块的名称，例如“RedisBloom”、“RediSearch”、“RedisTimeSeries” string （必需）

坚持

名字 描述 价值
aofEnabled 设置是否启用 AOF。 bool
aofFrequency 设置将数据写入磁盘的频率。 “1s”
“always”
rdbEnabled 设置是否启用 RDB。 bool
rdbFrequency 设置创建数据库快照的频率。 “12h”
“1h”
“6h”

快速入门模板

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

模板 描述
使用 Vector DB Redis Enterprise

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

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

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

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cache/redisEnterprise/databases@2023-07-01"
  name = "string"
  body = jsonencode({
    properties = {
      clientProtocol = "string"
      clusteringPolicy = "string"
      evictionPolicy = "string"
      geoReplication = {
        groupNickname = "string"
        linkedDatabases = [
          {
            id = "string"
          }
        ]
      }
      modules = [
        {
          args = "string"
          name = "string"
        }
      ]
      persistence = {
        aofEnabled = bool
        aofFrequency = "string"
        rdbEnabled = bool
        rdbFrequency = "string"
      }
      port = int
    }
  })
}

属性值

DatabaseProperties

名字 描述 价值
clientProtocol 指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。 默认值为 TLS 加密。 “Encrypted”
“纯文本”
clusteringPolicy 群集策略 - 默认值为 OSSCluster。 在创建时指定。 “EnterpriseCluster”
“OSSCluster”
evictionPolicy Redis 逐出策略 - 默认值为 VolatileLRU “AllKeysLFU”
“AllKeysLRU”
“AllKeysRandom”
“NoEviction”
“VolatileLFU”
“VolatileLRU”
“VolatileRandom”
“VolatileTTL”
geoReplication 用于为此数据库配置异地复制的可选属性集。 DatabasePropertiesGeoReplication
模块 在此数据库中启用的可选 redis 模块集 - 只能在创建时添加模块。 模块[]
坚持 持久性设置 持久性
港口 数据库终结点的 TCP 端口。 在创建时指定。 默认为可用端口。 int

DatabasePropertiesGeoReplication

名字 描述 价值
groupNickname 链接数据库资源组的名称 字符串
linkedDatabases 要链接到此数据库的数据库资源列表 LinkedDatabase[]

LinkedDatabase

名字 描述 价值
id 要链接到此数据库的数据库资源的资源 ID。 字符串

Microsoft.Cache/redisEnterprise/databases

名字 描述 价值
名字 资源名称 string （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：redisEnterprise
性能 数据库的其他属性。 DatabaseProperties
类型 资源类型 “Microsoft.Cache/redisEnterprise/databases@2023-07-01”

模块

名字 描述 价值
args 模块的配置选项，例如“ERROR_RATE 0.01 INITIAL_SIZE 400”。 字符串
名字 模块的名称，例如“RedisBloom”、“RediSearch”、“RedisTimeSeries” string （必需）

坚持

名字 描述 价值
aofEnabled 设置是否启用 AOF。 bool
aofFrequency 设置将数据写入磁盘的频率。 “1s”
“always”
rdbEnabled 设置是否启用 RDB。 bool
rdbFrequency 设置创建数据库快照的频率。 “12h”
“1h”
“6h”