Redis Enterprise - Get

Referencia

Servicio:: Redis Cache

Versión de la API:: 2024-10-01

Obtiene información sobre un clúster de RedisEnterprise.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
clusterName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	Nombre del clúster de Redis Enterprise. El nombre debe tener entre 1 y 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) y guion(-). No puede haber guiones iniciales ni finales ni consecutivos
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	Cluster	La solicitud se realizó correctamente, el cuerpo de la respuesta contiene los detalles solicitados.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

RedisEnterpriseGet

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

Definiciones

Nombre	Description
Cluster	Describe el clúster de RedisEnterprise.
CmkIdentityType	Solo se admite userAssignedIdentity en esta versión de API; Es posible que se admita otros tipos en el futuro.
CustomerManagedKeyEncryption	Todas las propiedades de cifrado de claves administradas por el cliente para el recurso. Establézcalo en un objeto vacío para usar el cifrado de claves administradas por Microsoft.
Encryption	Configuración de cifrado en reposo para el clúster.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
KeyEncryptionKeyIdentity	Toda la configuración de identidad para la configuración de clave administrada por el cliente que define qué identidad se debe usar para autenticarse en Key Vault.
ManagedServiceIdentity	Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)
ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
PrivateEndpoint	El recurso Punto de conexión privado.
PrivateEndpointConnection	El recurso Conexión de punto de conexión privado.
PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento actual.
PrivateEndpointServiceConnectionStatus	Estado de conexión del punto de conexión privado.
PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
ProvisioningState	Estado de aprovisionamiento actual
ResourceState	Estado actual de los recursos
Sku	Parámetros de SKU proporcionados para la operación create RedisEnterprise.
SkuName	Tipo de clúster de RedisEnterprise que se va a implementar. Valores posibles: (Enterprise_E10, EnterpriseFlash_F300 etc.)
TlsVersion	Versión mínima de TLS para que el clúster admita, por ejemplo, "1.2".
UserAssignedIdentity	Propiedades de identidad asignadas por el usuario

Cluster

Object

Describe el clúster de RedisEnterprise.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	Identidad del recurso.
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.encryption	Encryption	Configuración de cifrado en reposo para el clúster.
properties.hostName	string	Nombre DNS del punto de conexión del clúster
properties.minimumTlsVersion	TlsVersion	Versión mínima de TLS para que el clúster admita, por ejemplo, "1.2".
properties.privateEndpointConnections	PrivateEndpointConnection[]	Lista de conexiones de punto de conexión privado asociadas al clúster de RedisEnterprise especificado
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento actual del clúster
properties.redisVersion	string	Versión de redis que admite el clúster, por ejemplo, "6".
properties.resourceState	ResourceState	Estado actual del recurso del clúster
sku	Sku	SKU que se va a crear, lo que afecta al precio, el rendimiento y las características.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"
zones	string[]	Availability Zones donde se implementará este clúster.

CmkIdentityType

Enumeración

Solo se admite userAssignedIdentity en esta versión de API; Es posible que se admita otros tipos en el futuro.

Valor	Description
systemAssignedIdentity
userAssignedIdentity

CustomerManagedKeyEncryption

Object

Todas las propiedades de cifrado de claves administradas por el cliente para el recurso. Establézcalo en un objeto vacío para usar el cifrado de claves administradas por Microsoft.

Nombre	Tipo	Description
keyEncryptionKeyIdentity	KeyEncryptionKeyIdentity	Toda la configuración de identidad para la configuración de clave administrada por el cliente que define qué identidad se debe usar para autenticarse en Key Vault.
keyEncryptionKeyUrl	string	Dirección URL de clave de cifrado de claves, solo con versiones. Por ejemplo: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

Encryption

Object

Configuración de cifrado en reposo para el clúster.

Nombre	Tipo	Description
customerManagedKeyEncryption	CustomerManagedKeyEncryption	Todas las propiedades de cifrado de claves administradas por el cliente para el recurso. Establézcalo en un objeto vacío para usar el cifrado de claves administradas por Microsoft.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

KeyEncryptionKeyIdentity

Object

Toda la configuración de identidad para la configuración de clave administrada por el cliente que define qué identidad se debe usar para autenticarse en Key Vault.

Nombre	Tipo	Description
identityType	CmkIdentityType	Solo se admite userAssignedIdentity en esta versión de API; Es posible que se admita otros tipos en el futuro.
userAssignedIdentityResourceId	string	Identidad asignada por el usuario que se usará para acceder a la dirección URL de la clave de cifrado de claves. Por ejemplo: /subscriptions/_{/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.}

ManagedServiceIdentity

Object

Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)

Nombre	Tipo	Description
principalId	string (uuid)	Identificador de entidad de servicio de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId	string (uuid)	Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type	ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	identidades de User-Assigned Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes.

ManagedServiceIdentityType

Enumeración

Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).

Valor	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

PrivateEndpoint

Object

El recurso Punto de conexión privado.

Nombre	Tipo	Description
id	string	Identificador de ARM para punto de conexión privado

PrivateEndpointConnection

Object

El recurso Conexión de punto de conexión privado.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.privateEndpoint	PrivateEndpoint	Recurso del punto de conexión privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Estado de aprovisionamiento del recurso de conexión de punto de conexión privado.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Enumeración

Estado de aprovisionamiento actual.

Valor	Description
Creating
Deleting
Failed
Succeeded

PrivateEndpointServiceConnectionStatus

Enumeración

Estado de conexión del punto de conexión privado.

Valor	Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor.

Nombre	Tipo	Description
actionsRequired	string	Mensaje que indica si los cambios en el proveedor de servicios requieren actualizaciones en el consumidor.
description	string	Motivo de aprobación o rechazo de la conexión.
status	PrivateEndpointServiceConnectionStatus	Indica si el propietario del servicio ha aprobado o rechazado o eliminado la conexión.

ProvisioningState

Enumeración

Estado de aprovisionamiento actual

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ResourceState

Enumeración

Estado actual de los recursos

Valor	Description
CreateFailed
Creating
DeleteFailed
Deleting
DisableFailed
Disabled
Disabling
EnableFailed
Enabling
Running
Scaling
ScalingFailed
UpdateFailed
Updating

Sku

Object

Parámetros de SKU proporcionados para la operación create RedisEnterprise.

Nombre	Tipo	Description
capacity	integer (int32)	Tamaño del clúster de RedisEnterprise. El valor predeterminado es 2 o 3 en función de la SKU. Los valores válidos son (2, 4, 6, ...) para las SKU empresariales y (3, 9, 15, ...) para las SKU flash.
name	SkuName	Tipo de clúster de RedisEnterprise que se va a implementar. Valores posibles: (Enterprise_E10, EnterpriseFlash_F300 etc.)

SkuName

Enumeración

Tipo de clúster de RedisEnterprise que se va a implementar. Valores posibles: (Enterprise_E10, EnterpriseFlash_F300 etc.)

Valor	Description
EnterpriseFlash_F1500
EnterpriseFlash_F300
EnterpriseFlash_F700
Enterprise_E1
Enterprise_E10
Enterprise_E100
Enterprise_E20
Enterprise_E200
Enterprise_E400
Enterprise_E5
Enterprise_E50

TlsVersion

Enumeración

Versión mínima de TLS para que el clúster admita, por ejemplo, "1.2".

Valor	Description
1.0
1.1
1.2

UserAssignedIdentity

Object

Propiedades de identidad asignadas por el usuario

Nombre	Tipo	Description
clientId	string (uuid)	Identificador de cliente de la identidad asignada.
principalId	string (uuid)	Identificador de entidad de seguridad de la identidad asignada.

Compartir a través de

Redis Enterprise - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

RedisEnterpriseGet

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Cluster

CmkIdentityType

CustomerManagedKeyEncryption

Encryption

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyEncryptionKeyIdentity

ManagedServiceIdentity

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

PrivateLinkServiceConnectionState

ProvisioningState

ResourceState

Sku

SkuName

TlsVersion

UserAssignedIdentity

Recursos adicionales