你当前正在访问 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=2024-02-01

URI 参数

名称 必需 类型 说明
clusterName
path True

string

RedisEnterprise 群集的名称。

databaseName
path True

string

数据库的名称。

resourceGroupName
path True

string

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

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

请求正文

名称 类型 说明
properties.clientProtocol

Protocol

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

properties.clusteringPolicy

ClusteringPolicy

群集策略 - 默认值为 OSSCluster。 在创建时指定。

properties.evictionPolicy

EvictionPolicy

Redis 逐出策略 - 默认值为 VolatileLRU

properties.geoReplication

GeoReplication

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

properties.modules

Module[]

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

properties.persistence

Persistence

持久性设置
持久性设置

properties.port

integer

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

响应

名称 类型 说明
200 OK

Database

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

202 Accepted

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

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

RedisEnterpriseDatabasesUpdate

示例请求

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2024-02-01

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

示例响应

{
  "id": "/subscriptions/subid/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"
      }
    ]
  }
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationStatus...
Location: https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult...

定义

名称 说明
AofFrequency

设置将数据写入磁盘的频率。

ClusteringPolicy

群集策略 - 默认值为 OSSCluster。 在创建时指定。

Database

描述 RedisEnterprise 群集上的数据库

DatabaseUpdate

对 RedisEnterprise 数据库的部分更新

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

EvictionPolicy

Redis 逐出策略 - 默认值为 VolatileLRU

GeoReplication

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

LinkedDatabase

链接数据库

LinkState

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

Module

模块设置

Persistence

持久性设置

Protocol

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

ProvisioningState

当前预配状态

RdbFrequency

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

ResourceState

当前资源状态

AofFrequency

设置将数据写入磁盘的频率。

名称 类型 说明
1s

string

always

string

ClusteringPolicy

群集策略 - 默认值为 OSSCluster。 在创建时指定。

名称 类型 说明
EnterpriseCluster

string

OSSCluster

string

Database

描述 RedisEnterprise 群集上的数据库

名称 类型 说明
id

string

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

name

string

资源的名称

properties.clientProtocol

Protocol

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

properties.clusteringPolicy

ClusteringPolicy

群集策略 - 默认值为 OSSCluster。 在创建时指定。

properties.evictionPolicy

EvictionPolicy

Redis 逐出策略 - 默认值为 VolatileLRU

properties.geoReplication

GeoReplication

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

properties.modules

Module[]

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

properties.persistence

Persistence

持久性设置
持久性设置

properties.port

integer

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

properties.provisioningState

ProvisioningState

数据库的当前预配状态

properties.resourceState

ResourceState

数据库的当前资源状态

type

string

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

DatabaseUpdate

对 RedisEnterprise 数据库的部分更新

名称 类型 说明
properties.clientProtocol

Protocol

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

properties.clusteringPolicy

ClusteringPolicy

群集策略 - 默认值为 OSSCluster。 在创建时指定。

properties.evictionPolicy

EvictionPolicy

Redis 逐出策略 - 默认值为 VolatileLRU

properties.geoReplication

GeoReplication

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

properties.modules

Module[]

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

properties.persistence

Persistence

持久性设置
持久性设置

properties.port

integer

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

properties.provisioningState

ProvisioningState

数据库的当前预配状态

properties.resourceState

ResourceState

数据库的当前资源状态

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

EvictionPolicy

Redis 逐出策略 - 默认值为 VolatileLRU

名称 类型 说明
AllKeysLFU

string

AllKeysLRU

string

AllKeysRandom

string

NoEviction

string

VolatileLFU

string

VolatileLRU

string

VolatileRandom

string

VolatileTTL

string

GeoReplication

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

名称 类型 说明
groupNickname

string

链接数据库资源组的名称

linkedDatabases

LinkedDatabase[]

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

LinkedDatabase

链接数据库

名称 类型 说明
id

string

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

state

LinkState

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

LinkState

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

名称 类型 说明
LinkFailed

string

Linked

string

Linking

string

UnlinkFailed

string

Unlinking

string

Module

模块设置

名称 类型 说明
args

string

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

name

string

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

version

string

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

Persistence

持久性设置

名称 类型 说明
aofEnabled

boolean

设置是否启用 AOF。

aofFrequency

AofFrequency

设置将数据写入磁盘的频率。

rdbEnabled

boolean

设置是否启用 RDB。

rdbFrequency

RdbFrequency

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

Protocol

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

名称 类型 说明
Encrypted

string

Plaintext

string

ProvisioningState

当前预配状态

名称 类型 说明
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

RdbFrequency

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

名称 类型 说明
12h

string

1h

string

6h

string

ResourceState

当前资源状态

名称 类型 说明
CreateFailed

string

Creating

string

DeleteFailed

string

Deleting

string

DisableFailed

string

Disabled

string

Disabling

string

EnableFailed

string

Enabling

string

Running

string

Scaling

string

ScalingFailed

string

UpdateFailed

string

Updating

string