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 パラメーター

名前	/	必須	型	説明
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.clientProtocol	Protocol	redis クライアントが TLS で暗号化された redis プロトコルまたはプレーンテキスト redis プロトコルを使用して接続できるかどうかを指定します。既定値は TLS 暗号化です。
properties.clusteringPolicy	ClusteringPolicy	クラスタリングポリシー - 既定値は OSSCluster です。作成時に指定されます。
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

要求のサンプル

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"
        }
      ]
    }
  }
}

定義

名前	説明
AofFrequency	データがディスクに書き込まれる頻度を設定します。
ClusteringPolicy	クラスタリングポリシー - 既定値は OSSCluster です。作成時に指定されます。
Database	RedisEnterprise クラスター上のデータベースについて説明します
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
EvictionPolicy	Redis 削除ポリシー - 既定値は VolatileLRU です
GeoReplication	このデータベースの geo レプリケーションを構成するためのプロパティのオプションセット。
LinkedDatabase	リンクされたデータベース
LinkState	データベースリソース間のリンクの状態。
Module	モジュールの設定
Persistence	永続化の設定
Protocol	redis クライアントが TLS で暗号化された redis プロトコルまたはプレーンテキスト redis プロトコルを使用して接続できるかどうかを指定します。既定値は TLS 暗号化です。
ProvisioningState	現在のプロビジョニングの状態
RdbFrequency	データベースのスナップショットを作成する頻度を設定します。
ResourceState	現在のリソースの状態

AofFrequency

列挙

データがディスクに書き込まれる頻度を設定します。

値	説明
1s
always

ClusteringPolicy

列挙

クラスタリングポリシー - 既定値は OSSCluster です。作成時に指定されます。

値	説明
EnterpriseCluster
OSSCluster

Database

Object

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

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.clientProtocol	Protocol	redis クライアントが TLS で暗号化された redis プロトコルまたはプレーンテキスト redis プロトコルを使用して接続できるかどうかを指定します。既定値は TLS 暗号化です。
properties.clusteringPolicy	ClusteringPolicy	クラスタリングポリシー - 既定値は OSSCluster です。作成時に指定されます。
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.resourceState	ResourceState	データベースの現在のリソースの状態
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

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
NoEviction
VolatileLFU
VolatileLRU
VolatileRandom
VolatileTTL

GeoReplication

Object

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

名前	型	説明
groupNickname	string	リンクされたデータベースリソースのグループの名前
linkedDatabases	LinkedDatabase[]	このデータベースにリンクするデータベースリソースの一覧

LinkedDatabase

Object

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

名前	型	説明
id	string (arm-id)	このデータベースにリンクするデータベースリソースのリソース ID。
state	LinkState	データベースリソース間のリンクの状態。

LinkState

列挙

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

値	説明
LinkFailed
Linked
Linking
UnlinkFailed
Unlinking

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 が有効かどうかを設定します。
aofFrequency	AofFrequency	データがディスクに書き込まれる頻度を設定します。
rdbEnabled	boolean	RDB が有効かどうかを設定します。
rdbFrequency	RdbFrequency	データベースのスナップショットを作成する頻度を設定します。

Protocol

列挙

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

値	説明
Encrypted
Plaintext

ProvisioningState

列挙

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

値	説明
Canceled
Creating
Deleting
Failed
Succeeded
Updating

RdbFrequency

列挙

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

値	説明
12h
1h
6h

ResourceState

列挙

現在のリソースの状態

値	説明
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

その他のリソース