Dela via


Redis Enterprise - Get

Hämtar information om ett Redis Enterprise-kluster

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}?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

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

Cluster

Begäran lyckades, svarstexten innehåller den begärda informationen.

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

RedisEnterpriseGet

Exempelbegäran

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

Exempelsvar

{
  "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1",
  "location": "West US",
  "kind": "v1",
  "sku": {
    "name": "EnterpriseFlash_F300",
    "capacity": 3
  },
  "zones": [
    "1",
    "2",
    "3"
  ],
  "name": "cache1",
  "type": "Microsoft.Cache/redisEnterprise",
  "tags": {},
  "properties": {
    "hostName": "cache1.westus.something.azure.com",
    "provisioningState": "Succeeded",
    "resourceState": "Running",
    "redisVersion": "6",
    "minimumTlsVersion": "1.2",
    "publicNetworkAccess": "Disabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/cachePec",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/cachePe"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Please approve my connection",
            "actionsRequired": "None"
          }
        }
      }
    ]
  }
}

Definitioner

Name Description
Cluster

Beskriver Redis Enterprise-klustret

CmkIdentityType

Endast userAssignedIdentity stöds i den här API-versionen. andra typer kan stödjas i framtiden

CustomerManagedKeyEncryption

Alla egenskaper för kundhanterad nyckelkryptering för resursen. Ställ in detta på ett tomt objekt för att använda Microsoft-hanterad nyckelkryptering.

Encryption

Kryptering i vila-konfiguration för klustret.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

HighAvailability

Aktiverad som standard. Om highAvailability är inaktiverat replikeras inte datauppsättningen. Detta påverkar serviceavtalet för tillgänglighet och ökar risken för dataförlust.

KeyEncryptionKeyIdentity

All identitetskonfiguration för kundhanterade nyckelinställningar som definierar vilken identitet som ska användas för att autentisera till Key Vault.

Kind

Särskiljer typen av kluster. Skrivskyddat.

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

PrivateEndpoint

Den privata slutpunktsresursen.

PrivateEndpointConnection

Den privata slutpunktsanslutningsresursen.

PrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

PrivateLinkServiceConnectionState

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

ProvisioningState

Aktuell etableringsstatus

PublicNetworkAccess

Om offentlig nätverkstrafik kan komma åt Redis-klustret eller inte. Endast "Aktiverad" eller "Inaktiverad" kan ställas in. null returneras endast för kluster som skapats med en gammal API-version som inte har den här egenskapen och inte kan anges.

RedundancyMode

Förklarar den aktuella redundansstrategin för klustret, vilket påverkar det förväntade serviceavtalet.

ResourceState

Aktuell resursstatus

Sku

SKU-parametrar som tillhandahålls för att skapa Redis Enterprise-klusteråtgärden.

SkuName

Nivån för Redis Enterprise-kluster som ska distribueras. Möjliga värden: ("Balanced_B5", "MemoryOptimized_M10", "ComputeOptimized_X5" osv.). Mer information om SKU:er finns i den senaste prisdokumentationen. Observera att ytterligare SKU:er kan få stöd i framtiden.

TlsVersion

Den lägsta TLS-versionen för klustret som ska stödjas, t.ex. "1.2". Nyare versioner kan läggas till i framtiden. Observera att TLS 1.0 och TLS 1.1 nu är helt föråldrade – du kan inte använda dem. De nämns endast för konsekvensen med gamla API-versioner.

UserAssignedIdentity

Användartilldelade identitetsegenskaper

Cluster

Beskriver Redis Enterprise-klustret

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ManagedServiceIdentity

Resursens identitet.

kind

Kind

Särskiljer typen av kluster. Skrivskyddat.

location

string

Den geo-plats där resursen finns

name

string

Namnet på resursen

properties.encryption

Encryption

Kryptering i vila-konfiguration för klustret.

properties.highAvailability

HighAvailability

Aktiverad som standard. Om highAvailability är inaktiverat replikeras inte datauppsättningen. Detta påverkar serviceavtalet för tillgänglighet och ökar risken för dataförlust.

properties.hostName

string

DNS-namnet på klusterslutpunkten

properties.minimumTlsVersion

TlsVersion

Den lägsta TLS-versionen för klustret som ska stödjas, t.ex. "1.2". Nyare versioner kan läggas till i framtiden. Observera att TLS 1.0 och TLS 1.1 nu är helt föråldrade – du kan inte använda dem. De nämns endast för konsekvensen med gamla API-versioner.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista över privata slutpunktsanslutningar som är associerade med det angivna Redis Enterprise-klustret

properties.provisioningState

ProvisioningState

Aktuell etableringsstatus för klustret

properties.publicNetworkAccess

PublicNetworkAccess

Om offentlig nätverkstrafik kan komma åt Redis-klustret eller inte. Endast "Aktiverad" eller "Inaktiverad" kan ställas in. null returneras endast för kluster som skapats med en gammal API-version som inte har den här egenskapen och inte kan anges.

properties.redisVersion

string

Version av redis som klustret stöder, t.ex. "6"

properties.redundancyMode

RedundancyMode

Förklarar den aktuella redundansstrategin för klustret, vilket påverkar det förväntade serviceavtalet.

properties.resourceState

ResourceState

Klustrets aktuella resursstatus

sku

Sku

Den SKU som ska skapas, vilket påverkar pris, prestanda och funktioner.

tags

object

Resursetiketter.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

zones

string[]

Tillgänglighetszonerna där det här klustret ska distribueras.

CmkIdentityType

Endast userAssignedIdentity stöds i den här API-versionen. andra typer kan stödjas i framtiden

Värde Description
systemAssignedIdentity
userAssignedIdentity

CustomerManagedKeyEncryption

Alla egenskaper för kundhanterad nyckelkryptering för resursen. Ställ in detta på ett tomt objekt för att använda Microsoft-hanterad nyckelkryptering.

Name Typ Description
keyEncryptionKeyIdentity

KeyEncryptionKeyIdentity

All identitetskonfiguration för kundhanterade nyckelinställningar som definierar vilken identitet som ska användas för att autentisera till Key Vault.

keyEncryptionKeyUrl

string

Url för nyckelkrypteringsnyckel, endast version. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Encryption

Kryptering i vila-konfiguration för klustret.

Name Typ Description
customerManagedKeyEncryption

CustomerManagedKeyEncryption

Alla egenskaper för kundhanterad nyckelkryptering för resursen. Ställ in detta på ett tomt objekt för att använda Microsoft-hanterad nyckelkryptering.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

HighAvailability

Aktiverad som standard. Om highAvailability är inaktiverat replikeras inte datauppsättningen. Detta påverkar serviceavtalet för tillgänglighet och ökar risken för dataförlust.

Värde Description
Enabled
Disabled

KeyEncryptionKeyIdentity

All identitetskonfiguration för kundhanterade nyckelinställningar som definierar vilken identitet som ska användas för att autentisera till Key Vault.

Name Typ Description
identityType

CmkIdentityType

Endast userAssignedIdentity stöds i den här API-versionen. andra typer kan stödjas i framtiden

userAssignedIdentityResourceId

string

Användartilldelad identitet som ska användas för åtkomst till url för nyckelkrypteringsnyckel. Exempel: /subscriptions//resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.

Kind

Särskiljer typen av kluster. Skrivskyddat.

Värde Description
v1
v2

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

Name Typ Description
principalId

string (uuid)

Tjänstens huvudnamns-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.

tenantId

string (uuid)

Klientorganisations-ID för den systemtilldelade identiteten. Den här egenskapen tillhandahålls endast för en systemtilldelad identitet.

type

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned identiteter
Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden.

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet (där både SystemAssigned- och UserAssigned-typer tillåts).

Värde Description
None
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned

PrivateEndpoint

Den privata slutpunktsresursen.

Name Typ Description
id

string

ARM-identifieraren för privat slutpunkt

PrivateEndpointConnection

Den privata slutpunktsanslutningsresursen.

Name Typ 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.privateEndpoint

PrivateEndpoint

Resursen för den privata slutpunkten.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Etableringstillståndet för den privata slutpunktsanslutningsresursen.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.

Värde Description
Succeeded
Creating
Deleting
Failed

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

Värde Description
Pending
Approved
Rejected

PrivateLinkServiceConnectionState

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

Name Typ Description
actionsRequired

string

Ett meddelande som anger om ändringar på tjänstleverantören kräver några uppdateringar på konsumenten.

description

string

Orsak till godkännande/avvisande av anslutningen.

status

PrivateEndpointServiceConnectionStatus

Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.

ProvisioningState

Aktuell etableringsstatus

Värde Description
Succeeded
Failed
Canceled
Creating
Updating
Deleting

PublicNetworkAccess

Om offentlig nätverkstrafik kan komma åt Redis-klustret eller inte. Endast "Aktiverad" eller "Inaktiverad" kan ställas in. null returneras endast för kluster som skapats med en gammal API-version som inte har den här egenskapen och inte kan anges.

Värde Description
Enabled
Disabled

RedundancyMode

Förklarar den aktuella redundansstrategin för klustret, vilket påverkar det förväntade serviceavtalet.

Värde Description
None

Ingen redundans. Tillgänglighetsförlust kommer att inträffa.

LR

Lokal redundans med hög tillgänglighet.

ZR

Zon redundant. Högre tillgänglighet.

ResourceState

Aktuell resursstatus

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

Sku

SKU-parametrar som tillhandahålls för att skapa Redis Enterprise-klusteråtgärden.

Name Typ Description
capacity

integer (int32)

Den här egenskapen används endast med Enterprise- och EnterpriseFlash-SKU:er. Avgör klustrets storlek. Giltiga värden är (2, 4, 6, ...) för Företags-SKU:er och (3, 9, 15, ...) för EnterpriseFlash-SKU:er.

name

SkuName

Nivån för Redis Enterprise-kluster som ska distribueras. Möjliga värden: ("Balanced_B5", "MemoryOptimized_M10", "ComputeOptimized_X5" osv.). Mer information om SKU:er finns i den senaste prisdokumentationen. Observera att ytterligare SKU:er kan få stöd i framtiden.

SkuName

Nivån för Redis Enterprise-kluster som ska distribueras. Möjliga värden: ("Balanced_B5", "MemoryOptimized_M10", "ComputeOptimized_X5" osv.). Mer information om SKU:er finns i den senaste prisdokumentationen. Observera att ytterligare SKU:er kan få stöd i framtiden.

Värde Description
Enterprise_E1
Enterprise_E5
Enterprise_E10
Enterprise_E20
Enterprise_E50
Enterprise_E100
Enterprise_E200
Enterprise_E400
EnterpriseFlash_F300
EnterpriseFlash_F700
EnterpriseFlash_F1500
Balanced_B0
Balanced_B1
Balanced_B3
Balanced_B5
Balanced_B10
Balanced_B20
Balanced_B50
Balanced_B100
Balanced_B150
Balanced_B250
Balanced_B350
Balanced_B500
Balanced_B700
Balanced_B1000
MemoryOptimized_M10
MemoryOptimized_M20
MemoryOptimized_M50
MemoryOptimized_M100
MemoryOptimized_M150
MemoryOptimized_M250
MemoryOptimized_M350
MemoryOptimized_M500
MemoryOptimized_M700
MemoryOptimized_M1000
MemoryOptimized_M1500
MemoryOptimized_M2000
ComputeOptimized_X3
ComputeOptimized_X5
ComputeOptimized_X10
ComputeOptimized_X20
ComputeOptimized_X50
ComputeOptimized_X100
ComputeOptimized_X150
ComputeOptimized_X250
ComputeOptimized_X350
ComputeOptimized_X500
ComputeOptimized_X700
FlashOptimized_A250
FlashOptimized_A500
FlashOptimized_A700
FlashOptimized_A1000
FlashOptimized_A1500
FlashOptimized_A2000
FlashOptimized_A4500

TlsVersion

Den lägsta TLS-versionen för klustret som ska stödjas, t.ex. "1.2". Nyare versioner kan läggas till i framtiden. Observera att TLS 1.0 och TLS 1.1 nu är helt föråldrade – du kan inte använda dem. De nämns endast för konsekvensen med gamla API-versioner.

Värde Description
1.0
1.1
1.2

UserAssignedIdentity

Användartilldelade identitetsegenskaper

Name Typ Description
clientId

string (uuid)

Klient-ID för den tilldelade identiteten.

principalId

string (uuid)

Huvud-ID för den tilldelade identiteten.