Redis Enterprise - Get

Référence

Service:: Redis Cache

Version d'API:: 2024-10-01

Obtient des informations sur un cluster RedisEnterprise

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
clusterName	path	True	string	Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs Modèle d’expression régulière: `^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	Cluster	La requête a réussi, le corps de la réponse contient les détails demandés.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

RedisEnterpriseGet

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
          }
        }
      }
    ]
  }
}

Définitions

Nom	Description
Cluster	Décrit le cluster RedisEnterprise
CmkIdentityType	Seul userAssignedIdentity est pris en charge dans cette version de l’API ; d’autres types peuvent être pris en charge à l’avenir
CustomerManagedKeyEncryption	Toutes les propriétés de chiffrement de clé gérées par le client pour la ressource. Définissez-le sur un objet vide pour utiliser le chiffrement de clé managée par Microsoft.
Encryption	Configuration de chiffrement au repos pour le cluster.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
KeyEncryptionKeyIdentity	Toutes les configurations d’identité pour les paramètres de clé gérés par le client qui définissent l’identité à utiliser pour l’authentification auprès de Key Vault.
ManagedServiceIdentity	Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)
ManagedServiceIdentityType	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
PrivateEndpoint	Ressource de point de terminaison privé.
PrivateEndpointConnection	Ressource de connexion de point de terminaison privé.
PrivateEndpointConnectionProvisioningState	État d’approvisionnement actuel.
PrivateEndpointServiceConnectionStatus	État de la connexion de point de terminaison privé.
PrivateLinkServiceConnectionState	Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.
ProvisioningState	État actuel de l’approvisionnement
ResourceState	État actuel de la ressource
Sku	Paramètres de référence SKU fournis à l’opération de création de RedisEnterprise.
SkuName	Type de cluster RedisEnterprise à déployer. Valeurs possibles : (Enterprise_E10, EnterpriseFlash_F300 etc.)
TlsVersion	Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ».
UserAssignedIdentity	Propriétés d’identité attribuées par l’utilisateur

Cluster

Décrit le cluster RedisEnterprise

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identité de la ressource.
location	string	Emplacement géographique où réside la ressource
name	string	Nom de la ressource
properties.encryption	Encryption	Configuration de chiffrement au repos pour le cluster.
properties.hostName	string	Nom DNS du point de terminaison du cluster
properties.minimumTlsVersion	TlsVersion	Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ».
properties.privateEndpointConnections	PrivateEndpointConnection[]	Liste des connexions de point de terminaison privé associées au cluster RedisEnterprise spécifié
properties.provisioningState	ProvisioningState	État d’approvisionnement actuel du cluster
properties.redisVersion	string	La version de redis du cluster prend en charge, par exemple « 6 ».
properties.resourceState	ResourceState	État actuel des ressources du cluster
sku	Sku	Référence SKU à créer, qui affecte les prix, les performances et les fonctionnalités.
tags	object	Balises de ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »
zones	string[]	Zones de disponibilité où ce cluster sera déployé.

CmkIdentityType

Seul userAssignedIdentity est pris en charge dans cette version de l’API ; d’autres types peuvent être pris en charge à l’avenir

Nom	Type	Description
systemAssignedIdentity	string
userAssignedIdentity	string

CustomerManagedKeyEncryption

Toutes les propriétés de chiffrement de clé gérées par le client pour la ressource. Définissez-le sur un objet vide pour utiliser le chiffrement de clé managée par Microsoft.

Nom	Type	Description
keyEncryptionKeyIdentity	KeyEncryptionKeyIdentity	Toutes les configurations d’identité pour les paramètres de clé gérés par le client qui définissent l’identité à utiliser pour l’authentification auprès de Key Vault.
keyEncryptionKeyUrl	string	URL de clé de chiffrement de clé, versionnée uniquement. Ex : https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Encryption

Configuration de chiffrement au repos pour le cluster.

Nom	Type	Description
customerManagedKeyEncryption	CustomerManagedKeyEncryption	Toutes les propriétés de chiffrement de clé gérées par le client pour la ressource. Définissez-le sur un objet vide pour utiliser le chiffrement de clé managée par Microsoft.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

KeyEncryptionKeyIdentity

Toutes les configurations d’identité pour les paramètres de clé gérés par le client qui définissent l’identité à utiliser pour l’authentification auprès de Key Vault.

Nom	Type	Description
identityType	CmkIdentityType	Seul userAssignedIdentity est pris en charge dans cette version de l’API ; d’autres types peuvent être pris en charge à l’avenir
userAssignedIdentityResourceId	string	Identité affectée par l’utilisateur à utiliser pour accéder à l’URL de clé de chiffrement de clé. Ex : /subscriptions/_{/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.}

ManagedServiceIdentity

Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)

Nom	Type	Description
principalId	string	ID du principal de service de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
tenantId	string	ID de locataire de l’identité affectée par le système. Cette propriété est fournie uniquement pour une identité affectée par le système.
type	ManagedServiceIdentityType	Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).
userAssignedIdentities	<string, UserAssignedIdentity>	identités User-Assigned Ensemble d’identités affectées par l’utilisateur associées à la ressource. Les clés de dictionnaire userAssignedIdentities seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Les valeurs de dictionnaire peuvent être des objets vides ({}) dans les requêtes.

ManagedServiceIdentityType

Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés).

Nom	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

Ressource de point de terminaison privé.

Nom	Type	Description
id	string	Identificateur ARM pour le point de terminaison privé

PrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties.privateEndpoint	PrivateEndpoint	Ressource du point de terminaison privé.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	État d’approvisionnement de la ressource de connexion de point de terminaison privé.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.

Nom	Type	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

État de la connexion de point de terminaison privé.

Nom	Type	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

Nom	Type	Description
actionsRequired	string	Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.
description	string	Raison de l’approbation/rejet de la connexion.
status	PrivateEndpointServiceConnectionStatus	Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service.

ProvisioningState

État actuel de l’approvisionnement

Nom	Type	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ResourceState

État actuel de la ressource

Nom	Type	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

Paramètres de référence SKU fournis à l’opération de création de RedisEnterprise.

Nom	Type	Description
capacity	integer	Taille du cluster RedisEnterprise. La valeur par défaut est 2 ou 3 en fonction de la référence SKU. Les valeurs valides sont (2, 4, 6, ...) pour les références SKU Entreprise et (3, 9, 15, ...) pour les références SKU Flash.
name	SkuName	Type de cluster RedisEnterprise à déployer. Valeurs possibles : (Enterprise_E10, EnterpriseFlash_F300 etc.)

SkuName

Type de cluster RedisEnterprise à déployer. Valeurs possibles : (Enterprise_E10, EnterpriseFlash_F300 etc.)

Nom	Type	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

Version TLS minimale pour le cluster à prendre en charge, par exemple « 1.2 ».

Nom	Type	Description
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

Propriétés d’identité attribuées par l’utilisateur

Nom	Type	Description
clientId	string	ID client de l’identité affectée.
principalId	string	ID principal de l’identité affectée.

Partager via