Redis Enterprise - Get

Referenz

Dienst:: Redis Cache

API-Version:: 2024-10-01

Ruft Informationen zu einem RedisEnterprise-Cluster ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
clusterName	path	True	string	Der Name des Redis Enterprise-Clusters. Der Name muss 1 bis 60 Zeichen lang sein. Zulässige Zeichen (A-Z, a-z, 0-9) und Bindestrich(-). Es kann weder führende noch nachfolgende Bindestriche oder aufeinander folgende Bindestriche geben. RegEx-Muster: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Die ID des Zielabonnements.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	Cluster	Der Anforderungstext ist erfolgreich, der Antworttext enthält die angeforderten Details.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

RedisEnterpriseGet

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
          }
        }
      }
    ]
  }
}

Definitionen

Name	Beschreibung
Cluster	Beschreibt den RedisEnterprise-Cluster
CmkIdentityType	In dieser API-Version wird nur userAssignedIdentity unterstützt. Andere Typen können in Zukunft unterstützt werden.
CustomerManagedKeyEncryption	Alle vom Kunden verwalteten Schlüsselverschlüsselungseigenschaften für die Ressource. Legen Sie dies auf ein leeres Objekt fest, um die Von Microsoft verwaltete Schlüsselverschlüsselung zu verwenden.
Encryption	Verschlüsselungs-at-Rest-Konfiguration für den Cluster.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
KeyEncryptionKeyIdentity	Alle Identitätskonfigurationen für vom Kunden verwaltete Schlüsseleinstellungen, die definieren, welche Identität für die Authentifizierung bei Key Vault verwendet werden soll.
ManagedServiceIdentity	Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).
PrivateEndpoint	Die Private Endpoint-Ressource.
PrivateEndpointConnection	Die Private Endpoint Connection-Ressource.
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
PrivateEndpointServiceConnectionStatus	Der Status der privaten Endpunktverbindung.
PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
ProvisioningState	Aktueller Bereitstellungsstatus
ResourceState	Aktueller Ressourcenstatus
Sku	SKU-Parameter, die für den Create RedisEnterprise-Vorgang bereitgestellt werden.
SkuName	Der Typ des bereitzustellenden RedisEnterprise-Clusters. Mögliche Werte: (Enterprise_E10, EnterpriseFlash_F300 usw.)
TlsVersion	Die mindeste TLS-Version für den Cluster, die unterstützt werden soll, z. B. "1.2"
UserAssignedIdentity	Benutzer zugewiesene Identitätseigenschaften

Cluster

Beschreibt den RedisEnterprise-Cluster

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Die Identität der Ressource.
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.encryption	Encryption	Verschlüsselungs-at-Rest-Konfiguration für den Cluster.
properties.hostName	string	DNS-Name des Clusterendpunkts
properties.minimumTlsVersion	TlsVersion	Die mindeste TLS-Version für den Cluster, die unterstützt werden soll, z. B. "1.2"
properties.privateEndpointConnections	PrivateEndpointConnection[]	Liste der privaten Endpunktverbindungen, die dem angegebenen RedisEnterprise-Cluster zugeordnet sind
properties.provisioningState	ProvisioningState	Aktueller Bereitstellungsstatus des Clusters
properties.redisVersion	string	Version von Redis, die der Cluster unterstützt, z. B. "6"
properties.resourceState	ResourceState	Aktueller Ressourcenstatus des Clusters
sku	Sku	Die zu erstellende SKU, die sich auf Preis, Leistung und Features auswirkt.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"
zones	string[]	Die Verfügbarkeitszonen, in denen dieser Cluster bereitgestellt wird.

CmkIdentityType

In dieser API-Version wird nur userAssignedIdentity unterstützt. Andere Typen können in Zukunft unterstützt werden.

Name	Typ	Beschreibung
systemAssignedIdentity	string
userAssignedIdentity	string

CustomerManagedKeyEncryption

Alle vom Kunden verwalteten Schlüsselverschlüsselungseigenschaften für die Ressource. Legen Sie dies auf ein leeres Objekt fest, um die Von Microsoft verwaltete Schlüsselverschlüsselung zu verwenden.

Name	Typ	Beschreibung
keyEncryptionKeyIdentity	KeyEncryptionKeyIdentity	Alle Identitätskonfigurationen für vom Kunden verwaltete Schlüsseleinstellungen, die definieren, welche Identität für die Authentifizierung bei Key Vault verwendet werden soll.
keyEncryptionKeyUrl	string	Schlüsselverschlüsselungsschlüssel-URL, nur versioniert. Beispiel: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Encryption

Verschlüsselungs-at-Rest-Konfiguration für den Cluster.

Name	Typ	Beschreibung
customerManagedKeyEncryption	CustomerManagedKeyEncryption	Alle vom Kunden verwalteten Schlüsselverschlüsselungseigenschaften für die Ressource. Legen Sie dies auf ein leeres Objekt fest, um die Von Microsoft verwaltete Schlüsselverschlüsselung zu verwenden.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

KeyEncryptionKeyIdentity

Alle Identitätskonfigurationen für vom Kunden verwaltete Schlüsseleinstellungen, die definieren, welche Identität für die Authentifizierung bei Key Vault verwendet werden soll.

Name	Typ	Beschreibung
identityType	CmkIdentityType	In dieser API-Version wird nur userAssignedIdentity unterstützt. Andere Typen können in Zukunft unterstützt werden.
userAssignedIdentityResourceId	string	Vom Benutzer zugewiesene Identität, die für den Zugriff auf die URL des Schlüsselverschlüsselungsschlüssels verwendet werden soll. Beispiel: /subscriptions/_{/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.}

ManagedServiceIdentity

Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)

Name	Typ	Beschreibung
principalId	string	Die Dienstprinzipal-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
tenantId	string	Die Mandanten-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
type	ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identitäten Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein.

ManagedServiceIdentityType

Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).

Name	Typ	Beschreibung
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

Die Private Endpoint-Ressource.

Name	Typ	Beschreibung
id	string	Der ARM-Bezeichner für private Endpunkte

PrivateEndpointConnection

Die Private Endpoint Connection-Ressource.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.privateEndpoint	PrivateEndpoint	Die Ressource des privaten Endpunkts.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Der Bereitstellungsstatus der privaten Endpunktverbindungsressource.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

Name	Typ	Beschreibung
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

Der Status der privaten Endpunktverbindung.

Name	Typ	Beschreibung
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.

Name	Typ	Beschreibung
actionsRequired	string	Eine Meldung, die angibt, ob Änderungen am Dienstanbieter Updates für den Verbraucher erfordern.
description	string	Der Grund für die Genehmigung/Ablehnung der Verbindung.
status	PrivateEndpointServiceConnectionStatus	Gibt an, ob die Verbindung vom Besitzer des Diensts genehmigt/abgelehnt/entfernt wurde.

ProvisioningState

Aktueller Bereitstellungsstatus

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

ResourceState

Aktueller Ressourcenstatus

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

SKU-Parameter, die für den Create RedisEnterprise-Vorgang bereitgestellt werden.

Name	Typ	Beschreibung
capacity	integer	Die Größe des RedisEnterprise-Clusters. Standardmäßig ist je nach SKU 2 oder 3 festgelegt. Gültige Werte sind (2, 4, 6, ...) für Enterprise-SKUs und (3, 9, 15, ...) für Flash-SKUs.
name	SkuName	Der Typ des bereitzustellenden RedisEnterprise-Clusters. Mögliche Werte: (Enterprise_E10, EnterpriseFlash_F300 usw.)

SkuName

Der Typ des bereitzustellenden RedisEnterprise-Clusters. Mögliche Werte: (Enterprise_E10, EnterpriseFlash_F300 usw.)

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

Die mindeste TLS-Version für den Cluster, die unterstützt werden soll, z. B. "1.2"

Name	Typ	Beschreibung
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

Benutzer zugewiesene Identitätseigenschaften

Name	Typ	Beschreibung
clientId	string	Die Client-ID der zugewiesenen Identität.
principalId	string	Die Prinzipal-ID der zugewiesenen Identität.

Freigeben über