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

Databases - Create

服务:: Redis Cache

API 版本:: 2025-07-01

创建数据库

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}?api-version=2025-07-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	此属性可以启用/禁用，以允许或拒绝使用当前访问密钥的访问。即使在创建数据库后也可以更新。默认值为 Disabled。
properties.clientProtocol	Protocol	指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。默认值为 TLS 加密。
properties.clusteringPolicy	ClusteringPolicy	群集策略 - 默认值为 OSSCluster。仅当当前值为 NoCluster 时，才能更新此属性。如果值为 OSSCluster 或 EnterpriseCluster，则不能在不删除数据库的情况下更新该值。
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 了解详细状态。
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 No Cluster Cache

RedisEnterpriseDatabasesCreate With Active Geo Replication

RedisEnterpriseDatabasesCreate

示例请求

PUT https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2025-07-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"
      }
    ],
    "deferUpgrade": "NotDeferred",
    "accessKeysAuthentication": "Enabled"
  }
}


import com.azure.resourcemanager.redisenterprise.models.AccessKeysAuthentication;
import com.azure.resourcemanager.redisenterprise.models.AofFrequency;
import com.azure.resourcemanager.redisenterprise.models.ClusteringPolicy;
import com.azure.resourcemanager.redisenterprise.models.DeferUpgradeSetting;
import com.azure.resourcemanager.redisenterprise.models.EvictionPolicy;
import com.azure.resourcemanager.redisenterprise.models.Module;
import com.azure.resourcemanager.redisenterprise.models.Persistence;
import com.azure.resourcemanager.redisenterprise.models.Protocol;
import java.util.Arrays;

/**
 * Samples for Databases Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/
     * RedisEnterpriseDatabasesCreate.json
     */
    /**
     * Sample code: RedisEnterpriseDatabasesCreate.
     * 
     * @param manager Entry point to RedisEnterpriseManager.
     */
    public static void
        redisEnterpriseDatabasesCreate(com.azure.resourcemanager.redisenterprise.RedisEnterpriseManager manager) {
        manager.databases().define("default").withExistingRedisEnterprise("rg1", "cache1")
            .withClientProtocol(Protocol.ENCRYPTED).withPort(10000)
            .withClusteringPolicy(ClusteringPolicy.ENTERPRISE_CLUSTER).withEvictionPolicy(EvictionPolicy.ALL_KEYS_LRU)
            .withPersistence(new Persistence().withAofEnabled(true).withAofFrequency(AofFrequency.ONES))
            .withModules(Arrays.asList(new Module().withName("RedisBloom").withArgs("ERROR_RATE 0.00 INITIAL_SIZE 400"),
                new Module().withName("RedisTimeSeries").withArgs("RETENTION_POLICY 20"),
                new Module().withName("RediSearch")))
            .withDeferUpgrade(DeferUpgradeSetting.NOT_DEFERRED)
            .withAccessKeysAuthentication(AccessKeysAuthentication.ENABLED).create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.redisenterprise import RedisEnterpriseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-redisenterprise
# USAGE
    python redis_enterprise_databases_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = RedisEnterpriseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f",
    )

    response = client.databases.begin_create(
        resource_group_name="rg1",
        cluster_name="cache1",
        database_name="default",
        parameters={
            "properties": {
                "accessKeysAuthentication": "Enabled",
                "clientProtocol": "Encrypted",
                "clusteringPolicy": "EnterpriseCluster",
                "deferUpgrade": "NotDeferred",
                "evictionPolicy": "AllKeysLRU",
                "modules": [
                    {"args": "ERROR_RATE 0.00 INITIAL_SIZE 400", "name": "RedisBloom"},
                    {"args": "RETENTION_POLICY 20", "name": "RedisTimeSeries"},
                    {"name": "RediSearch"},
                ],
                "persistence": {"aofEnabled": True, "aofFrequency": "1s"},
                "port": 10000,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/RedisEnterpriseDatabasesCreate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "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": "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"
      }
    ],
    "deferUpgrade": "NotDeferred",
    "accessKeysAuthentication": "Enabled",
    "redisVersion": "6.0"
  }
}

状态代码:: 201

{
  "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/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"
      }
    ],
    "accessKeysAuthentication": "Enabled"
  }
}

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=2025-07-01

{
  "properties": {
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "NoCluster",
    "evictionPolicy": "NoEviction",
    "port": 10000
  }
}


import com.azure.resourcemanager.redisenterprise.models.ClusteringPolicy;
import com.azure.resourcemanager.redisenterprise.models.EvictionPolicy;
import com.azure.resourcemanager.redisenterprise.models.Protocol;

/**
 * Samples for Databases Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/
     * RedisEnterpriseDatabasesNoClusterCacheCreate.json
     */
    /**
     * Sample code: RedisEnterpriseDatabasesCreate No Cluster Cache.
     * 
     * @param manager Entry point to RedisEnterpriseManager.
     */
    public static void redisEnterpriseDatabasesCreateNoClusterCache(
        com.azure.resourcemanager.redisenterprise.RedisEnterpriseManager manager) {
        manager.databases().define("default").withExistingRedisEnterprise("rg1", "cache1")
            .withClientProtocol(Protocol.ENCRYPTED).withPort(10000).withClusteringPolicy(ClusteringPolicy.NO_CLUSTER)
            .withEvictionPolicy(EvictionPolicy.NO_EVICTION).create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.redisenterprise import RedisEnterpriseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-redisenterprise
# USAGE
    python redis_enterprise_databases_no_cluster_cache_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = RedisEnterpriseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f",
    )

    response = client.databases.begin_create(
        resource_group_name="rg1",
        cluster_name="cache1",
        database_name="default",
        parameters={
            "properties": {
                "clientProtocol": "Encrypted",
                "clusteringPolicy": "NoCluster",
                "evictionPolicy": "NoEviction",
                "port": 10000,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/RedisEnterpriseDatabasesNoClusterCacheCreate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 201

{
  "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": {
    "clientProtocol": "Encrypted",
    "port": 10000,
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "clusteringPolicy": "NoCluster",
    "evictionPolicy": "NoEviction",
    "deferUpgrade": "NotDeferred",
    "redisVersion": "7.2",
    "accessKeysAuthentication": "Enabled"
  }
}

状态代码:: 200

{
  "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": {
    "clientProtocol": "Encrypted",
    "port": 10000,
    "provisioningState": "Updating",
    "resourceState": "Updating",
    "clusteringPolicy": "NoCluster",
    "evictionPolicy": "NoEviction",
    "deferUpgrade": "NotDeferred",
    "redisVersion": "7.2",
    "accessKeysAuthentication": "Enabled"
  }
}

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=2025-07-01

{
  "properties": {
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "NoEviction",
    "port": 10000,
    "accessKeysAuthentication": "Enabled",
    "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"
        }
      ]
    }
  }
}


import com.azure.resourcemanager.redisenterprise.models.AccessKeysAuthentication;
import com.azure.resourcemanager.redisenterprise.models.ClusteringPolicy;
import com.azure.resourcemanager.redisenterprise.models.DatabasePropertiesGeoReplication;
import com.azure.resourcemanager.redisenterprise.models.EvictionPolicy;
import com.azure.resourcemanager.redisenterprise.models.LinkedDatabase;
import com.azure.resourcemanager.redisenterprise.models.Protocol;
import java.util.Arrays;

/**
 * Samples for Databases Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/
     * RedisEnterpriseDatabasesCreateWithGeoReplication.json
     */
    /**
     * Sample code: RedisEnterpriseDatabasesCreate With Active Geo Replication.
     * 
     * @param manager Entry point to RedisEnterpriseManager.
     */
    public static void redisEnterpriseDatabasesCreateWithActiveGeoReplication(
        com.azure.resourcemanager.redisenterprise.RedisEnterpriseManager manager) {
        manager.databases().define("default").withExistingRedisEnterprise("rg1", "cache1")
            .withClientProtocol(Protocol.ENCRYPTED).withPort(10000)
            .withClusteringPolicy(ClusteringPolicy.ENTERPRISE_CLUSTER).withEvictionPolicy(EvictionPolicy.NO_EVICTION)
            .withGeoReplication(new DatabasePropertiesGeoReplication().withGroupNickname("groupName")
                .withLinkedDatabases(Arrays.asList(new LinkedDatabase().withId(
                    "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default"),
                    new LinkedDatabase().withId(
                        "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8e/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default"))))
            .withAccessKeysAuthentication(AccessKeysAuthentication.ENABLED).create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.redisenterprise import RedisEnterpriseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-redisenterprise
# USAGE
    python redis_enterprise_databases_create_with_geo_replication.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = RedisEnterpriseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f",
    )

    response = client.databases.begin_create(
        resource_group_name="rg1",
        cluster_name="cache1",
        database_name="default",
        parameters={
            "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"
                        },
                    ],
                },
                "port": 10000,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/RedisEnterpriseDatabasesCreateWithGeoReplication.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "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": "EnterpriseCluster",
    "evictionPolicy": "NoEviction",
    "port": 10000,
    "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"
        }
      ]
    },
    "deferUpgrade": "NotDeferred",
    "accessKeysAuthentication": "Enabled",
    "redisVersion": "6.0"
  }
}

状态代码:: 201

{
  "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/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/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"
        }
      ]
    },
    "deferUpgrade": "NotDeferred",
    "accessKeysAuthentication": "Enabled",
    "redisVersion": "6.0"
  }
}

定义

名称	说明
accessKeysAuthentication	此属性可以启用/禁用，以允许或拒绝使用当前访问密钥的访问。即使在创建数据库后也可以更新。默认值为 Disabled。
AofFrequency	设置将数据写入磁盘的频率。默认值为“1s”，即“每秒”。请注意，“始终”设置已弃用，因为它的性能影响。
ClusteringPolicy	群集策略 - 默认值为 OSSCluster。仅当当前值为 NoCluster 时，才能更新此属性。如果值为 OSSCluster 或 EnterpriseCluster，则不能在不删除数据库的情况下更新该值。
Database	描述 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。

值	说明
Disabled
Enabled

AofFrequency

枚举

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

值	说明
1s
always

ClusteringPolicy

枚举

群集策略 - 默认值为 OSSCluster。仅当当前值为 NoCluster 时，才能更新此属性。如果值为 OSSCluster 或 EnterpriseCluster，则不能在不删除数据库的情况下更新该值。

值	说明
EnterpriseCluster	企业集群策略仅使用经典的redis协议，不支持redis集群命令。
OSSCluster	OSS集群策略遵循redis集群规范，要求所有客户端都支持redis集群。
NoCluster	NoCluster 策略用于不需要集群功能的非集群 Redis 实例。

Database

Object

描述 Redis Enterprise 集群上的数据库

名称	类型	默认值	说明
id	string		资源的完全限定资源 ID。示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		资源的名称
properties.accessKeysAuthentication	accessKeysAuthentication	Disabled	此属性可以启用/禁用，以允许或拒绝使用当前访问密钥的访问。即使在创建数据库后也可以更新。默认值为 Disabled。
properties.clientProtocol	Protocol		指定 redis 客户端是否可以使用 TLS 加密协议或纯文本 redis 协议进行连接。默认值为 TLS 加密。
properties.clusteringPolicy	ClusteringPolicy		群集策略 - 默认值为 OSSCluster。仅当当前值为 NoCluster 时，才能更新此属性。如果值为 OSSCluster 或 EnterpriseCluster，则不能在不删除数据库的情况下更新该值。
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”

DeferUpgradeSetting

枚举

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

值	说明
Deferred
NotDeferred

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

EvictionPolicy

枚举

Redis 逐出策略 - 默认值为 VolatileLRU

值	说明
AllKeysLFU
AllKeysLRU
AllKeysRandom
VolatileLRU
VolatileLFU
VolatileTTL
VolatileRandom
NoEviction

GeoReplication

Object

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

名称	类型	说明
groupNickname	string	链接数据库资源组的名称
linkedDatabases	LinkedDatabase[]	要链接到此数据库的数据库资源列表

LinkedDatabase

Object

链接数据库

名称	类型	说明
id	string (arm-id)	要链接到此数据库的数据库资源的资源 ID。
state	LinkState	数据库资源之间的链接状态。

LinkState

枚举

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

值	说明
Linked
Linking
Unlinking
LinkFailed
UnlinkFailed

Module

Object

模块设置

名称	类型	说明
args	string	模块的配置选项，例如“ERROR_RATE 0.01 INITIAL_SIZE 400”。
name	string	模块的名称，例如“RedisBloom”、“RediSearch”、“RedisTimeSeries”
version	string	模块的版本，例如“1.0”。

Persistence

Object

持久性设置

名称	类型	说明
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

通过

Databases - Create

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

RedisEnterpriseDatabasesCreate

示例请求

示例响应

RedisEnterpriseDatabasesCreate No Cluster Cache

示例请求

示例响应

RedisEnterpriseDatabasesCreate With Active Geo Replication

示例请求

示例响应

定义

accessKeysAuthentication

AofFrequency

ClusteringPolicy

Database

DeferUpgradeSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

GeoReplication

LinkedDatabase

LinkState

Module

Persistence

Protocol

ProvisioningState

RdbFrequency

ResourceState