Redis Enterprise - Get

Reference

Služba:: Redis Cache

Verze rozhraní API:: 2024-10-01

Získá informace o clusteru RedisEnterprise.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
clusterName	path	True	string	Název clusteru Redis Enterprise. Název musí mít délku 1 až 60 znaků. Povolené znaky(A-Z, a-z, 0-9) a spojovník(-). Nesmí existovat žádné úvodní ani koncové ani po sobě jdoucí pomlčky. Vzor regulárního výrazu: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	Cluster	Požadavek byl úspěšný, text odpovědi obsahuje požadované podrobnosti.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

RedisEnterpriseGet

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1",
  "location": "West US",
  "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",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/cachePec",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/cachePe"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Please approve my connection",
            "actionsRequired": "None"
          }
        }
      }
    ]
  }
}

Definice

Name	Description
Cluster	Popisuje cluster RedisEnterprise.
CmkIdentityType	V této verzi rozhraní API se podporuje pouze userAssignedIdentity; další typy mohou být v budoucnu podporovány.
CustomerManagedKeyEncryption	Všechny vlastnosti šifrování klíče spravované zákazníkem pro prostředek. Nastavte ho na prázdný objekt pro použití šifrování klíče spravovaného Microsoftem.
Encryption	Konfigurace šifrování neaktivních uložených dat pro cluster
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
KeyEncryptionKeyIdentity	Veškerá konfigurace identity pro nastavení klíčů spravovaných zákazníkem definující identitu, která se má použít k ověřování ve službě Key Vault.
ManagedServiceIdentity	Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)
ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
PrivateEndpoint	Prostředek privátního koncového bodu.
PrivateEndpointConnection	Prostředek připojení privátního koncového bodu.
PrivateEndpointConnectionProvisioningState	Aktuální stav zřizování.
PrivateEndpointServiceConnectionStatus	Stav připojení privátního koncového bodu.
PrivateLinkServiceConnectionState	Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.
ProvisioningState	Aktuální stav zřizování
ResourceState	Aktuální stav zdroje
Sku	Parametry skladové položky zadané do operace vytvoření RedisEnterprise
SkuName	Typ clusteru RedisEnterprise, který se má nasadit. Možné hodnoty: (Enterprise_E10, EnterpriseFlash_F300 atd.)
TlsVersion	Minimální verze protokolu TLS pro cluster pro podporu, např. 1.2
UserAssignedIdentity	Vlastnosti identity přiřazené uživatelem

Cluster

Popisuje cluster RedisEnterprise.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identita prostředku.
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.encryption	Encryption	Konfigurace šifrování neaktivních uložených dat pro cluster
properties.hostName	string	Název DNS koncového bodu clusteru
properties.minimumTlsVersion	TlsVersion	Minimální verze protokolu TLS pro cluster pro podporu, např. 1.2
properties.privateEndpointConnections	PrivateEndpointConnection[]	Seznam připojení privátních koncových bodů přidružených k zadanému clusteru RedisEnterprise
properties.provisioningState	ProvisioningState	Aktuální stav zřizování clusteru
properties.redisVersion	string	Verze redis, která cluster podporuje, např. 6
properties.resourceState	ResourceState	Aktuální stav prostředku clusteru
sku	Sku	Skladová položka, která se má vytvořit, což má vliv na cenu, výkon a funkce.
tags	object	Značky prostředků
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts
zones	string[]	Zóny dostupnosti, ve kterých se tento cluster nasadí.

CmkIdentityType

V této verzi rozhraní API se podporuje pouze userAssignedIdentity; další typy mohou být v budoucnu podporovány.

Name	Typ	Description
systemAssignedIdentity	string
userAssignedIdentity	string

CustomerManagedKeyEncryption

Všechny vlastnosti šifrování klíče spravované zákazníkem pro prostředek. Nastavte ho na prázdný objekt pro použití šifrování klíče spravovaného Microsoftem.

Name	Typ	Description
keyEncryptionKeyIdentity	KeyEncryptionKeyIdentity	Veškerá konfigurace identity pro nastavení klíčů spravovaných zákazníkem definující identitu, která se má použít k ověřování ve službě Key Vault.
keyEncryptionKeyUrl	string	Adresa URL šifrovacího klíče, pouze verze. Příklad: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Encryption

Konfigurace šifrování neaktivních uložených dat pro cluster

Name	Typ	Description
customerManagedKeyEncryption	CustomerManagedKeyEncryption	Všechny vlastnosti šifrování klíče spravované zákazníkem pro prostředek. Nastavte ho na prázdný objekt pro použití šifrování klíče spravovaného Microsoftem.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

KeyEncryptionKeyIdentity

Veškerá konfigurace identity pro nastavení klíčů spravovaných zákazníkem definující identitu, která se má použít k ověřování ve službě Key Vault.

Name	Typ	Description
identityType	CmkIdentityType	V této verzi rozhraní API se podporuje pouze userAssignedIdentity; další typy mohou být v budoucnu podporovány.
userAssignedIdentityResourceId	string	Identita přiřazená uživatelem, která se má použít pro přístup k adrese URL šifrovacího klíče klíče. Příklad: /subscriptions/_{/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.}

ManagedServiceIdentity

Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)

Name	Typ	Description
principalId	string	ID instančního objektu identity přiřazené systémem. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
tenantId	string	ID tenanta přiřazené identity systému. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.
type	ManagedServiceIdentityType	Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	identity User-Assigned Sada identit přiřazených uživatelem přidružená k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích.

ManagedServiceIdentityType

Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

Prostředek privátního koncového bodu.

Name	Typ	Description
id	string	Identifikátor ARM pro privátní koncový bod

PrivateEndpointConnection

Prostředek připojení privátního koncového bodu.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.privateEndpoint	PrivateEndpoint	Prostředek privátního koncového bodu.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stav zřizování prostředku připojení privátního koncového bodu.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

PrivateEndpointConnectionProvisioningState

Aktuální stav zřizování.

Name	Typ	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

Stav připojení privátního koncového bodu.

Name	Typ	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.

Name	Typ	Description
actionsRequired	string	Zpráva, která indikuje, jestli změny poskytovatele služeb vyžadují aktualizace příjemce.
description	string	Důvod schválení nebo zamítnutí připojení.
status	PrivateEndpointServiceConnectionStatus	Určuje, jestli bylo připojení schváleno, odmítnuto nebo odebráno vlastníkem služby.

ProvisioningState

Aktuální stav zřizování

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

ResourceState

Aktuální stav zdroje

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

Sku

Parametry skladové položky zadané do operace vytvoření RedisEnterprise

Name	Typ	Description
capacity	integer	Velikost clusteru RedisEnterprise. Výchozí hodnota je 2 nebo 3 v závislosti na SKU. Platné hodnoty jsou (2, 4, 6, ...) pro skladové položky Enterprise a (3, 9, 15, ...) pro skladové položky Flash.
name	SkuName	Typ clusteru RedisEnterprise, který se má nasadit. Možné hodnoty: (Enterprise_E10, EnterpriseFlash_F300 atd.)

SkuName

Typ clusteru RedisEnterprise, který se má nasadit. Možné hodnoty: (Enterprise_E10, EnterpriseFlash_F300 atd.)

Name	Typ	Description
EnterpriseFlash_F1500	string
EnterpriseFlash_F300	string
EnterpriseFlash_F700	string
Enterprise_E1	string
Enterprise_E10	string
Enterprise_E100	string
Enterprise_E20	string
Enterprise_E200	string
Enterprise_E400	string
Enterprise_E5	string
Enterprise_E50	string

TlsVersion

Minimální verze protokolu TLS pro cluster pro podporu, např. 1.2

Name	Typ	Description
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

Vlastnosti identity přiřazené uživatelem

Name	Typ	Description
clientId	string	ID klienta přiřazené identity.
principalId	string	ID objektu zabezpečení přiřazené identity.

Sdílet prostřednictvím