Databases - Get

Reference

Service:: Redis Cache

API Version:: 2024-10-01

Gets information about a database in a RedisEnterprise cluster.

GET 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.

Responses

Name	Type	Description
200 OK	Database	Successfully found the database
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

RedisEnterpriseDatabasesGet

Sample request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2024-10-01

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": "Succeeded",
    "resourceState": "Running",
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "OSSCluster",
    "evictionPolicy": "AllKeysLRU",
    "persistence": {
      "rdbEnabled": true,
      "rdbFrequency": "12h"
    },
    "port": 10000,
    "modules": [
      {
        "name": "RediSearch",
        "args": "",
        "version": "1.0.0"
      }
    ]
  }
}

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

Sets the frequency at which data is written to disk.

Name	Type	Description
1s	string
always	string

ClusteringPolicy

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

Name	Type	Description
EnterpriseCluster	string
OSSCluster	string

Database

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

The resource management error additional info.

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

ErrorDetail

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

Error response

Name	Type	Description
error	ErrorDetail	The error object.

EvictionPolicy

Redis eviction policy - default is VolatileLRU

Name	Type	Description
AllKeysLFU	string
AllKeysLRU	string
AllKeysRandom	string
NoEviction	string
VolatileLFU	string
VolatileLRU	string
VolatileRandom	string
VolatileTTL	string

GeoReplication

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

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

State of the link between the database resources.

Name	Type	Description
LinkFailed	string
Linked	string
Linking	string
UnlinkFailed	string
Unlinking	string

Module

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

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

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

Name	Type	Description
Encrypted	string
Plaintext	string

ProvisioningState

Current provisioning status

Name	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

RdbFrequency

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

Name	Type	Description
12h	string
1h	string
6h	string

ResourceState

Current resource status

Name	Type	Description
CreateFailed	string
Creating	string
DeleteFailed	string
Deleting	string
DisableFailed	string
Disabled	string
Disabling	string
EnableFailed	string
Enabling	string
Running	string
Scaling	string
ScalingFailed	string
UpdateFailed	string
Updating	string

Share via