Databases - Get

Tjänst:: Redis Cache

API-version:: 2025-07-01

Hämtar information om en databas i ett Redis Enterprise-kluster.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
clusterName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	Namnet på Redis Enterprise-klustret. Namnet måste vara 1–60 tecken långt. Tillåtna tecken(A-Z, a-z, 0-9) och bindestreck(-). Det får inte finnas några inledande eller avslutande eller efterföljande bindestreck
databaseName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	Namnet på Redis Enterprise-databasen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	Database	Databasen har hittats
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

RedisEnterpriseDatabasesGet

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
  }
}

Definitioner

Name	Description
accessKeysAuthentication	Den här egenskapen kan aktiveras/inaktiveras för att tillåta eller neka åtkomst med de aktuella åtkomstnycklarna. Kan uppdateras även efter att databasen har skapats. Standardvärdet är Inaktiverat.
AofFrequency	Anger hur ofta data skrivs till disk. Standardvärdet är "1s", vilket betyder "varje sekund". Observera att inställningen "alltid" är inaktuell på grund av dess prestandapåverkan.
ClusteringPolicy	Klustringsprincip – standardvärdet är OSSCluster. Den här egenskapen kan bara uppdateras om det aktuella värdet är NoCluster. Om värdet är OSSCluster eller EnterpriseCluster kan det inte uppdateras utan att databasen tas bort.
Database	Beskriver en databas i Redis Enterprise-klustret
DeferUpgradeSetting	Alternativ för att skjuta upp uppgraderingen när den senaste versionen släpps – standardvärdet är NotDeferred. Lära sig mer: https://aka.ms/redisversionupgrade
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
EvictionPolicy	Redis-borttagningsprincip – standardvärdet är VolatileLRU
GeoReplication	Valfri uppsättning egenskaper för att konfigurera geo-replikering för den här databasen.
LinkedDatabase	Länkad databas
LinkState	Tillståndet för länken mellan databasresurserna.
Module	Modulinställningar
Persistence	Inställningar för beständighet
Protocol	Anger om Redis-klienter kan ansluta med TLS-krypterade eller redis-protokoll i klartext. Standardvärdet är TLS-krypterat.
ProvisioningState	Aktuell etableringsstatus
RdbFrequency	Anger hur ofta en ögonblicksbild av databasen skapas.
ResourceState	Aktuell resursstatus

accessKeysAuthentication

Uppräkning

Den här egenskapen kan aktiveras/inaktiveras för att tillåta eller neka åtkomst med de aktuella åtkomstnycklarna. Kan uppdateras även efter att databasen har skapats. Standardvärdet är Inaktiverat.

Värde	Description
Disabled
Enabled

AofFrequency

Uppräkning

Anger hur ofta data skrivs till disk. Standardvärdet är "1s", vilket betyder "varje sekund". Observera att inställningen "alltid" är inaktuell på grund av dess prestandapåverkan.

Värde	Description
1s
always

ClusteringPolicy

Uppräkning

Klustringsprincip – standardvärdet är OSSCluster. Den här egenskapen kan bara uppdateras om det aktuella värdet är NoCluster. Om värdet är OSSCluster eller EnterpriseCluster kan det inte uppdateras utan att databasen tas bort.

Värde	Description
EnterpriseCluster	Företagsklustringsprincipen använder endast det klassiska Redis-protokollet, som inte stöder redis-klusterkommandon.
OSSCluster	OSS-klustringsprincipen följer redis-klusterspecifikationen och kräver att alla klienter stöder redis-klustring.
NoCluster	NoCluster-principen används för icke-klustrade Redis-instanser som inte kräver klustringsfunktioner.

Database

Objekt

Beskriver en databas i Redis Enterprise-klustret

Name	Typ	Standardvärde	Description
id	string		Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Namnet på resursen
properties.accessKeysAuthentication	accessKeysAuthentication	Disabled	Den här egenskapen kan aktiveras/inaktiveras för att tillåta eller neka åtkomst med de aktuella åtkomstnycklarna. Kan uppdateras även efter att databasen har skapats. Standardvärdet är Inaktiverat.
properties.clientProtocol	Protocol		Anger om Redis-klienter kan ansluta med TLS-krypterade eller redis-protokoll i klartext. Standardvärdet är TLS-krypterat.
properties.clusteringPolicy	ClusteringPolicy		Klustringsprincip – standardvärdet är OSSCluster. Den här egenskapen kan bara uppdateras om det aktuella värdet är NoCluster. Om värdet är OSSCluster eller EnterpriseCluster kan det inte uppdateras utan att databasen tas bort.
properties.deferUpgrade	DeferUpgradeSetting		Alternativ för att skjuta upp uppgraderingen när den senaste versionen släpps – standardvärdet är NotDeferred. Lära sig mer: https://aka.ms/redisversionupgrade
properties.evictionPolicy	EvictionPolicy		Redis-borttagningsprincip – standardvärdet är VolatileLRU
properties.geoReplication	GeoReplication		Valfri uppsättning egenskaper för att konfigurera geo-replikering för den här databasen.
properties.modules	Module[]		Valfri uppsättning redis-moduler som ska aktiveras i den här databasen – moduler kan bara läggas till när de skapas.
properties.persistence	Persistence		Inställningar för beständighet Inställningar för beständighet
properties.port	integer (int32)		TCP-port för databasslutpunkten. Anges vid skapandetillfället. Standardvärdet är en tillgänglig port.
properties.provisioningState	ProvisioningState		Databasens aktuella etableringsstatus
properties.redisVersion	string		Version av Redis som databasen körs på, t.ex. "6.0"
properties.resourceState	ResourceState		Databasens aktuella resursstatus
type	string		Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

DeferUpgradeSetting

Uppräkning

Alternativ för att skjuta upp uppgraderingen när den senaste versionen släpps – standardvärdet är NotDeferred. Lära sig mer: https://aka.ms/redisversionupgrade

Värde	Description
Deferred
NotDeferred

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

EvictionPolicy

Uppräkning

Redis-borttagningsprincip – standardvärdet är VolatileLRU

Värde	Description
AllKeysLFU
AllKeysLRU
AllKeysRandom
VolatileLRU
VolatileLFU
VolatileTTL
VolatileRandom
NoEviction

GeoReplication

Objekt

Valfri uppsättning egenskaper för att konfigurera geo-replikering för den här databasen.

Name	Typ	Description
groupNickname	string	Namn på gruppen med länkade databasresurser
linkedDatabases	LinkedDatabase[]	Lista över databasresurser som ska länkas till den här databasen

LinkedDatabase

Objekt

Länkad databas

Name	Typ	Description
id	string (arm-id)	Resurs-ID för en databasresurs som ska länkas till den här databasen.
state	LinkState	Tillståndet för länken mellan databasresurserna.

LinkState

Uppräkning

Tillståndet för länken mellan databasresurserna.

Värde	Description
Linked
Linking
Unlinking
LinkFailed
UnlinkFailed

Module

Objekt

Modulinställningar

Name	Typ	Description
args	string	Konfigurationsalternativ för modulen, t.ex. "ERROR_RATE 0.01 INITIAL_SIZE 400".
name	string	Namnet på modulen, t.ex. "RedisBloom", "RediSearch", "RedisTimeSeries"
version	string	Versionen av modulen, t.ex. '1.0'.

Persistence

Objekt

Inställningar för beständighet

Name	Typ	Description
aofEnabled	boolean	Anger om AOF är aktiverat. Observera att högst en av AOF- eller RDB-beständigheterna kan vara aktiverad.
aofFrequency	AofFrequency	Anger hur ofta data skrivs till disk. Standardvärdet är "1s", vilket betyder "varje sekund". Observera att inställningen "alltid" är inaktuell på grund av dess prestandapåverkan.
rdbEnabled	boolean	Anger om RDB är aktiverat. Observera att högst en av AOF- eller RDB-beständigheterna kan vara aktiverad.
rdbFrequency	RdbFrequency	Anger hur ofta en ögonblicksbild av databasen skapas.

Protocol

Uppräkning

Anger om Redis-klienter kan ansluta med TLS-krypterade eller redis-protokoll i klartext. Standardvärdet är TLS-krypterat.

Värde	Description
Encrypted
Plaintext

ProvisioningState

Uppräkning

Aktuell etableringsstatus

Värde	Description
Succeeded
Failed
Canceled
Creating
Updating
Deleting

RdbFrequency

Uppräkning

Anger hur ofta en ögonblicksbild av databasen skapas.

Värde	Description
1h
6h
12h

ResourceState

Uppräkning

Aktuell resursstatus

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

Dela via

Databases - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

RedisEnterpriseDatabasesGet

Exempelbegäran

Exempelsvar

Definitioner

accessKeysAuthentication

AofFrequency

ClusteringPolicy

Database

DeferUpgradeSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

GeoReplication

LinkedDatabase

LinkState

Module

Persistence

Protocol

ProvisioningState

RdbFrequency

ResourceState