Databases - Create

Reference

Service:: Redis Cache

API Version:: 2024-10-01

Creates a database

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}?api-version=2024-10-01

URI Parameters

Name	In	Required	Type	Description
clusterName	path	True	string	The name of the Redis Enterprise cluster. Name must be 1-60 characters long. Allowed characters(A-Z, a-z, 0-9) and hyphen(-). There can be no leading nor trailing nor consecutive hyphens Regex pattern: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
databaseName	path	True	string	The name of the Redis Enterprise database. Regex pattern: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
properties.clientProtocol	Protocol	Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
properties.clusteringPolicy	ClusteringPolicy	Clustering policy - default is OSSCluster. Specified at create time.
properties.evictionPolicy	EvictionPolicy	Redis eviction policy - default is VolatileLRU
properties.geoReplication	GeoReplication	Optional set of properties to configure geo replication for this database.
properties.modules	Module[]	Optional set of redis modules to enable in this database - modules can only be added at creation time.
properties.persistence	Persistence	Persistence settings Persistence settings
properties.port	integer	TCP port of the database endpoint. Specified at create time. Defaults to an available port.

Responses

Name	Type	Description
200 OK	Database	The database was/is being updated. Check provisioningState and resourceState for detailed status.
201 Created	Database	The database was/is being created. Check provisioningState and resourceState for detailed status.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

RedisEnterpriseDatabasesCreate

RedisEnterpriseDatabasesCreate With Active Geo Replication

RedisEnterpriseDatabasesCreate

Sample request

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

Sample response

Status code:: 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"
      }
    ]
  }
}

Status code:: 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

Sample request

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

Sample response

Status code:: 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"
        }
      ]
    }
  }
}

Status code:: 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"
        }
      ]
    }
  }
}

Definitions

Name	Description
AofFrequency	Sets the frequency at which data is written to disk.
ClusteringPolicy	Clustering policy - default is OSSCluster. Specified at create time.
Database	Describes a database on the RedisEnterprise cluster
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
EvictionPolicy	Redis eviction policy - default is VolatileLRU
GeoReplication	Optional set of properties to configure geo replication for this database.
LinkedDatabase	Linked Database
LinkState	State of the link between the database resources.
Module	Module settings
Persistence	Persistence settings
Protocol	Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
ProvisioningState	Current provisioning status
RdbFrequency	Sets the frequency at which a snapshot of the database is created.
ResourceState	Current resource status

AofFrequency

Enumeration

Sets the frequency at which data is written to disk.

Value	Description
1s
always

ClusteringPolicy

Enumeration

Clustering policy - default is OSSCluster. Specified at create time.

Value	Description
EnterpriseCluster
OSSCluster

Database

Object

Describes a database on the RedisEnterprise cluster

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.clientProtocol	Protocol	Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.
properties.clusteringPolicy	ClusteringPolicy	Clustering policy - default is OSSCluster. Specified at create time.
properties.evictionPolicy	EvictionPolicy	Redis eviction policy - default is VolatileLRU
properties.geoReplication	GeoReplication	Optional set of properties to configure geo replication for this database.
properties.modules	Module[]	Optional set of redis modules to enable in this database - modules can only be added at creation time.
properties.persistence	Persistence	Persistence settings Persistence settings
properties.port	integer	TCP port of the database endpoint. Specified at create time. Defaults to an available port.
properties.provisioningState	ProvisioningState	Current provisioning status of the database
properties.resourceState	ResourceState	Current resource status of the database
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

EvictionPolicy

Enumeration

Redis eviction policy - default is VolatileLRU

Value	Description
AllKeysLFU
AllKeysLRU
AllKeysRandom
NoEviction
VolatileLFU
VolatileLRU
VolatileRandom
VolatileTTL

GeoReplication

Object

Optional set of properties to configure geo replication for this database.

Name	Type	Description
groupNickname	string	Name for the group of linked database resources
linkedDatabases	LinkedDatabase[]	List of database resources to link with this database

LinkedDatabase

Object

Linked Database

Name	Type	Description
id	string	Resource ID of a database resource to link with this database.
state	LinkState	State of the link between the database resources.

LinkState

Enumeration

State of the link between the database resources.

Value	Description
LinkFailed
Linked
Linking
UnlinkFailed
Unlinking

Module

Object

Module settings

Name	Type	Description
args	string	Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.
name	string	The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
version	string	The version of the module, e.g. '1.0'.

Persistence

Object

Persistence settings

Name	Type	Description
aofEnabled	boolean	Sets whether AOF is enabled.
aofFrequency	AofFrequency	Sets the frequency at which data is written to disk.
rdbEnabled	boolean	Sets whether RDB is enabled.
rdbFrequency	RdbFrequency	Sets the frequency at which a snapshot of the database is created.

Protocol

Enumeration

Specifies whether redis clients can connect using TLS-encrypted or plaintext redis protocols. Default is TLS-encrypted.

Value	Description
Encrypted
Plaintext

ProvisioningState

Enumeration

Current provisioning status

Value	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

RdbFrequency

Enumeration

Sets the frequency at which a snapshot of the database is created.

Value	Description
12h
1h
6h

ResourceState

Enumeration

Current resource status

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

Share via

Databases - Create

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

RedisEnterpriseDatabasesCreate

Sample request

Sample response

RedisEnterpriseDatabasesCreate With Active Geo Replication

Sample request

Sample response

Definitions

AofFrequency

ClusteringPolicy

Database

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

GeoReplication

LinkedDatabase

LinkState

Module

Persistence

Protocol

ProvisioningState

RdbFrequency

ResourceState

Additional resources