Share via


Redis - List By Subscription

Obtiene todas las cachés de Redis en la suscripción especificada.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Cache/redis?api-version=2023-08-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
subscriptionId
path True

string

Identificador de la suscripción de destino.

api-version
query True

string

Versión de API que se usará para la operación.

Respuestas

Nombre Tipo Description
200 OK

RedisListResult

Other Status Codes

ErrorResponse

Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

RedisCacheList

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/redis?api-version=2023-08-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1",
      "location": "West US",
      "name": "cache1",
      "type": "Microsoft.Cache/Redis",
      "tags": {},
      "properties": {
        "provisioningState": "Creating",
        "redisVersion": "3.2",
        "sku": {
          "name": "Standard",
          "family": "C",
          "capacity": 6
        },
        "enableNonSslPort": true,
        "replicasPerMaster": 2,
        "replicasPerPrimary": 2,
        "updateChannel": "Stable",
        "redisConfiguration": {},
        "hostName": "cache1.redis.cache.windows.net",
        "port": 6379,
        "sslPort": 6380,
        "instances": [
          {
            "sslPort": 15000,
            "nonSslPort": 13000,
            "isMaster": true,
            "isPrimary": true
          },
          {
            "sslPort": 15001,
            "nonSslPort": 13001,
            "isMaster": false,
            "isPrimary": false
          },
          {
            "sslPort": 15002,
            "nonSslPort": 13002,
            "isMaster": false,
            "isPrimary": false
          }
        ]
      }
    }
  ]
}

Definiciones

Nombre Description
ErrorAdditionalInfo

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

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

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

Recurso de punto de conexión privado.

PrivateEndpointConnection

Recurso de 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 de instancias de Redis.

PublicNetworkAccess

Si se permite o no el acceso al punto de conexión público para esta caché. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado". Si "Disabled", los puntos de conexión privados son el método de acceso exclusivo. El valor predeterminado es "Enabled"

RedisAccessKeys

Claves de acceso de caché de Redis.

RedisConfiguration

Toda la configuración de Redis. Pocas claves posibles: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slow-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value, etc.

RedisInstanceDetails

Detalles de una sola instancia de redis.

RedisLinkedServer

Id. del servidor vinculado

RedisListResult

Respuesta de la operación de lista de Redis.

RedisResource

Un único elemento de Redis en List or Get Operation.

Sku

Parámetros de SKU proporcionados a la operación de creación de Redis.

SkuFamily

La familia de SKU que se va a usar. Valores válidos: (C, P). (C = Básico/Estándar, P = Premium).

SkuName

Tipo de caché de Redis que se va a implementar. Valores válidos: (Básico, Estándar, Premium)

TlsVersion

Opcional: requiere que los clientes usen una versión de TLS especificada (o superior) para conectarse (por ejemplo, "1.0", "1.1", "1.2")

UpdateChannel

Opcional: especifica el canal de actualización de las actualizaciones mensuales de Redis que recibirá la instancia de Redis Cache. Las cachés que usan el canal de actualización "Versión preliminar" obtienen las actualizaciones más recientes de Redis al menos 4 semanas antes de las cachés de canal "Estable". El valor predeterminado es "Estable".

UserAssignedIdentity

Propiedades de identidad asignadas por el usuario

ErrorAdditionalInfo

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

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Los detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

ManagedServiceIdentity

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

Nombre Tipo Description
principalId

string

Identificador de la entidad de servicio de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.

tenantId

string

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 del 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

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

Nombre Tipo Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

PrivateEndpoint

Recurso de punto de conexión privado.

Nombre Tipo Description
id

string

El identificador de ARM para el punto de conexión privado

PrivateEndpointConnection

Recurso de conexión de punto de conexión privado.

Nombre Tipo Description
id

string

Identificador de recurso completo del 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 de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Estado de aprovisionamiento actual.

Nombre Tipo Description
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

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

Nombre Tipo Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

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, rechazado o quitado la conexión.

ProvisioningState

Estado de aprovisionamiento de instancias de Redis.

Nombre Tipo Description
ConfiguringAAD

string

Creating

string

Deleting

string

Disabled

string

Failed

string

Linking

string

Provisioning

string

RecoveringScaleFailure

string

Scaling

string

Succeeded

string

Unlinking

string

Unprovisioning

string

Updating

string

PublicNetworkAccess

Si se permite o no el acceso al punto de conexión público para esta caché. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado". Si "Disabled", los puntos de conexión privados son el método de acceso exclusivo. El valor predeterminado es "Enabled"

Nombre Tipo Description
Disabled

string

Enabled

string

RedisAccessKeys

Claves de acceso de caché de Redis.

Nombre Tipo Description
primaryKey

string

Clave principal actual que los clientes pueden usar para autenticarse con Redis Cache.

secondaryKey

string

Clave secundaria actual que los clientes pueden usar para autenticarse con Redis Cache.

RedisConfiguration

Toda la configuración de Redis. Pocas claves posibles: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slow-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value, etc.

Nombre Tipo Description
aad-enabled

string

Especifica si la autenticación basada en AAD se ha habilitado o deshabilitado para la memoria caché.

aof-backup-enabled

string

Especifica si la copia de seguridad de aof está habilitada.

aof-storage-connection-string-0

string

Primera cuenta de almacenamiento cadena de conexión

aof-storage-connection-string-1

string

Segunda cuenta de almacenamiento cadena de conexión

authnotrequired

string

Especifica si la autenticación está deshabilitada. No se recomienda establecer esta propiedad desde el punto de vista de seguridad.

maxclients

string

Configuración máxima de clientes

maxfragmentationmemory-reserved

string

Valor en megabytes reservados para la fragmentación por partición

maxmemory-delta

string

Valor en megabytes reservado para el uso que no es de caché por partición, por ejemplo, conmutación por error.

maxmemory-policy

string

La estrategia de expulsión que se usa cuando los datos no caben dentro de su límite de memoria.

maxmemory-reserved

string

Valor en megabytes reservado para el uso que no es de caché por partición, por ejemplo, conmutación por error.

notify-keyspace-events

string

Eventos de espacio de claves que se deben supervisar.

preferred-data-archive-auth-method

string

Método de autenticación preferido para comunicarse con la cuenta de almacenamiento usada para el archivo de datos, especificar SAS o ManagedIdentity, el valor predeterminado es SAS.

preferred-data-persistence-auth-method

string

Método de autenticación preferido para comunicarse con la cuenta de almacenamiento usada para la persistencia de datos, especificar SAS o ManagedIdentity, el valor predeterminado es SAS.

rdb-backup-enabled

string

Especifica si la copia de seguridad de rdb está habilitada.

rdb-backup-frequency

string

Especifica la frecuencia para crear la copia de seguridad de rdb en minutos. Valores válidos: (15, 30, 60, 360, 720, 1440)

rdb-backup-max-snapshot-count

string

Especifica el número máximo de instantáneas para la copia de seguridad de rdb.

rdb-storage-connection-string

string

La cuenta de almacenamiento cadena de conexión para almacenar el archivo rdb

storage-subscription-id

string

SubscriptionId de la cuenta de almacenamiento para la persistencia (aof/rdb) mediante ManagedIdentity.

zonal-configuration

string

Configuración zonal

RedisInstanceDetails

Detalles de una sola instancia de redis.

Nombre Tipo Description
isMaster

boolean

Especifica si la instancia es un nodo principal.

isPrimary

boolean

Especifica si la instancia es un nodo principal.

nonSslPort

integer

Si enableNonSslPort es true, proporciona el puerto non-SSL de la instancia de Redis.

shardId

integer

Si la agrupación en clústeres está habilitada, el identificador de partición de la instancia de Redis

sslPort

integer

Puerto SSL de instancia de Redis.

zone

string

Si la memoria caché usa zonas de disponibilidad, especifica la zona de disponibilidad donde se encuentra esta instancia.

RedisLinkedServer

Id. del servidor vinculado

Nombre Tipo Description
id

string

Id. del servidor vinculado.

RedisListResult

Respuesta de la operación de lista de Redis.

Nombre Tipo Description
nextLink

string

Vínculo para la página siguiente de resultados.

value

RedisResource[]

Lista de instancias de caché de Redis.

RedisResource

Un único elemento de Redis en List or Get Operation.

Nombre Tipo Valor predeterminado Description
enableNonSslPort

boolean

False

Especifica si el puerto de servidor redis no ssl (6379) está habilitado.

id

string

Identificador de recurso completo del 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

minimumTlsVersion

TlsVersion

Opcional: requiere que los clientes usen una versión de TLS especificada (o superior) para conectarse (por ejemplo, "1.0", "1.1", "1.2")

name

string

Nombre del recurso.

properties.accessKeys

RedisAccessKeys

Las claves de la caché de Redis: no se establecen si este objeto no es la respuesta a Create o Update redis cache

properties.hostName

string

Nombre de host de Redis.

properties.instances

RedisInstanceDetails[]

Lista de las instancias de Redis asociadas a la memoria caché

properties.linkedServers

RedisLinkedServer[]

Lista de los servidores vinculados asociados a la memoria caché

properties.port

integer

Puerto no SSL de Redis.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista de conexiones de punto de conexión privado asociadas a la caché de Redis especificada

properties.provisioningState

ProvisioningState

Estado de aprovisionamiento de instancias de Redis.

properties.sku

Sku

La SKU de la caché de Redis que se va a implementar.

properties.sslPort

integer

Puerto SSL de Redis.

properties.staticIP

string

Dirección IP estática. Opcionalmente, se puede especificar al implementar una caché de Redis dentro de una instancia de Azure Virtual Network existente; se asigna automáticamente de forma predeterminada.

properties.subnetId

string

Identificador de recurso completo de una subred en una red virtual en la que se va a implementar la caché de Redis. Formato de ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft. {Red|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1

publicNetworkAccess

PublicNetworkAccess

Enabled

Si se permite o no el acceso al punto de conexión público para esta caché. El valor es opcional, pero si se pasa, debe ser "Habilitado" o "Deshabilitado". Si "Disabled", los puntos de conexión privados son el método de acceso exclusivo. El valor predeterminado es "Enabled"

redisConfiguration

RedisConfiguration

Toda la configuración de Redis. Pocas claves posibles: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slow-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value, etc.

redisVersion

string

Versión de Redis. Debe tener el formato "major[.minor]" (solo se requiere "major") o el valor "latest" que hace referencia a la versión estable más reciente de Redis que está disponible. Versiones compatibles: 4.0, 6.0 (más reciente). El valor predeterminado es "latest".

replicasPerMaster

integer

Número de réplicas que se van a crear por principal.

replicasPerPrimary

integer

Número de réplicas que se van a crear por principal.

shardCount

integer

Número de particiones que se van a crear en una caché de clústeres Premium.

tags

object

Etiquetas del recurso.

tenantSettings

object

Diccionario de configuración de inquilinos

type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

updateChannel

UpdateChannel

Opcional: especifica el canal de actualización de las actualizaciones mensuales de Redis que recibirá la instancia de Redis Cache. Las cachés que usan el canal de actualización "Versión preliminar" obtienen las actualizaciones más recientes de Redis al menos 4 semanas antes de las cachés de canal "Estable". El valor predeterminado es "Estable".

zones

string[]

Una lista de zonas de disponibilidad que indica dónde debe proceder el recurso.

Sku

Parámetros de SKU proporcionados a la operación de creación de Redis.

Nombre Tipo Description
capacity

integer

Tamaño de la caché de Redis que se va a implementar. Valores válidos: para la familia C (Básico/Estándar) (0, 1, 2, 3, 4, 5, 6), para la familia P (Premium) (1, 2, 3, 4).

family

SkuFamily

La familia de SKU que se va a usar. Valores válidos: (C, P). (C = Básico/Estándar, P = Premium).

name

SkuName

Tipo de caché de Redis que se va a implementar. Valores válidos: (Básico, Estándar, Premium)

SkuFamily

La familia de SKU que se va a usar. Valores válidos: (C, P). (C = Básico/Estándar, P = Premium).

Nombre Tipo Description
C

string

P

string

SkuName

Tipo de caché de Redis que se va a implementar. Valores válidos: (Básico, Estándar, Premium)

Nombre Tipo Description
Basic

string

Premium

string

Standard

string

TlsVersion

Opcional: requiere que los clientes usen una versión de TLS especificada (o superior) para conectarse (por ejemplo, "1.0", "1.1", "1.2")

Nombre Tipo Description
1.0

string

1.1

string

1.2

string

UpdateChannel

Opcional: especifica el canal de actualización de las actualizaciones mensuales de Redis que recibirá la instancia de Redis Cache. Las cachés que usan el canal de actualización "Versión preliminar" obtienen las actualizaciones más recientes de Redis al menos 4 semanas antes de las cachés de canal "Estable". El valor predeterminado es "Estable".

Nombre Tipo Description
Preview

string

Stable

string

UserAssignedIdentity

Propiedades de identidad asignadas por el usuario

Nombre Tipo Description
clientId

string

Identificador de cliente de la identidad asignada.

principalId

string

Identificador de entidad de seguridad de la identidad asignada.