Databases - Get

Service:: Redis Cache

API-versie:: 2025-07-01

Hiermee haalt u informatie op over een database in een Redis Enterprise-cluster.

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

URI-parameters

Name	In	Vereist	Type	Description
clusterName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	De naam van het Redis Enterprise-cluster. De naam moet 1 tot 60 tekens lang zijn. Toegestane tekens (A-Z, a-z, 0-9) en afbreekstreepje(-). Er kunnen geen voorloop- of volgstreepjes of opeenvolgende afbreekstreepjes zijn
databaseName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	De naam van de Redis Enterprise-database.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	Database	De database met succes gevonden
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

RedisEnterpriseDatabasesGet

Voorbeeldaanvraag

GET https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2025-07-01


/**
 * Samples for Databases Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/
     * RedisEnterpriseDatabasesGet.json
     */
    /**
     * Sample code: RedisEnterpriseDatabasesGet.
     * 
     * @param manager Entry point to RedisEnterpriseManager.
     */
    public static void
        redisEnterpriseDatabasesGet(com.azure.resourcemanager.redisenterprise.RedisEnterpriseManager manager) {
        manager.databases().getWithResponse("rg1", "cache1", "default", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.redisenterprise import RedisEnterpriseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-redisenterprise
# USAGE
    python redis_enterprise_databases_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = RedisEnterpriseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f",
    )

    response = client.databases.get(
        resource_group_name="rg1",
        cluster_name="cache1",
        database_name="default",
    )
    print(response)


# x-ms-original-file: specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/RedisEnterpriseDatabasesGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armredisenterprise_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/redisenterprise/armredisenterprise/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/3855ffb4be0cd4d227b130b67d874fa816736c04/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/RedisEnterpriseDatabasesGet.json
func ExampleDatabasesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armredisenterprise.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDatabasesClient().Get(ctx, "rg1", "cache1", "default", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Database = armredisenterprise.Database{
	// 	Name: to.Ptr("cache1/default"),
	// 	Type: to.Ptr("Microsoft.Cache/redisEnterprise/databases"),
	// 	ID: to.Ptr("/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default"),
	// 	Properties: &armredisenterprise.DatabaseCreateProperties{
	// 		AccessKeysAuthentication: to.Ptr(armredisenterprise.AccessKeysAuthenticationEnabled),
	// 		ClientProtocol: to.Ptr(armredisenterprise.ProtocolEncrypted),
	// 		ClusteringPolicy: to.Ptr(armredisenterprise.ClusteringPolicyOSSCluster),
	// 		DeferUpgrade: to.Ptr(armredisenterprise.DeferUpgradeSettingNotDeferred),
	// 		EvictionPolicy: to.Ptr(armredisenterprise.EvictionPolicyAllKeysLRU),
	// 		Modules: []*armredisenterprise.Module{
	// 			{
	// 				Name: to.Ptr("RediSearch"),
	// 				Args: to.Ptr(""),
	// 				Version: to.Ptr("1.0.0"),
	// 		}},
	// 		Persistence: &armredisenterprise.Persistence{
	// 			RdbEnabled: to.Ptr(true),
	// 			RdbFrequency: to.Ptr(armredisenterprise.RdbFrequencyTwelveH),
	// 		},
	// 		Port: to.Ptr[int32](10000),
	// 		ProvisioningState: to.Ptr(armredisenterprise.ProvisioningStateSucceeded),
	// 		RedisVersion: to.Ptr("6.0"),
	// 		ResourceState: to.Ptr(armredisenterprise.ResourceStateRunning),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { RedisEnterpriseManagementClient } = require("@azure/arm-redisenterprisecache");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets information about a database in a Redis Enterprise cluster.
 *
 * @summary Gets information about a database in a Redis Enterprise cluster.
 * x-ms-original-file: specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/stable/2025-07-01/examples/RedisEnterpriseDatabasesGet.json
 */
async function redisEnterpriseDatabasesGet() {
  const subscriptionId =
    process.env["REDISENTERPRISE_SUBSCRIPTION_ID"] || "e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f";
  const resourceGroupName = process.env["REDISENTERPRISE_RESOURCE_GROUP"] || "rg1";
  const clusterName = "cache1";
  const databaseName = "default";
  const credential = new DefaultAzureCredential();
  const client = new RedisEnterpriseManagementClient(credential, subscriptionId);
  const result = await client.databases.get(resourceGroupName, clusterName, databaseName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Voorbeeldrespons

Statuscode:: 200

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

Definities

Name	Description
accessKeysAuthentication	Deze eigenschap kan worden ingeschakeld/uitgeschakeld om toegang met de huidige toegangssleutels toe te staan of te weigeren. Kan worden bijgewerkt, zelfs nadat de database is gemaakt. De standaardwaarde is uitgeschakeld.
AofFrequency	Hiermee stelt u de frequentie in waarmee gegevens naar schijf worden geschreven. De standaardwaarde is '1s', wat 'elke seconde' betekent. Houd er rekening mee dat de instelling 'altijd' is afgeschaft vanwege de gevolgen voor de prestaties.
ClusteringPolicy	Clusteringbeleid: standaard is OSSCluster. Deze eigenschap kan alleen worden bijgewerkt als de huidige waarde NoCluster is. Als de waarde OSSCluster of EnterpriseCluster is, kan deze niet worden bijgewerkt zonder de database te verwijderen.
Database	Beschrijft een database op het Redis Enterprise-cluster
DeferUpgradeSetting	Optie om de upgrade uit te stellen wanneer de nieuwste versie wordt uitgebracht: de standaardwaarde is NotDeferred. Meer informatie: https://aka.ms/redisversionupgrade
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
EvictionPolicy	Redis-verwijderingsbeleid - standaard is VolatileLRU
GeoReplication	Optionele set eigenschappen voor het configureren van geo-replicatie voor deze database.
LinkedDatabase	Gekoppelde database
LinkState	Staat van de koppeling tussen de databasebronnen.
Module	Module-instellingen
Persistence	Persistentie-instellingen
Protocol	Hiermee geeft u op of redis-clients verbinding kunnen maken met behulp van met TLS versleutelde of redis-protocollen zonder opmaak. Standaard is TLS-versleuteld.
ProvisioningState	Huidige provisioningstatus
RdbFrequency	Hiermee stelt u de frequentie in waarmee een momentopname van de database wordt gemaakt.
ResourceState	Huidige status van de middelen

accessKeysAuthentication

Inventarisatie

Deze eigenschap kan worden ingeschakeld/uitgeschakeld om toegang met de huidige toegangssleutels toe te staan of te weigeren. Kan worden bijgewerkt, zelfs nadat de database is gemaakt. De standaardwaarde is uitgeschakeld.

Waarde	Description
Disabled
Enabled

AofFrequency

Inventarisatie

Hiermee stelt u de frequentie in waarmee gegevens naar schijf worden geschreven. De standaardwaarde is '1s', wat 'elke seconde' betekent. Houd er rekening mee dat de instelling 'altijd' is afgeschaft vanwege de gevolgen voor de prestaties.

Waarde	Description
1s
always

ClusteringPolicy

Inventarisatie

Clusteringbeleid: standaard is OSSCluster. Deze eigenschap kan alleen worden bijgewerkt als de huidige waarde NoCluster is. Als de waarde OSSCluster of EnterpriseCluster is, kan deze niet worden bijgewerkt zonder de database te verwijderen.

Waarde	Description
EnterpriseCluster	In het clusterbeleid voor ondernemingen wordt alleen gebruikgemaakt van het klassieke redis-protocol, dat geen ondersteuning biedt voor redis-clusteropdrachten.
OSSCluster	Het OSS-clusterbeleid volgt de redis-clusterspecificatie en vereist dat alle clients redis-clustering ondersteunen.
NoCluster	Het NoCluster-beleid wordt gebruikt voor niet-geclusterde Redis-exemplaren waarvoor geen clusterfuncties zijn vereist.

Database

Object

Beschrijft een database op het Redis Enterprise-cluster

Name	Type	Default value	Description
id	string		Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		De naam van de resource
properties.accessKeysAuthentication	accessKeysAuthentication	Disabled	Deze eigenschap kan worden ingeschakeld/uitgeschakeld om toegang met de huidige toegangssleutels toe te staan of te weigeren. Kan worden bijgewerkt, zelfs nadat de database is gemaakt. De standaardwaarde is uitgeschakeld.
properties.clientProtocol	Protocol		Hiermee geeft u op of redis-clients verbinding kunnen maken met behulp van met TLS versleutelde of redis-protocollen zonder opmaak. Standaard is TLS-versleuteld.
properties.clusteringPolicy	ClusteringPolicy		Clusteringbeleid: standaard is OSSCluster. Deze eigenschap kan alleen worden bijgewerkt als de huidige waarde NoCluster is. Als de waarde OSSCluster of EnterpriseCluster is, kan deze niet worden bijgewerkt zonder de database te verwijderen.
properties.deferUpgrade	DeferUpgradeSetting		Optie om de upgrade uit te stellen wanneer de nieuwste versie wordt uitgebracht: de standaardwaarde is NotDeferred. Meer informatie: https://aka.ms/redisversionupgrade
properties.evictionPolicy	EvictionPolicy		Redis-verwijderingsbeleid - standaard is VolatileLRU
properties.geoReplication	GeoReplication		Optionele set eigenschappen voor het configureren van geo-replicatie voor deze database.
properties.modules	Module[]		Optionele set redis-modules die in deze database kunnen worden ingeschakeld, kunnen modules alleen worden toegevoegd tijdens het maken.
properties.persistence	Persistence		Persistentie-instellingen Persistentie-instellingen
properties.port	integer (int32)		TCP-poort van het database-eindpunt. Opgegeven tijdens het maken. Standaard ingesteld op een beschikbare poort.
properties.provisioningState	ProvisioningState		Huidige provisioningstatus van de database
properties.redisVersion	string		Versie van Redis waarop de database draait, bijvoorbeeld '6.0'
properties.resourceState	ResourceState		Huidige resourcestatus van de database
type	string		Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

DeferUpgradeSetting

Inventarisatie

Optie om de upgrade uit te stellen wanneer de nieuwste versie wordt uitgebracht: de standaardwaarde is NotDeferred. Meer informatie: https://aka.ms/redisversionupgrade

Waarde	Description
Deferred
NotDeferred

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

EvictionPolicy

Inventarisatie

Redis-verwijderingsbeleid - standaard is VolatileLRU

Waarde	Description
AllKeysLFU
AllKeysLRU
AllKeysRandom
VolatileLRU
VolatileLFU
VolatileTTL
VolatileRandom
NoEviction

GeoReplication

Object

Optionele set eigenschappen voor het configureren van geo-replicatie voor deze database.

Name	Type	Description
groupNickname	string	Naam voor de groep gekoppelde databasebronnen
linkedDatabases	LinkedDatabase[]	Lijst met databasebronnen die u aan deze database wilt koppelen

LinkedDatabase

Object

Gekoppelde database

Name	Type	Description
id	string (arm-id)	Resource-id van een databaseresource die moet worden gekoppeld aan deze database.
state	LinkState	Staat van de koppeling tussen de databasebronnen.

LinkState

Inventarisatie

Staat van de koppeling tussen de databasebronnen.

Waarde	Description
Linked
Linking
Unlinking
LinkFailed
UnlinkFailed

Module

Object

Module-instellingen

Name	Type	Description
args	string	Configuratieopties voor de module, bijvoorbeeld 'ERROR_RATE 0,01 INITIAL_SIZE 400'.
name	string	De naam van de module, bijvoorbeeld 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
version	string	De versie van de module, bijvoorbeeld '1.0'.

Persistence

Object

Persistentie-instellingen

Name	Type	Description
aofEnabled	boolean	Hiermee stelt u in of AOF is ingeschakeld. Houd er rekening mee dat maximaal een van de AOF- of RDB-persistentie is ingeschakeld.
aofFrequency	AofFrequency	Hiermee stelt u de frequentie in waarmee gegevens naar schijf worden geschreven. De standaardwaarde is '1s', wat 'elke seconde' betekent. Houd er rekening mee dat de instelling 'altijd' is afgeschaft vanwege de gevolgen voor de prestaties.
rdbEnabled	boolean	Hiermee stelt u in of RDB is ingeschakeld. Houd er rekening mee dat maximaal een van de AOF- of RDB-persistentie is ingeschakeld.
rdbFrequency	RdbFrequency	Hiermee stelt u de frequentie in waarmee een momentopname van de database wordt gemaakt.

Protocol

Inventarisatie

Hiermee geeft u op of redis-clients verbinding kunnen maken met behulp van met TLS versleutelde of redis-protocollen zonder opmaak. Standaard is TLS-versleuteld.

Waarde	Description
Encrypted
Plaintext

ProvisioningState

Inventarisatie

Huidige provisioningstatus

Waarde	Description
Succeeded
Failed
Canceled
Creating
Updating
Deleting

RdbFrequency

Inventarisatie

Hiermee stelt u de frequentie in waarmee een momentopname van de database wordt gemaakt.

Waarde	Description
1h
6h
12h

ResourceState

Inventarisatie

Huidige status van de middelen

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

Delen via

Databases - Get

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

RedisEnterpriseDatabasesGet

Voorbeeldaanvraag

Voorbeeldrespons

Definities

accessKeysAuthentication

AofFrequency

ClusteringPolicy

Database

DeferUpgradeSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

GeoReplication

LinkedDatabase

LinkState

Module

Persistence

Protocol

ProvisioningState

RdbFrequency

ResourceState