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

Databases - Create

参考

服务:: Redis Cache

API 版本:: 2024-10-01

创建数据库

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

URI 参数

名称	在	必需	类型	说明
clusterName	path	True	string	Redis Enterprise 群集的名称。名称长度必须为 1-60 个字符。允许的字符（A-Z、a-z、0-9）和连字符（-）。不能有前导和尾随和连续连字符正则表达式模式: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
databaseName	path	True	string	Redis Enterprise 数据库的名称。正则表达式模式: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
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 以获取详细状态。
201 Created	Database	正在创建数据库。检查 provisioningState 和 resourceState 以获取详细状态。
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

RedisEnterpriseDatabasesCreate

RedisEnterpriseDatabasesCreate With Active Geo Replication

RedisEnterpriseDatabasesCreate

示例请求

HTTP

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

{
  "properties": {
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "AllKeysLRU",
    "persistence": {
      "aofEnabled": true,
      "aofFrequency": "1s"
    },
    "port": 10000,
    "modules": [
      {
        "name": "RedisBloom",
        "args": "ERROR_RATE 0.00 INITIAL_SIZE 400"
      },
      {
        "name": "RedisTimeSeries",
        "args": "RETENTION_POLICY 20"
      },
      {
        "name": "RediSearch"
      }
    ]
  }
}

示例响应

状态代码:: 200

{
  "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": "EnterpriseCluster",
    "evictionPolicy": "AllKeysLRU",
    "persistence": {
      "aofEnabled": true,
      "aofFrequency": "1s"
    },
    "port": 10000,
    "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"
      }
    ]
  }
}

状态代码:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/db1",
  "name": "cache1/db1",
  "type": "Microsoft.Cache/redisEnterprise/databases",
  "properties": {
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "AllKeysLRU",
    "persistence": {
      "aofEnabled": true,
      "aofFrequency": "1s"
    },
    "port": 10000,
    "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"
      }
    ]
  }
}

RedisEnterpriseDatabasesCreate With Active Geo Replication

示例请求

HTTP

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

{
  "properties": {
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "NoEviction",
    "port": 10000,
    "geoReplication": {
      "groupNickname": "groupName",
      "linkedDatabases": [
        {
          "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default"
        },
        {
          "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default"
        }
      ]
    }
  }
}

示例响应

状态代码:: 200

{
  "id": "/subscriptions/subid1/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": "EnterpriseCluster",
    "evictionPolicy": "NoEviction",
    "port": 10000,
    "geoReplication": {
      "groupNickname": "groupName",
      "linkedDatabases": [
        {
          "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
          "state": "Linking"
        },
        {
          "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
          "state": "Linking"
        }
      ]
    }
  }
}

状态代码:: 201

{
  "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/db1",
  "name": "cache1/db1",
  "type": "Microsoft.Cache/redisEnterprise/databases",
  "properties": {
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "clientProtocol": "Plaintext",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "NoEviction",
    "port": 10000,
    "geoReplication": {
      "groupNickname": "groupName",
      "linkedDatabases": [
        {
          "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
          "state": "Linking"
        },
        {
          "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
          "state": "Linking"
        }
      ]
    }
  }
}

定义

名称	说明
AofFrequency	设置将数据写入磁盘的频率。
ClusteringPolicy	群集策略 - 默认值为 OSSCluster。在创建时指定。
Database	描述 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。 Ex - /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”

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

通过

Databases - Create

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

RedisEnterpriseDatabasesCreate

示例请求

示例响应

RedisEnterpriseDatabasesCreate With Active Geo Replication

示例请求

示例响应

定义

AofFrequency

ClusteringPolicy

Database

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

GeoReplication

LinkedDatabase

LinkState

Module

Persistence

Protocol

ProvisioningState

RdbFrequency

ResourceState

其他资源