Databases - Create
建立資料庫
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}?api-version=2025-07-01
URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
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 minLength: 1 |
目標訂用帳戶的標識碼。 |
|
api-version
|
query | True |
string minLength: 1 |
用於此作業的 API 版本。 |
要求本文
| 名稱 | 類型 | Description |
|---|---|---|
| properties.accessKeysAuthentication |
此屬性可以是 Enabled/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.persistence |
持續性設定 |
|
| properties.port |
integer (int32) |
資料庫端點的 TCP 連接埠。 在建立時間指定。 預設為可用的埠。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
資料庫正在更新。 檢查provisioningState和resourceState以取得詳細狀態。 |
|
| 201 Created |
正在建立資料庫。 檢查provisioningState和resourceState以取得詳細狀態。 |
|
| Other Status Codes |
說明作業為何失敗的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
| 名稱 | Description |
|---|---|
| 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=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"
}
}
範例回覆
{
"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"
}
}
{
"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
}
}
範例回覆
{
"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"
}
}
{
"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"
}
]
}
}
}
範例回覆
{
"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"
}
}
{
"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"
}
}
定義
| 名稱 | Description |
|---|---|
|
access |
此屬性可以是 Enabled/Disabled,以允許或拒絕目前存取金鑰的存取。 即使在建立資料庫之後,也可以更新。 預設值為 Disabled。 |
|
Aof |
設定將數據寫入磁碟的頻率。 默認為 '1s',表示'每秒'。 請注意,由於其效能影響,『always』 設定已被取代。 |
|
Clustering |
叢集原則 - 預設值為 OSSCluster。 只有當目前的值為 NoCluster 時,才能更新此屬性。 如果值為 OSSCluster 或 EnterpriseCluster,則不需刪除資料庫,就無法更新該值。 |
| Database |
描述 Redis Enterprise 叢集上的資料庫 |
|
Defer |
發行最新版本時延遲升級的選項 - 預設值為 NotDeferred。 深入了解:https://aka.ms/redisversionupgrade |
|
Error |
資源管理錯誤其他資訊。 |
|
Error |
錯誤詳細數據。 |
|
Error |
錯誤回應 |
|
Eviction |
Redis 收回原則 - 預設值為 VolatileLRU |
|
Geo |
選擇性的屬性集,可設定此資料庫的異地複寫。 |
|
Linked |
連結資料庫 |
|
Link |
資料庫資源之間鏈結的狀態。 |
| Module |
模組設定 |
| Persistence |
持續性設定 |
| Protocol |
指定 redis 用戶端是否可以使用 TLS 加密或純文字 redis 通訊協議進行連線。 預設值為 TLS 加密。 |
|
Provisioning |
目前的佈建狀態 |
|
Rdb |
設定建立資料庫快照集的頻率。 |
|
Resource |
目前的資源狀態 |
accessKeysAuthentication
此屬性可以是 Enabled/Disabled,以允許或拒絕目前存取金鑰的存取。 即使在建立資料庫之後,也可以更新。 預設值為 Disabled。
| 值 | Description |
|---|---|
| Disabled | |
| Enabled |
AofFrequency
設定將數據寫入磁碟的頻率。 默認為 '1s',表示'每秒'。 請注意,由於其效能影響,『always』 設定已被取代。
| 值 | Description |
|---|---|
| 1s | |
| always |
ClusteringPolicy
叢集原則 - 預設值為 OSSCluster。 只有當目前的值為 NoCluster 時,才能更新此屬性。 如果值為 OSSCluster 或 EnterpriseCluster,則不需刪除資料庫,就無法更新該值。
| 值 | Description |
|---|---|
| EnterpriseCluster |
企業叢集原則僅使用傳統 redis 通訊協定,不支援 redis 叢集命令。 |
| OSSCluster |
OSS叢集策略遵循redis叢集規範,要求所有客戶端都支援redis叢集。 |
| NoCluster |
NoCluster 政策用於不需要叢集功能的非叢集 Redis 執行個體。 |
Database
描述 Redis Enterprise 叢集上的資料庫
| 名稱 | 類型 | 預設值 | Description |
|---|---|---|---|
| id |
string |
資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
| name |
string |
資源的名稱 |
|
| properties.accessKeysAuthentication | Disabled |
此屬性可以是 Enabled/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.persistence |
持續性設定 |
||
| properties.port |
integer (int32) |
資料庫端點的 TCP 連接埠。 在建立時間指定。 預設為可用的埠。 |
|
| properties.provisioningState |
資料庫的目前佈建狀態 |
||
| properties.redisVersion |
string |
資料庫執行的 Redis 版本,例如 '6.0' |
|
| properties.resourceState |
資料庫的現行資源狀態 |
||
| type |
string |
資源的類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” |
DeferUpgradeSetting
發行最新版本時延遲升級的選項 - 預設值為 NotDeferred。 深入了解:https://aka.ms/redisversionupgrade
| 值 | Description |
|---|---|
| Deferred | |
| NotDeferred |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
| 名稱 | 類型 | Description |
|---|---|---|
| info |
object |
其他資訊。 |
| type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| additionalInfo |
錯誤其他資訊。 |
|
| code |
string |
錯誤碼。 |
| details |
錯誤詳細數據。 |
|
| message |
string |
錯誤訊息。 |
| target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
| 名稱 | 類型 | Description |
|---|---|---|
| error |
error 物件。 |
EvictionPolicy
Redis 收回原則 - 預設值為 VolatileLRU
| 值 | Description |
|---|---|
| AllKeysLFU | |
| AllKeysLRU | |
| AllKeysRandom | |
| VolatileLRU | |
| VolatileLFU | |
| VolatileTTL | |
| VolatileRandom | |
| NoEviction |
GeoReplication
選擇性的屬性集,可設定此資料庫的異地複寫。
| 名稱 | 類型 | Description |
|---|---|---|
| groupNickname |
string |
連結資料庫資源群組的名稱 |
| linkedDatabases |
要與這個資料庫連結的資料庫資源清單 |
LinkedDatabase
連結資料庫
| 名稱 | 類型 | Description |
|---|---|---|
| id |
string (arm-id) |
要與這個資料庫連結之資料庫資源的資源標識碼。 |
| state |
資料庫資源之間鏈結的狀態。 |
LinkState
資料庫資源之間鏈結的狀態。
| 值 | Description |
|---|---|
| Linked | |
| Linking | |
| Unlinking | |
| LinkFailed | |
| UnlinkFailed |
Module
模組設定
| 名稱 | 類型 | Description |
|---|---|---|
| args |
string |
模組的組態選項,例如 『ERROR_RATE 0.01 INITIAL_SIZE 400』。 |
| name |
string |
模組的名稱,例如 'RedisBloom'、'RediSearch'、'RedisTimeSeries' |
| version |
string |
模組的版本,例如「1.0」。 |
Persistence
持續性設定
| 名稱 | 類型 | Description |
|---|---|---|
| aofEnabled |
boolean |
設定是否啟用 AOF。 請注意,最多可以啟用其中一個 AOF 或 RDB 持續性。 |
| aofFrequency |
設定將數據寫入磁碟的頻率。 默認為 '1s',表示'每秒'。 請注意,由於其效能影響,『always』 設定已被取代。 |
|
| rdbEnabled |
boolean |
設定是否啟用 RDB。 請注意,最多可以啟用其中一個 AOF 或 RDB 持續性。 |
| rdbFrequency |
設定建立資料庫快照集的頻率。 |
Protocol
指定 redis 用戶端是否可以使用 TLS 加密或純文字 redis 通訊協議進行連線。 預設值為 TLS 加密。
| 值 | Description |
|---|---|
| Encrypted | |
| Plaintext |
ProvisioningState
目前的佈建狀態
| 值 | Description |
|---|---|
| Succeeded | |
| Failed | |
| Canceled | |
| Creating | |
| Updating | |
| Deleting |
RdbFrequency
設定建立資料庫快照集的頻率。
| 值 | Description |
|---|---|
| 1h | |
| 6h | |
| 12h |
ResourceState
目前的資源狀態
| 值 | Description |
|---|---|
| Running | |
| Creating | |
| CreateFailed | |
| Updating | |
| UpdateFailed | |
| Deleting | |
| DeleteFailed | |
| Enabling | |
| EnableFailed | |
| Disabling | |
| DisableFailed | |
| Disabled | |
| Scaling | |
| ScalingFailed | |
| Moving |