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 參數

名稱	位於	必要	類型	Description
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	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求本文

名稱	類型	Description
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 (int32)	資料庫端點的 TCP 連接埠。在建立時間指定。預設為可用的埠。

回應

名稱	類型	Description
200 OK	Database	資料庫已/正在更新。檢查 provisioningState 和 resourceState 以取得詳細狀態。
201 Created	Database	資料庫正在建立中。檢查 provisioningState 和 resourceState 以取得詳細狀態。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
        }
      ]
    }
  }
}

定義

名稱	Description
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

列舉型別

設定將數據寫入磁碟的頻率。

值	Description
1s
always

ClusteringPolicy

列舉型別

叢集原則 - 預設值為 OSSCluster。在建立時間指定。

值	Description
EnterpriseCluster
OSSCluster

Database

Object

描述 RedisEnterprise 叢集上的資料庫

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /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 (int32)	資料庫端點的 TCP 連接埠。在建立時間指定。預設為可用的埠。
properties.provisioningState	ProvisioningState	資料庫的目前布建狀態
properties.resourceState	ResourceState	資料庫目前的資源狀態
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

EvictionPolicy

列舉型別

Redis 收回原則 - 預設值為 VolatileLRU

值	Description
AllKeysLFU
AllKeysLRU
AllKeysRandom
NoEviction
VolatileLFU
VolatileLRU
VolatileRandom
VolatileTTL

GeoReplication

Object

選擇性的屬性集，可設定此資料庫的異地複寫。

名稱	類型	Description
groupNickname	string	連結資料庫資源群組的名稱
linkedDatabases	LinkedDatabase[]	要與這個資料庫連結的資料庫資源清單

LinkedDatabase

Object

連結的資料庫

名稱	類型	Description
id	string (arm-id)	要與這個資料庫連結之資料庫資源的資源標識碼。
state	LinkState	資料庫資源之間的鏈接狀態。

LinkState

列舉型別

資料庫資源之間的鏈接狀態。

值	Description
LinkFailed
Linked
Linking
UnlinkFailed
Unlinking

Module

Object

模組設定

名稱	類型	Description
args	string	模組的組態選項，例如『ERROR_RATE 0.01 INITIAL_SIZE 400』。
name	string	模組的名稱，例如 'RedisBloom'、'RediSearch'、'RedisTimeSeries'
version	string	模組的版本，例如『1.0』。

Persistence

Object

持續性設定

名稱	類型	Description
aofEnabled	boolean	設定是否啟用 AOF。
aofFrequency	AofFrequency	設定將數據寫入磁碟的頻率。
rdbEnabled	boolean	設定是否啟用 RDB。
rdbFrequency	RdbFrequency	設定建立資料庫快照集的頻率。

Protocol

列舉型別

指定 redis 用戶端是否可以使用 TLS 加密或純文字 redis 通訊協議進行連線。預設值為 TLS 加密。

值	Description
Encrypted
Plaintext

ProvisioningState

列舉型別

目前的布建狀態

值	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

RdbFrequency

列舉型別

設定建立資料庫快照集的頻率。

值	Description
12h
1h
6h

ResourceState

列舉型別

目前的資源狀態

值	Description
CreateFailed
Creating
DeleteFailed
Deleting
DisableFailed
Disabled
Disabling
EnableFailed
Enabling
Running
Scaling
ScalingFailed
UpdateFailed
Updating

共用方式為

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

其他資源