Databases - Create
创建数据库
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}?api-version=2026-09-01
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
cluster
|
path | True |
string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ |
Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符 |
|
database
|
path | True |
string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ |
Redis Enterprise 数据库的名称。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
资源组的名称。 此名称不区分大小写。 |
|
subscription
|
path | True |
string (uuid) |
目标订阅的 ID。 该值必须是 UUID。 |
|
api-version
|
query | True |
string minLength: 1 |
用于此操作的 API 版本。 |
请求正文
| 名称 | 类型 | 说明 |
|---|---|---|
| properties.accessKeysAuthentication |
此属性可以启用/禁用,以允许或拒绝使用当前访问密钥的访问。 即使在创建数据库后也可以更新。 默认值为 Disabled。 |
|
| properties.clientProtocol |
指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。 默认值为 TLS 加密。 |
|
| properties.clusteringPolicy |
群集策略 - 默认值为 OSSCluster。 仅当当前值为 NoCluster 时,才能更新此属性。 如果值为 OSSCluster 或 EnterpriseCluster,则不能在不删除数据库的情况下更新该值。 |
|
| properties.deferUpgrade |
发布最新版本时延迟升级的选项 - 默认值为 NotDeferred。 了解详细信息:https://aka.ms/redisversionupgrade |
|
| properties.evictionPolicy |
Redis 逐出策略 - 默认值为 VolatileLRU |
|
| properties.geoReplication |
用于为此数据库配置异地复制的可选属性集。 |
|
| properties.modules |
Module[] |
在此数据库中启用的可选 redis 模块集 - 只能在创建时添加模块。 |
| properties.notifyKeyspaceEvents |
string |
指定哪些密钥空间事件应触发通知。 默认是空字符串,意味着该功能被禁用。 启用时,至少必须有“K”(密钥空间事件)或“E”(密钥事件事件)。 例如,“AKE”启用所有标准事件。 完整活动类型列表请参见 https://redis.io/docs/latest/develop/use/keyspace-notifications/ 。 |
| properties.persistence |
持久性设置 |
|
| properties.port |
integer (int32) |
数据库终结点的 TCP 端口。 在创建时指定。 默认为可用端口。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
资源“数据库”更新作成功 |
|
| 201 Created |
资源“数据库”创建作成功 标头
|
|
| Other Status Codes |
未预期的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流程。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| user_impersonation | 冒充您的用户账户 |
示例
|
Redis |
|
Redis |
|
Redis |
RedisEnterpriseDatabasesCreate
示例请求
PUT https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2026-09-01
{
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Encrypted",
"clusteringPolicy": "EnterpriseCluster",
"deferUpgrade": "NotDeferred",
"evictionPolicy": "AllKeysLRU",
"notifyKeyspaceEvents": "KEA",
"modules": [
{
"name": "RedisBloom",
"args": "ERROR_RATE 0.00 INITIAL_SIZE 400"
},
{
"name": "RedisTimeSeries",
"args": "RETENTION_POLICY 20"
},
{
"name": "RediSearch"
}
],
"persistence": {
"aofEnabled": true,
"aofFrequency": "1s"
},
"port": 10000
}
}
示例响应
{
"name": "cache1/default",
"type": "Microsoft.Cache/redisEnterprise/databases",
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Encrypted",
"clusteringPolicy": "EnterpriseCluster",
"deferUpgrade": "NotDeferred",
"evictionPolicy": "AllKeysLRU",
"notifyKeyspaceEvents": "KEA",
"modules": [
{
"name": "RedisBloom",
"args": "ERROR_RATE 0.00 INITIAL_SIZE 400",
"version": "1.0.0"
},
{
"name": "RedisTimeSeries",
"args": "RETENTION_POLICY 20",
"version": "1.0.0"
},
{
"name": "RediSearch",
"args": "",
"version": "1.0.0"
}
],
"persistence": {
"aofEnabled": true,
"aofFrequency": "1s"
},
"port": 10000,
"provisioningState": "Updating",
"redisVersion": "6.0",
"resourceState": "Updating"
}
}
{
"name": "cache1/db1",
"type": "Microsoft.Cache/redisEnterprise/databases",
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/db1",
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Encrypted",
"clusteringPolicy": "EnterpriseCluster",
"evictionPolicy": "AllKeysLRU",
"notifyKeyspaceEvents": "KEA",
"modules": [
{
"name": "RedisBloom",
"args": "ERROR_RATE 0.00 INITIAL_SIZE 400",
"version": "1.0.0"
},
{
"name": "RedisTimeSeries",
"args": "RETENTION_POLICY 20",
"version": "1.0.0"
},
{
"name": "RediSearch",
"args": "",
"version": "1.0.0"
}
],
"persistence": {
"aofEnabled": true,
"aofFrequency": "1s"
},
"port": 10000,
"provisioningState": "Creating",
"resourceState": "Creating"
}
}
RedisEnterpriseDatabasesCreate No Cluster Cache
示例请求
PUT https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2026-09-01
{
"properties": {
"clientProtocol": "Encrypted",
"clusteringPolicy": "NoCluster",
"evictionPolicy": "NoEviction",
"notifyKeyspaceEvents": "",
"port": 10000
}
}
示例响应
{
"name": "cache1/default",
"type": "Microsoft.Cache/redisEnterprise/databases",
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Encrypted",
"clusteringPolicy": "NoCluster",
"deferUpgrade": "NotDeferred",
"evictionPolicy": "NoEviction",
"notifyKeyspaceEvents": "",
"port": 10000,
"provisioningState": "Updating",
"redisVersion": "7.2",
"resourceState": "Updating"
}
}
{
"name": "cache1/default",
"type": "Microsoft.Cache/redisEnterprise/databases",
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Encrypted",
"clusteringPolicy": "NoCluster",
"deferUpgrade": "NotDeferred",
"evictionPolicy": "NoEviction",
"notifyKeyspaceEvents": "",
"port": 10000,
"provisioningState": "Creating",
"redisVersion": "7.2",
"resourceState": "Creating"
}
}
RedisEnterpriseDatabasesCreate With Active Geo Replication
示例请求
PUT https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2026-09-01
{
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Encrypted",
"clusteringPolicy": "EnterpriseCluster",
"evictionPolicy": "NoEviction",
"geoReplication": {
"groupNickname": "groupName",
"linkedDatabases": [
{
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default"
},
{
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8e/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default"
}
]
},
"notifyKeyspaceEvents": "KEA",
"port": 10000
}
}
示例响应
{
"name": "cache1/default",
"type": "Microsoft.Cache/redisEnterprise/databases",
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Encrypted",
"clusteringPolicy": "EnterpriseCluster",
"deferUpgrade": "NotDeferred",
"evictionPolicy": "NoEviction",
"geoReplication": {
"groupNickname": "groupName",
"linkedDatabases": [
{
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8e/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
"state": "Linking"
},
{
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
"state": "Linking"
}
]
},
"notifyKeyspaceEvents": "KEA",
"port": 10000,
"provisioningState": "Updating",
"redisVersion": "6.0",
"resourceState": "Updating"
}
}
{
"name": "cache1/db1",
"type": "Microsoft.Cache/redisEnterprise/databases",
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/db1",
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Plaintext",
"clusteringPolicy": "EnterpriseCluster",
"deferUpgrade": "NotDeferred",
"evictionPolicy": "NoEviction",
"geoReplication": {
"groupNickname": "groupName",
"linkedDatabases": [
{
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8e/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
"state": "Linking"
},
{
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
"state": "Linking"
}
]
},
"notifyKeyspaceEvents": "KEA",
"port": 10000,
"provisioningState": "Creating",
"redisVersion": "6.0",
"resourceState": "Creating"
}
}
定义
| 名称 | 说明 |
|---|---|
|
Access |
此属性可以启用/禁用,以允许或拒绝使用当前访问密钥的访问。 即使在创建数据库后也可以更新。 |
|
Aof |
设置将数据写入磁盘的频率。 默认值为“1s”,即“每秒”。 请注意,“始终”设置已弃用,因为它的性能影响。 |
|
Clustering |
群集策略 - 默认值为 OSSCluster。 仅当当前值为 NoCluster 时,才能更新此属性。 如果值为 OSSCluster 或 EnterpriseCluster,则不能在不删除数据库的情况下更新该值。 |
|
created |
创建该资源的身份类型。 |
| Database |
描述 Redis Enterprise 群集上的数据库 |
|
Database |
用于为此数据库配置异地复制的可选属性集。 |
|
Defer |
发布最新版本时延迟升级的选项 - 默认值为 NotDeferred。 了解详细信息:https://aka.ms/redisversionupgrade |
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详情 |
|
Error |
错误响应 |
|
Eviction |
Redis 逐出策略 - 默认值为 VolatileLRU |
|
Linked |
指定链接的数据库资源的详细信息。 |
|
Link |
数据库资源之间的链接状态。 |
| Module |
指定 redis 模块的配置 |
| Persistence |
Redis Enterprise 数据库的持久性相关配置 |
| Protocol |
指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。 默认值为 TLS 加密。 |
|
Provisioning |
当前预配状态 |
|
Rdb |
设置创建数据库快照的频率。 |
|
Resource |
当前资源状态 |
|
system |
与创建和上次修改资源相关的元数据。 |
AccessKeysAuthentication
此属性可以启用/禁用,以允许或拒绝使用当前访问密钥的访问。 即使在创建数据库后也可以更新。
| 值 | 说明 |
|---|---|
| Disabled |
Disabled |
| Enabled |
已启用 |
AofFrequency
设置将数据写入磁盘的频率。 默认值为“1s”,即“每秒”。 请注意,“始终”设置已弃用,因为它的性能影响。
| 值 | 说明 |
|---|---|
| 1s |
1s |
| always |
始终 |
ClusteringPolicy
群集策略 - 默认值为 OSSCluster。 仅当当前值为 NoCluster 时,才能更新此属性。 如果值为 OSSCluster 或 EnterpriseCluster,则不能在不删除数据库的情况下更新该值。
| 值 | 说明 |
|---|---|
| EnterpriseCluster |
企业群集策略仅使用不支持 redis 群集命令的经典 redis 协议。 |
| OSSCluster |
OSS 群集策略遵循 redis 群集规范,并要求所有客户端支持 redis 群集。 |
| NoCluster |
NoCluster 策略用于不需要群集功能的非聚集 Redis 实例。 |
createdByType
创建该资源的身份类型。
| 值 | 说明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
Database
描述 Redis Enterprise 群集上的数据库
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| id |
string (arm-id) |
该资源的完全限定资源 ID。 例如,“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” |
|
| name |
string |
资源的名称 |
|
| properties.accessKeysAuthentication | Disabled |
此属性可以启用/禁用,以允许或拒绝使用当前访问密钥的访问。 即使在创建数据库后也可以更新。 默认值为 Disabled。 |
|
| properties.clientProtocol |
指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。 默认值为 TLS 加密。 |
||
| properties.clusteringPolicy |
群集策略 - 默认值为 OSSCluster。 仅当当前值为 NoCluster 时,才能更新此属性。 如果值为 OSSCluster 或 EnterpriseCluster,则不能在不删除数据库的情况下更新该值。 |
||
| properties.deferUpgrade |
发布最新版本时延迟升级的选项 - 默认值为 NotDeferred。 了解详细信息:https://aka.ms/redisversionupgrade |
||
| properties.evictionPolicy |
Redis 逐出策略 - 默认值为 VolatileLRU |
||
| properties.geoReplication |
用于为此数据库配置异地复制的可选属性集。 |
||
| properties.modules |
Module[] |
在此数据库中启用的可选 redis 模块集 - 只能在创建时添加模块。 |
|
| properties.notifyKeyspaceEvents |
string |
指定哪些密钥空间事件应触发通知。 默认是空字符串,意味着该功能被禁用。 启用时,至少必须有“K”(密钥空间事件)或“E”(密钥事件事件)。 例如,“AKE”启用所有标准事件。 完整活动类型列表请参见 https://redis.io/docs/latest/develop/use/keyspace-notifications/ 。 |
|
| properties.persistence |
持久性设置 |
||
| properties.port |
integer (int32) |
数据库终结点的 TCP 端口。 在创建时指定。 默认为可用端口。 |
|
| properties.provisioningState |
数据库的当前预配状态 |
||
| properties.redisVersion |
string |
运行数据库的 Redis 版本,例如“6.0” |
|
| properties.resourceState |
数据库的当前资源状态 |
||
| systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
||
| type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
DatabasePropertiesGeoReplication
用于为此数据库配置异地复制的可选属性集。
| 名称 | 类型 | 说明 |
|---|---|---|
| groupNickname |
string |
链接数据库资源组的名称 |
| linkedDatabases |
要链接到此数据库的数据库资源列表 |
DeferUpgradeSetting
发布最新版本时延迟升级的选项 - 默认值为 NotDeferred。 了解详细信息:https://aka.ms/redisversionupgrade
| 值 | 说明 |
|---|---|
| Deferred |
已推迟 |
| NotDeferred |
NotDeferred |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
附加信息。 |
| type |
string |
其他信息类型。 |
ErrorDetail
错误详情
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误的附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详情。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误的目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
EvictionPolicy
Redis 逐出策略 - 默认值为 VolatileLRU
| 值 | 说明 |
|---|---|
| AllKeysLFU |
AllKeysLFU |
| AllKeysLRU |
AllKeysLRU |
| AllKeysRandom |
AllKeysRandom |
| VolatileLRU |
VolatileLRU |
| VolatileLFU |
VolatileLFU |
| VolatileTTL |
VolatileTTL |
| VolatileRandom |
VolatileRandom |
| NoEviction |
NoEviction |
LinkedDatabase
指定链接的数据库资源的详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string (arm-id) |
要链接到此数据库的数据库资源的资源 ID。 |
| state |
数据库资源之间的链接状态。 |
LinkState
数据库资源之间的链接状态。
| 值 | 说明 |
|---|---|
| Linked |
已关联 |
| Linking |
Linking |
| Unlinking |
取消关联 |
| LinkFailed |
LinkFailed |
| UnlinkFailed |
UnlinkFailed |
Module
指定 redis 模块的配置
| 名称 | 类型 | 说明 |
|---|---|---|
| args |
string |
模块的配置选项,例如“ERROR_RATE 0.01 INITIAL_SIZE 400”。 |
| name |
string |
模块的名称,例如“RedisBloom”、“RediSearch”、“RedisTimeSeries” |
| version |
string |
模块的版本,例如“1.0”。 |
Persistence
Redis Enterprise 数据库的持久性相关配置
| 名称 | 类型 | 说明 |
|---|---|---|
| aofEnabled |
boolean |
设置是否启用 AOF。 请注意,最多可以启用 AOF 或 RDB 持久性之一。 |
| aofFrequency |
设置将数据写入磁盘的频率。 默认值为“1s”,即“每秒”。 请注意,“始终”设置已弃用,因为它的性能影响。 |
|
| rdbEnabled |
boolean |
设置是否启用 RDB。 请注意,最多可以启用 AOF 或 RDB 持久性之一。 |
| rdbFrequency |
设置创建数据库快照的频率。 |
Protocol
指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。 默认值为 TLS 加密。
| 值 | 说明 |
|---|---|
| Encrypted |
已加密 |
| Plaintext |
纯文本 |
ProvisioningState
当前预配状态
| 值 | 说明 |
|---|---|
| Succeeded |
成功 |
| Failed |
Failed |
| Canceled |
已取消 |
| Creating |
创建 |
| Updating |
正在更新 |
| Deleting |
正在删除 |
RdbFrequency
设置创建数据库快照的频率。
| 值 | 说明 |
|---|---|
| 1h |
1 小时 |
| 6h |
6小时 |
| 12h |
12 小时 |
ResourceState
当前资源状态
| 值 | 说明 |
|---|---|
| Running |
Running |
| Creating |
创建 |
| CreateFailed |
CreateFailed |
| Updating |
正在更新 |
| UpdateFailed |
更新失败 |
| Deleting |
正在删除 |
| DeleteFailed |
删除失败 |
| Enabling |
启用 |
| EnableFailed |
EnableFailed |
| Disabling |
禁用 |
| DisableFailed |
禁用失败 |
| Disabled |
Disabled |
| Scaling |
Scaling |
| ScalingFailed |
ScalingFailed |
| Moving |
移动 |
systemData
与创建和上次修改资源相关的元数据。
| 名称 | 类型 | 说明 |
|---|---|---|
| createdAt |
string (date-time) |
资源创建时间戳(UTC)。 |
| createdBy |
string |
创建该资源的身份。 |
| createdByType |
创建该资源的身份类型。 |
|
| lastModifiedAt |
string (date-time) |
上次修改的资源时间戳(UTC) |
| lastModifiedBy |
string |
上次修改资源的标识。 |
| lastModifiedByType |
上次修改资源的标识的类型。 |