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

Databases - Update

更新数据库

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}?api-version=2025-04-01

URI 参数

名称 必需 类型 说明
clusterName
path True

string

pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$

Redis Enterprise 群集的名称。 名称长度必须为 1-60 个字符。 允许的字符(A-Z、a-z、0-9)和连字符(-)。 不能有前导和尾随和连续连字符

databaseName
path True

string

pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$

Redis Enterprise 数据库的名称。

resourceGroupName
path True

string

minLength: 1
maxLength: 90

资源组的名称。 此名称不区分大小写。

subscriptionId
path True

string

minLength: 1

目标订阅的 ID。

api-version
query True

string

minLength: 1

用于此操作的 API 版本。

请求正文

名称 类型 说明
properties.accessKeysAuthentication

accessKeysAuthentication

此属性可以启用/禁用,以允许或拒绝使用当前访问密钥的访问。 即使在创建数据库后也可以更新。

properties.clientProtocol

Protocol

指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。 默认值为 TLS 加密。

properties.clusteringPolicy

ClusteringPolicy

群集策略 - 默认值为 OSSCluster。 必须在创建时选择此属性,并且不能在不删除数据库的情况下进行更改。

properties.deferUpgrade

DeferUpgradeSetting

发布最新版本时延迟升级的选项 - 默认值为 NotDeferred。 了解详细信息:https://aka.ms/redisversionupgrade

properties.evictionPolicy

EvictionPolicy

Redis 逐出策略 - 默认值为 VolatileLRU

properties.geoReplication

GeoReplication

用于为此数据库配置异地复制的可选属性集。

properties.modules

Module[]

在此数据库中启用的可选 redis 模块集 - 只能在创建时添加模块。

properties.persistence

Persistence

持久性设置
持久性设置

properties.port

integer (int32)

数据库终结点的 TCP 端口。 在创建时指定。 默认为可用端口。

响应

名称 类型 说明
200 OK

Database

数据库已/正在更新。 检查 provisioningState 和 resourceState 以获取详细状态。

202 Accepted

已成功启动数据库更新作。 获取 Azure-AsyncOperation 或位置标头中的 URL 以检索更新的状态。

标头

  • Location: string
  • Azure-AsyncOperation: string
Other Status Codes

ErrorResponse

描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

RedisEnterpriseDatabasesUpdate

示例请求

PATCH https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2025-04-01

{
  "properties": {
    "clientProtocol": "Encrypted",
    "evictionPolicy": "AllKeysLRU",
    "persistence": {
      "rdbEnabled": true,
      "rdbFrequency": "12h"
    },
    "accessKeysAuthentication": "Enabled"
  }
}

示例响应

{
  "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
  "name": "cache1/default",
  "type": "Microsoft.Cache/redisEnterprise/databases",
  "properties": {
    "provisioningState": "Updating",
    "resourceState": "Updating",
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "OSSCluster",
    "evictionPolicy": "AllKeysLRU",
    "persistence": {
      "rdbEnabled": true,
      "rdbFrequency": "12h"
    },
    "port": 10000,
    "modules": [
      {
        "name": "RediSearch",
        "args": "",
        "version": "1.0.0"
      }
    ],
    "deferUpgrade": "NotDeferred",
    "accessKeysAuthentication": "Enabled",
    "redisVersion": "6.0"
  }
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/providers/Microsoft.Cache/...pathToOperationStatus...
Location: https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/providers/Microsoft.Cache/...pathToOperationResult...

定义

名称 说明
accessKeysAuthentication

此属性可以启用/禁用,以允许或拒绝使用当前访问密钥的访问。 即使在创建数据库后也可以更新。

AofFrequency

设置将数据写入磁盘的频率。 默认值为“1s”,即“每秒”。 请注意,“始终”设置已弃用,因为它的性能影响。

ClusteringPolicy

群集策略 - 默认值为 OSSCluster。 必须在创建时选择此属性,并且不能在不删除数据库的情况下进行更改。

Database

描述 Redis Enterprise 群集上的数据库

DatabaseUpdate

Redis Enterprise 数据库的部分更新

DeferUpgradeSetting

发布最新版本时延迟升级的选项 - 默认值为 NotDeferred。 了解详细信息:https://aka.ms/redisversionupgrade

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

EvictionPolicy

Redis 逐出策略 - 默认值为 VolatileLRU

GeoReplication

用于为此数据库配置异地复制的可选属性集。

LinkedDatabase

链接数据库

LinkState

数据库资源之间的链接状态。

Module

模块设置

Persistence

持久性设置

Protocol

指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。 默认值为 TLS 加密。

ProvisioningState

当前预配状态

RdbFrequency

设置创建数据库快照的频率。

ResourceState

当前资源状态

accessKeysAuthentication

此属性可以启用/禁用,以允许或拒绝使用当前访问密钥的访问。 即使在创建数据库后也可以更新。

说明
Disabled
Enabled

AofFrequency

设置将数据写入磁盘的频率。 默认值为“1s”,即“每秒”。 请注意,“始终”设置已弃用,因为它的性能影响。

说明
1s
always

ClusteringPolicy

群集策略 - 默认值为 OSSCluster。 必须在创建时选择此属性,并且不能在不删除数据库的情况下进行更改。

说明
EnterpriseCluster

企业群集策略仅使用不支持 redis 群集命令的经典 redis 协议。

OSSCluster

OSS 群集策略遵循 redis 群集规范,并要求所有客户端支持 redis 群集。

Database

描述 Redis Enterprise 群集上的数据库

名称 类型 说明
id

string

资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.accessKeysAuthentication

accessKeysAuthentication

此属性可以启用/禁用,以允许或拒绝使用当前访问密钥的访问。 即使在创建数据库后也可以更新。

properties.clientProtocol

Protocol

指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。 默认值为 TLS 加密。

properties.clusteringPolicy

ClusteringPolicy

群集策略 - 默认值为 OSSCluster。 必须在创建时选择此属性,并且不能在不删除数据库的情况下进行更改。

properties.deferUpgrade

DeferUpgradeSetting

发布最新版本时延迟升级的选项 - 默认值为 NotDeferred。 了解详细信息:https://aka.ms/redisversionupgrade

properties.evictionPolicy

EvictionPolicy

Redis 逐出策略 - 默认值为 VolatileLRU

properties.geoReplication

GeoReplication

用于为此数据库配置异地复制的可选属性集。

properties.modules

Module[]

在此数据库中启用的可选 redis 模块集 - 只能在创建时添加模块。

properties.persistence

Persistence

持久性设置
持久性设置

properties.port

integer (int32)

数据库终结点的 TCP 端口。 在创建时指定。 默认为可用端口。

properties.provisioningState

ProvisioningState

数据库的当前预配状态

properties.redisVersion

string

运行数据库的 Redis 版本,例如“6.0”

properties.resourceState

ResourceState

数据库的当前资源状态

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

DatabaseUpdate

Redis Enterprise 数据库的部分更新

名称 类型 说明
properties.accessKeysAuthentication

accessKeysAuthentication

此属性可以启用/禁用,以允许或拒绝使用当前访问密钥的访问。 即使在创建数据库后也可以更新。

properties.clientProtocol

Protocol

指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。 默认值为 TLS 加密。

properties.clusteringPolicy

ClusteringPolicy

群集策略 - 默认值为 OSSCluster。 必须在创建时选择此属性,并且不能在不删除数据库的情况下进行更改。

properties.deferUpgrade

DeferUpgradeSetting

发布最新版本时延迟升级的选项 - 默认值为 NotDeferred。 了解详细信息:https://aka.ms/redisversionupgrade

properties.evictionPolicy

EvictionPolicy

Redis 逐出策略 - 默认值为 VolatileLRU

properties.geoReplication

GeoReplication

用于为此数据库配置异地复制的可选属性集。

properties.modules

Module[]

在此数据库中启用的可选 redis 模块集 - 只能在创建时添加模块。

properties.persistence

Persistence

持久性设置
持久性设置

properties.port

integer (int32)

数据库终结点的 TCP 端口。 在创建时指定。 默认为可用端口。

properties.provisioningState

ProvisioningState

数据库的当前预配状态

properties.redisVersion

string

运行数据库的 Redis 版本,例如“6.0”

properties.resourceState

ResourceState

数据库的当前资源状态

DeferUpgradeSetting

发布最新版本时延迟升级的选项 - 默认值为 NotDeferred。 了解详细信息:https://aka.ms/redisversionupgrade

说明
Deferred
NotDeferred

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

EvictionPolicy

Redis 逐出策略 - 默认值为 VolatileLRU

说明
AllKeysLFU
AllKeysLRU
AllKeysRandom
VolatileLRU
VolatileLFU
VolatileTTL
VolatileRandom
NoEviction

GeoReplication

用于为此数据库配置异地复制的可选属性集。

名称 类型 说明
groupNickname

string

链接数据库资源组的名称

linkedDatabases

LinkedDatabase[]

要链接到此数据库的数据库资源列表

LinkedDatabase

链接数据库

名称 类型 说明
id

string (arm-id)

要链接到此数据库的数据库资源的资源 ID。

state

LinkState

数据库资源之间的链接状态。

LinkState

数据库资源之间的链接状态。

说明
Linked
Linking
Unlinking
LinkFailed
UnlinkFailed

Module

模块设置

名称 类型 说明
args

string

模块的配置选项,例如“ERROR_RATE 0.01 INITIAL_SIZE 400”。

name

string

模块的名称,例如“RedisBloom”、“RediSearch”、“RedisTimeSeries”

version

string

模块的版本,例如“1.0”。

Persistence

持久性设置

名称 类型 说明
aofEnabled

boolean

设置是否启用 AOF。 请注意,最多可以启用 AOF 或 RDB 持久性之一。

aofFrequency

AofFrequency

设置将数据写入磁盘的频率。 默认值为“1s”,即“每秒”。 请注意,“始终”设置已弃用,因为它的性能影响。

rdbEnabled

boolean

设置是否启用 RDB。 请注意,最多可以启用 AOF 或 RDB 持久性之一。

rdbFrequency

RdbFrequency

设置创建数据库快照的频率。

Protocol

指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。 默认值为 TLS 加密。

说明
Encrypted
Plaintext

ProvisioningState

当前预配状态

说明
Succeeded
Failed
Canceled
Creating
Updating
Deleting

RdbFrequency

设置创建数据库快照的频率。

说明
1h
6h
12h

ResourceState

当前资源状态

说明
Running
Creating
CreateFailed
Updating
UpdateFailed
Deleting
DeleteFailed
Enabling
EnableFailed
Disabling
DisableFailed
Disabled
Scaling
ScalingFailed
Moving