你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.Cache redisEnterprise/databases 2023-10-01-preview
Bicep 资源定义
redisEnterprise/databases 资源类型可以通过针对以下操作进行部署:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Cache/redisEnterprise/databases 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Cache/redisEnterprise/databases@2023-10-01-preview' = {
name: 'string'
parent: resourceSymbolicName
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
}
}
属性值
redisEnterprise/databases
名称 | 说明 | 值 |
---|---|---|
name | 资源名称 了解如何在 Bicep 中为子资源设置名称和类型。 |
字符串 (必需) |
父级 (parent) | 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。 有关详细信息,请参阅 父资源之外的子资源。 |
类型为资源的符号名称: redisEnterprise |
properties | 数据库的其他属性。 | DatabaseProperties |
DatabaseProperties
名称 | 说明 | 值 |
---|---|---|
clientProtocol | 指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。 默认值为 TLS 加密。 | “Encrypted” “Plaintext” |
clusteringPolicy | 群集策略 - 默认值为 OSSCluster。 在创建时指定。 | “EnterpriseCluster” “OSSCluster” |
evictionPolicy | Redis 逐出策略 - 默认值为 VolatileLRU | “AllKeysLFU” “AllKeysLRU” “AllKeysRandom” “NoEviction” “VolatileLFU” “VolatileLRU” “VolatileRandom” “VolatileTTL” |
geoReplication | 用于为此数据库配置异地复制的可选属性集。 | DatabasePropertiesGeoReplication |
modules | 要在此数据库中启用的可选 redis 模块集 - 只能在创建时添加模块。 | Module[] |
persistence | 持久性设置 | 持久性 |
port | 数据库终结点的 TCP 端口。 在创建时指定。 默认为可用端口。 | int |
DatabasePropertiesGeoReplication
名称 | 说明 | 值 |
---|---|---|
groupNickname | 链接数据库资源组的名称 | string |
linkedDatabases | 要链接到此数据库的数据库资源列表 | LinkedDatabase[] |
LinkedDatabase
名称 | 说明 | Value |
---|---|---|
id | 要链接到此数据库的数据库资源的资源 ID。 | 字符串 |
模块
名称 | 说明 | 值 |
---|---|---|
args | 模块的配置选项,例如“ERROR_RATE 0.01 INITIAL_SIZE 400”。 | 字符串 |
name | 模块的名称,例如“RedisBloom”、“RediSearch”、“RedisTimeSeries” | 字符串 (必需) |
持久性
名称 | 说明 | 值 |
---|---|---|
aofEnabled | 设置是否启用 AOF。 | bool |
aofFrequency | 设置将数据写入磁盘的频率。 | “1s” “always” |
rdbEnabled | 设置是否启用 RDB。 | bool |
rdbFrequency | 设置创建数据库快照的频率。 | “12h” “1h” “6h” |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 说明 |
---|---|
Redis Enterprise with Vector DB |
此模板创建一个 Redis 缓存,该缓存可用作矢量 DB,通过索引存储和查询嵌入内容。 对于此功能,Redis 搜索模块已在 Azure Redis 中激活 |
ARM 模板资源定义
redisEnterprise/databases 资源类型可以通过针对以下操作进行部署:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Cache/redisEnterprise/databases 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Cache/redisEnterprise/databases",
"apiVersion": "2023-10-01-preview",
"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"
}
}
属性值
redisEnterprise/databases
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.Cache/redisEnterprise/databases” |
apiVersion | 资源 API 版本 | “2023-10-01-preview” |
name | 资源名称 了解如何在 JSON ARM 模板中为子资源设置名称和类型。 |
字符串 (必需) |
properties | 数据库的其他属性。 | DatabaseProperties |
DatabaseProperties
名称 | 说明 | 值 |
---|---|---|
clientProtocol | 指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。 默认值为 TLS 加密。 | “Encrypted” “Plaintext” |
clusteringPolicy | 群集策略 - 默认值为 OSSCluster。 在创建时指定。 | “EnterpriseCluster” “OSSCluster” |
evictionPolicy | Redis 逐出策略 - 默认值为 VolatileLRU | “AllKeysLFU” “AllKeysLRU” “AllKeysRandom” “NoEviction” “VolatileLFU” “VolatileLRU” “VolatileRandom” “VolatileTTL” |
geoReplication | 用于为此数据库配置异地复制的可选属性集。 | DatabasePropertiesGeoReplication |
modules | 要在此数据库中启用的可选 redis 模块集 - 只能在创建时添加模块。 | Module[] |
persistence | 持久性设置 | 持久性 |
port | 数据库终结点的 TCP 端口。 在创建时指定。 默认为可用端口。 | int |
DatabasePropertiesGeoReplication
名称 | 说明 | 值 |
---|---|---|
groupNickname | 链接数据库资源组的名称 | string |
linkedDatabases | 要链接到此数据库的数据库资源列表 | LinkedDatabase[] |
LinkedDatabase
名称 | 说明 | Value |
---|---|---|
id | 要链接到此数据库的数据库资源的资源 ID。 | string |
模块
名称 | 说明 | 值 |
---|---|---|
args | 模块的配置选项,例如“ERROR_RATE 0.01 INITIAL_SIZE 400”。 | string |
name | 模块的名称,例如“RedisBloom”、“RediSearch”、“RedisTimeSeries” | 字符串 (必需) |
持久性
名称 | 说明 | 值 |
---|---|---|
aofEnabled | 设置是否启用 AOF。 | bool |
aofFrequency | 设置将数据写入磁盘的频率。 | “1s” “always” |
rdbEnabled | 设置是否启用 RDB。 | bool |
rdbFrequency | 设置创建数据库快照的频率。 | “12h” “1h” “6h” |
快速入门模板
以下快速入门模板部署此资源类型。
模板 | 说明 |
---|---|
Redis Enterprise with Vector DB |
此模板创建一个 Redis 缓存,该缓存可用作通过索引存储和查询嵌入的矢量 DB。 对于此功能,Redis 搜索模块已在 Azure Redis 中激活 |
Terraform (AzAPI 提供程序) 资源定义
redisEnterprise/databases 资源类型可以使用面向以下对象的操作进行部署:
- 资源组
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Cache/redisEnterprise/databases 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Cache/redisEnterprise/databases@2023-10-01-preview"
name = "string"
parent_id = "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
}
})
}
属性值
redisEnterprise/databases
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.Cache/redisEnterprise/databases@2023-10-01-preview” |
name | 资源名称 | 字符串 (必需) |
parent_id | 此资源的父资源的 ID。 | 类型为:redisEnterprise 的资源的 ID |
properties | 数据库的其他属性。 | DatabaseProperties |
DatabaseProperties
名称 | 说明 | 值 |
---|---|---|
clientProtocol | 指定 redis 客户端是否可以使用 TLS 加密或纯文本 redis 协议进行连接。 默认为 TLS 加密。 | “Encrypted” “Plaintext” |
clusteringPolicy | 群集策略 - 默认值为 OSSCluster。 在创建时指定。 | “EnterpriseCluster” “OSSCluster” |
evictionPolicy | Redis 逐出策略 - 默认值为 VolatileLRU | “AllKeysLFU” “AllKeysLRU” “AllKeysRandom” “NoEviction” “VolatileLFU” “VolatileLRU” “VolatileRandom” “VolatileTTL” |
geoReplication | 用于为此数据库配置异地复制的可选属性集。 | DatabasePropertiesGeoReplication |
modules | 要在此数据库中启用的可选 redis 模块集 - 只能在创建时添加模块。 | Module[] |
persistence | 持久性设置 | 持久性 |
port | 数据库终结点的 TCP 端口。 在创建时指定。 默认为可用端口。 | int |
DatabasePropertiesGeoReplication
名称 | 说明 | 值 |
---|---|---|
groupNickname | 链接数据库资源组的名称 | string |
linkedDatabases | 要链接到此数据库的数据库资源列表 | LinkedDatabase[] |
LinkedDatabase
名称 | 说明 | Value |
---|---|---|
id | 要链接到此数据库的数据库资源的资源 ID。 | 字符串 |
模块
名称 | 说明 | 值 |
---|---|---|
args | 模块的配置选项,例如“ERROR_RATE 0.01 INITIAL_SIZE 400”。 | 字符串 |
name | 模块的名称,例如“RedisBloom”、“RediSearch”、“RedisTimeSeries” | 字符串 (必需) |
持久性
名称 | 说明 | 值 |
---|---|---|
aofEnabled | 设置是否启用 AOF。 | bool |
aofFrequency | 设置将数据写入磁盘的频率。 | “1s” "always" |
rdbEnabled | 设置是否启用 RDB。 | bool |
rdbFrequency | 设置创建数据库快照的频率。 | “12h” “1h” “6h” |