Databases - Create
建立資料庫
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}?api-version=2026-09-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 (uuid) |
目標訂用帳戶的標識碼。 此值必須是 UUID。 |
|
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.notifyKeyspaceEvents |
string |
指定哪些鍵空間事件應觸發通知。 預設是空字串,表示此功能被停用。 啟用時,至少必須有「K」(密鑰空間事件)或「E」(關鍵事件事件)。 例如,「AKE」能啟用所有標準事件。 完整活動類型列表請參見 https://redis.io/docs/latest/develop/use/keyspace-notifications/ 。 |
| properties.persistence |
持續性設定 |
|
| properties.port |
integer (int32) |
資料庫端點的 TCP 連接埠。 在建立時間指定。 預設為可用的埠。 |
回覆
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
資源 'Database' 更新作業成功 |
|
| 201 Created |
資源 'Database' 建立作業成功 標題
|
|
| 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=2026-09-01
{
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Encrypted",
"clusteringPolicy": "EnterpriseCluster",
"deferUpgrade": "NotDeferred",
"evictionPolicy": "AllKeysLRU",
"notifyKeyspaceEvents": "KEA",
"modules": [
{
"name": "RedisBloom",
"args": "ERROR_RATE 0.00 INITIAL_SIZE 400"
},
{
"name": "RedisTimeSeries",
"args": "RETENTION_POLICY 20"
},
{
"name": "RediSearch"
}
],
"persistence": {
"aofEnabled": true,
"aofFrequency": "1s"
},
"port": 10000
}
}
範例回覆
{
"name": "cache1/default",
"type": "Microsoft.Cache/redisEnterprise/databases",
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Encrypted",
"clusteringPolicy": "EnterpriseCluster",
"deferUpgrade": "NotDeferred",
"evictionPolicy": "AllKeysLRU",
"notifyKeyspaceEvents": "KEA",
"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"
}
],
"persistence": {
"aofEnabled": true,
"aofFrequency": "1s"
},
"port": 10000,
"provisioningState": "Updating",
"redisVersion": "6.0",
"resourceState": "Updating"
}
}
{
"name": "cache1/db1",
"type": "Microsoft.Cache/redisEnterprise/databases",
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/db1",
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Encrypted",
"clusteringPolicy": "EnterpriseCluster",
"evictionPolicy": "AllKeysLRU",
"notifyKeyspaceEvents": "KEA",
"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"
}
],
"persistence": {
"aofEnabled": true,
"aofFrequency": "1s"
},
"port": 10000,
"provisioningState": "Creating",
"resourceState": "Creating"
}
}
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=2026-09-01
{
"properties": {
"clientProtocol": "Encrypted",
"clusteringPolicy": "NoCluster",
"evictionPolicy": "NoEviction",
"notifyKeyspaceEvents": "",
"port": 10000
}
}
範例回覆
{
"name": "cache1/default",
"type": "Microsoft.Cache/redisEnterprise/databases",
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Encrypted",
"clusteringPolicy": "NoCluster",
"deferUpgrade": "NotDeferred",
"evictionPolicy": "NoEviction",
"notifyKeyspaceEvents": "",
"port": 10000,
"provisioningState": "Updating",
"redisVersion": "7.2",
"resourceState": "Updating"
}
}
{
"name": "cache1/default",
"type": "Microsoft.Cache/redisEnterprise/databases",
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Encrypted",
"clusteringPolicy": "NoCluster",
"deferUpgrade": "NotDeferred",
"evictionPolicy": "NoEviction",
"notifyKeyspaceEvents": "",
"port": 10000,
"provisioningState": "Creating",
"redisVersion": "7.2",
"resourceState": "Creating"
}
}
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=2026-09-01
{
"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"
}
]
},
"notifyKeyspaceEvents": "KEA",
"port": 10000
}
}
範例回覆
{
"name": "cache1/default",
"type": "Microsoft.Cache/redisEnterprise/databases",
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Encrypted",
"clusteringPolicy": "EnterpriseCluster",
"deferUpgrade": "NotDeferred",
"evictionPolicy": "NoEviction",
"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"
}
]
},
"notifyKeyspaceEvents": "KEA",
"port": 10000,
"provisioningState": "Updating",
"redisVersion": "6.0",
"resourceState": "Updating"
}
}
{
"name": "cache1/db1",
"type": "Microsoft.Cache/redisEnterprise/databases",
"id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/db1",
"properties": {
"accessKeysAuthentication": "Enabled",
"clientProtocol": "Plaintext",
"clusteringPolicy": "EnterpriseCluster",
"deferUpgrade": "NotDeferred",
"evictionPolicy": "NoEviction",
"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"
}
]
},
"notifyKeyspaceEvents": "KEA",
"port": 10000,
"provisioningState": "Creating",
"redisVersion": "6.0",
"resourceState": "Creating"
}
}
定義
| 名稱 | Description |
|---|---|
|
Access |
此屬性可以是 Enabled/Disabled,以允許或拒絕目前存取金鑰的存取。 即使在建立資料庫之後,也可以更新。 |
|
Aof |
設定將數據寫入磁碟的頻率。 默認為 '1s',表示'每秒'。 請注意,由於其效能影響,『always』 設定已被取代。 |
|
Clustering |
叢集原則 - 預設值為 OSSCluster。 只有當目前的值為 NoCluster 時,才能更新此屬性。 如果值為 OSSCluster 或 EnterpriseCluster,則不需刪除資料庫,就無法更新該值。 |
|
created |
建立此資源的身分識別類型。 |
| Database |
描述 Redis Enterprise 叢集上的資料庫 |
|
Database |
選擇性的屬性集,可設定此資料庫的異地複寫。 |
|
Defer |
發行最新版本時延遲升級的選項 - 預設值為 NotDeferred。 深入了解:https://aka.ms/redisversionupgrade |
|
Error |
資源管理錯誤其他資訊。 |
|
Error |
錯誤詳細資料。 |
|
Error |
錯誤回應 |
|
Eviction |
Redis 收回原則 - 預設值為 VolatileLRU |
|
Linked |
指定連結資料庫資源的詳細數據。 |
|
Link |
資料庫資源之間鏈結的狀態。 |
| Module |
指定 redis 模組的組態 |
| Persistence |
Redis Enterprise 資料庫的持久化相關配置 |
| Protocol |
指定 redis 用戶端是否可以使用 TLS 加密或純文字 redis 通訊協議進行連線。 預設值為 TLS 加密。 |
|
Provisioning |
目前的佈建狀態 |
|
Rdb |
設定建立資料庫快照集的頻率。 |
|
Resource |
目前的資源狀態 |
|
system |
與建立和上次修改資源相關的元數據。 |
AccessKeysAuthentication
此屬性可以是 Enabled/Disabled,以允許或拒絕目前存取金鑰的存取。 即使在建立資料庫之後,也可以更新。
| 值 | Description |
|---|---|
| Disabled |
Disabled |
| Enabled |
已啟用 |
AofFrequency
設定將數據寫入磁碟的頻率。 默認為 '1s',表示'每秒'。 請注意,由於其效能影響,『always』 設定已被取代。
| 值 | Description |
|---|---|
| 1s |
1s |
| always |
永遠 |
ClusteringPolicy
叢集原則 - 預設值為 OSSCluster。 只有當目前的值為 NoCluster 時,才能更新此屬性。 如果值為 OSSCluster 或 EnterpriseCluster,則不需刪除資料庫,就無法更新該值。
| 值 | Description |
|---|---|
| EnterpriseCluster |
企業叢集原則只會使用不支援 redis 叢集命令的傳統 redis 通訊協定。 |
| OSSCluster |
OSS 叢集原則遵循 redis 叢集規格,並要求所有用戶端都支援 redis 叢集。 |
| NoCluster |
NoCluster 原則會用於不需要叢集功能的非叢集 Redis 實例。 |
createdByType
建立此資源的身分識別類型。
| 值 | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
Database
描述 Redis Enterprise 叢集上的資料庫
| 名稱 | 類型 | 預設值 | Description |
|---|---|---|---|
| id |
string (arm-id) |
資源的完整資源標識碼。 例如,“/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.notifyKeyspaceEvents |
string |
指定哪些鍵空間事件應觸發通知。 預設是空字串,表示此功能被停用。 啟用時,至少必須有「K」(密鑰空間事件)或「E」(關鍵事件事件)。 例如,「AKE」能啟用所有標準事件。 完整活動類型列表請參見 https://redis.io/docs/latest/develop/use/keyspace-notifications/ 。 |
|
| properties.persistence |
持續性設定 |
||
| properties.port |
integer (int32) |
資料庫端點的 TCP 連接埠。 在建立時間指定。 預設為可用的埠。 |
|
| properties.provisioningState |
資料庫的目前佈建狀態 |
||
| properties.redisVersion |
string |
資料庫執行的 Redis 版本,例如 '6.0' |
|
| properties.resourceState |
資料庫的現行資源狀態 |
||
| systemData |
包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。 |
||
| type |
string |
資源的類型。 例如:「Microsoft.Compute/virtualMachines」或「Microsoft.Storage/storageAccounts」 |
DatabasePropertiesGeoReplication
選擇性的屬性集,可設定此資料庫的異地複寫。
| 名稱 | 類型 | Description |
|---|---|---|
| groupNickname |
string |
連結資料庫資源群組的名稱 |
| linkedDatabases |
要與這個資料庫連結的資料庫資源清單 |
DeferUpgradeSetting
發行最新版本時延遲升級的選項 - 預設值為 NotDeferred。 深入了解:https://aka.ms/redisversionupgrade
| 值 | Description |
|---|---|
| Deferred |
已延遲 |
| NotDeferred |
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 |
AllKeysLFU |
| AllKeysLRU |
AllKeysLRU |
| AllKeysRandom |
AllKeysRandom |
| VolatileLRU |
VolatileLRU |
| VolatileLFU |
VolatileLFU |
| VolatileTTL |
VolatileTTL |
| VolatileRandom |
VolatileRandom |
| NoEviction |
NoEviction |
LinkedDatabase
指定連結資料庫資源的詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| id |
string (arm-id) |
要與這個資料庫連結之資料庫資源的資源標識碼。 |
| state |
資料庫資源之間鏈結的狀態。 |
LinkState
資料庫資源之間鏈結的狀態。
| 值 | Description |
|---|---|
| Linked |
已連結 |
| Linking |
正在連結 |
| Unlinking |
取消連結 |
| LinkFailed |
LinkFailed |
| UnlinkFailed |
UnlinkFailed |
Module
指定 redis 模組的組態
| 名稱 | 類型 | Description |
|---|---|---|
| args |
string |
模組的組態選項,例如 『ERROR_RATE 0.01 INITIAL_SIZE 400』。 |
| name |
string |
模組的名稱,例如 'RedisBloom'、'RediSearch'、'RedisTimeSeries' |
| version |
string |
模組的版本,例如 『1.0』。 |
Persistence
Redis Enterprise 資料庫的持久化相關配置
| 名稱 | 類型 | 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 |
1小時 |
| 6h |
6h |
| 12h |
12 小時 |
ResourceState
目前的資源狀態
| 值 | Description |
|---|---|
| Running |
Running |
| Creating |
建立中 |
| CreateFailed |
CreateFailed |
| Updating |
更新中 |
| UpdateFailed |
更新失敗 |
| Deleting |
刪除中 |
| DeleteFailed |
刪除失敗 |
| Enabling |
啟用 |
| EnableFailed |
EnableFailed |
| Disabling |
停用 |
| DisableFailed |
停用失敗 |
| Disabled |
Disabled |
| Scaling |
Scaling |
| ScalingFailed |
ScalingFailed |
| Moving |
移動 |
systemData
與建立和上次修改資源相關的元數據。
| 名稱 | 類型 | Description |
|---|---|---|
| createdAt |
string (date-time) |
資源建立的時間戳(UTC)。 |
| createdBy |
string |
建立此資源的身分。 |
| createdByType |
建立此資源的身分識別類型。 |
|
| lastModifiedAt |
string (date-time) |
上次修改的資源時間戳 (UTC) |
| lastModifiedBy |
string |
上次修改資源的身分識別。 |
| lastModifiedByType |
上次修改資源的身分識別類型。 |