次の方法で共有


Databases - Create

データベースを作成します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}?api-version=2025-04-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

このプロパティを有効または無効にして、現在のアクセス キーでのアクセスを許可または拒否できます。 データベースが作成された後でも更新できます。

properties.clientProtocol

Protocol

redis クライアントが TLS で暗号化された redis プロトコルまたはプレーンテキスト redis プロトコルを使用して接続できるかどうかを指定します。 既定値は TLS 暗号化です。

properties.clusteringPolicy

ClusteringPolicy

クラスタリング ポリシー - 既定値は OSSCluster です。 このプロパティは作成時に選択する必要があり、データベースを削除しないと変更できません。

properties.deferUpgrade

DeferUpgradeSetting

最新バージョンがリリースされたときにアップグレードを延期するオプション -既定値は NotDeferred です。 詳細情報: https://aka.ms/redisversionupgrade

properties.evictionPolicy

EvictionPolicy

Redis 削除ポリシー - 既定値は VolatileLRU です

properties.geoReplication

GeoReplication

このデータベースの geo レプリケーションを構成するためのプロパティのオプション セット。

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 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

RedisEnterpriseDatabasesCreate
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-04-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 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-04-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"
  }
}

定義

名前 説明
accessKeysAuthentication

このプロパティを有効または無効にして、現在のアクセス キーでのアクセスを許可または拒否できます。 データベースが作成された後でも更新できます。

AofFrequency

データがディスクに書き込まれる頻度を設定します。 既定値は '1s' で、"1 秒ごと" を意味します。 "always" 設定は、パフォーマンスに影響を与えるため、非推奨とされることに注意してください。

ClusteringPolicy

クラスタリング ポリシー - 既定値は OSSCluster です。 このプロパティは作成時に選択する必要があり、データベースを削除しないと変更できません。

Database

Redis Enterprise クラスター上のデータベースについて説明します

DeferUpgradeSetting

最新バージョンがリリースされたときにアップグレードを延期するオプション -既定値は NotDeferred です。 詳細情報: https://aka.ms/redisversionupgrade

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

EvictionPolicy

Redis 削除ポリシー - 既定値は VolatileLRU です

GeoReplication

このデータベースの geo レプリケーションを構成するためのプロパティのオプション セット。

LinkedDatabase

リンクされたデータベース

LinkState

データベース リソース間のリンクの状態。

Module

モジュール設定

Persistence

永続化の設定

Protocol

redis クライアントが TLS で暗号化された redis プロトコルまたはプレーンテキスト redis プロトコルを使用して接続できるかどうかを指定します。 既定値は TLS 暗号化です。

ProvisioningState

現在のプロビジョニングの状態

RdbFrequency

データベースのスナップショットを作成する頻度を設定します。

ResourceState

現在のリソースの状態

accessKeysAuthentication

このプロパティを有効または無効にして、現在のアクセス キーでのアクセスを許可または拒否できます。 データベースが作成された後でも更新できます。

説明
Disabled
Enabled

AofFrequency

データがディスクに書き込まれる頻度を設定します。 既定値は '1s' で、"1 秒ごと" を意味します。 "always" 設定は、パフォーマンスに影響を与えるため、非推奨とされることに注意してください。

説明
1s
always

ClusteringPolicy

クラスタリング ポリシー - 既定値は OSSCluster です。 このプロパティは作成時に選択する必要があり、データベースを削除しないと変更できません。

説明
EnterpriseCluster

エンタープライズ クラスタリング ポリシーでは、Redis クラスター コマンドをサポートしないクラシック Redis プロトコルのみが使用されます。

OSSCluster

OSS クラスタリング ポリシーは Redis クラスターの仕様に従い、すべてのクライアントで Redis クラスタリングをサポートする必要があります。

Database

Redis Enterprise クラスター上のデータベースについて説明します

名前 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

リソースの名前

properties.accessKeysAuthentication

accessKeysAuthentication

このプロパティを有効または無効にして、現在のアクセス キーでのアクセスを許可または拒否できます。 データベースが作成された後でも更新できます。

properties.clientProtocol

Protocol

redis クライアントが TLS で暗号化された redis プロトコルまたはプレーンテキスト redis プロトコルを使用して接続できるかどうかを指定します。 既定値は TLS 暗号化です。

properties.clusteringPolicy

ClusteringPolicy

クラスタリング ポリシー - 既定値は OSSCluster です。 このプロパティは作成時に選択する必要があり、データベースを削除しないと変更できません。

properties.deferUpgrade

DeferUpgradeSetting

最新バージョンがリリースされたときにアップグレードを延期するオプション -既定値は NotDeferred です。 詳細情報: https://aka.ms/redisversionupgrade

properties.evictionPolicy

EvictionPolicy

Redis 削除ポリシー - 既定値は VolatileLRU です

properties.geoReplication

GeoReplication

このデータベースの geo レプリケーションを構成するためのプロパティのオプション セット。

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

リソース管理エラーの追加情報。

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

エラー オブジェクト。

EvictionPolicy

Redis 削除ポリシー - 既定値は VolatileLRU です

説明
AllKeysLFU
AllKeysLRU
AllKeysRandom
VolatileLRU
VolatileLFU
VolatileTTL
VolatileRandom
NoEviction

GeoReplication

このデータベースの geo レプリケーションを構成するためのプロパティのオプション セット。

名前 説明
groupNickname

string

リンクされたデータベース リソースのグループの名前

linkedDatabases

LinkedDatabase[]

このデータベースにリンクするデータベース リソースの一覧

LinkedDatabase

リンクされたデータベース

名前 説明
id

string (arm-id)

このデータベースにリンクするデータベース リソースのリソース ID。

state

LinkState

データベース リソース間のリンクの状態。

LinkState

データベース リソース間のリンクの状態。

説明
Linked
Linking
Unlinking
LinkFailed
UnlinkFailed

Module

モジュール設定

名前 説明
args

string

モジュールの構成オプション (例: "ERROR_RATE 0.01 INITIAL_SIZE 400")。

name

string

モジュールの名前 (例: 'RedisBloom'、'RediSearch'、'RedisTimeSeries' など)

version

string

モジュールのバージョン (例: '1.0')。

Persistence

永続化の設定

名前 説明
aofEnabled

boolean

AOF が有効かどうかを設定します。 AOF または RDB の永続化の 1 つ以上が有効になっている可能性があることに注意してください。

aofFrequency

AofFrequency

データがディスクに書き込まれる頻度を設定します。 既定値は '1s' で、"1 秒ごと" を意味します。 "always" 設定は、パフォーマンスに影響を与えるため、非推奨とされることに注意してください。

rdbEnabled

boolean

RDB が有効かどうかを設定します。 AOF または RDB の永続化の 1 つ以上が有効になっている可能性があることに注意してください。

rdbFrequency

RdbFrequency

データベースのスナップショットを作成する頻度を設定します。

Protocol

redis クライアントが TLS で暗号化された redis プロトコルまたはプレーンテキスト 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