Redis interface

Paquete:

@azure/arm-rediscache

Interfaz que representa una redis.

Métodos

beginCreate(string, string, RedisCreateParameters, RedisCreateOptionalParams)	Cree o reemplace (sobrescribir o volver a crear, con un posible tiempo de inactividad) una caché de Redis existente.
beginCreateAndWait(string, string, RedisCreateParameters, RedisCreateOptionalParams)	Cree o reemplace (sobrescribir o volver a crear, con un posible tiempo de inactividad) una caché de Redis existente.
beginDelete(string, string, RedisDeleteOptionalParams)	Elimina una caché de Redis.
beginDeleteAndWait(string, string, RedisDeleteOptionalParams)	Elimina una caché de Redis.
beginExportData(string, string, ExportRDBParameters, RedisExportDataOptionalParams)	Exporte datos de la caché de redis a blobs de un contenedor.
beginExportDataAndWait(string, string, ExportRDBParameters, RedisExportDataOptionalParams)	Exporte datos de la caché de redis a blobs de un contenedor.
beginFlushCache(string, string, RedisFlushCacheOptionalParams)	Elimina todas las claves de una memoria caché.
beginFlushCacheAndWait(string, string, RedisFlushCacheOptionalParams)	Elimina todas las claves de una memoria caché.
beginImportData(string, string, ImportRDBParameters, RedisImportDataOptionalParams)	Importe datos en la caché de Redis.
beginImportDataAndWait(string, string, ImportRDBParameters, RedisImportDataOptionalParams)	Importe datos en la caché de Redis.
beginUpdate(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)	Actualice una caché de Redis existente.
beginUpdateAndWait(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)	Actualice una caché de Redis existente.
checkNameAvailability(CheckNameAvailabilityParameters, RedisCheckNameAvailabilityOptionalParams)	Comprueba que el nombre de la caché de Redis es válido y que aún no está en uso.
forceReboot(string, string, RedisRebootParameters, RedisForceRebootOptionalParams)	Reinicie los nodos de Redis especificados. Esta operación requiere permiso de escritura para el recurso de caché. Puede haber una posible pérdida de datos.
get(string, string, RedisGetOptionalParams)	Obtiene una caché de Redis (descripción del recurso).
listByResourceGroup(string, RedisListByResourceGroupOptionalParams)	Enumera todas las cachés de Redis en un grupo de recursos.
listBySubscription(RedisListBySubscriptionOptionalParams)	Obtiene todas las cachés de Redis de la suscripción especificada.
listKeys(string, string, RedisListKeysOptionalParams)	Recupere las claves de acceso de una caché de Redis. Esta operación requiere permiso de escritura para el recurso de caché.
listUpgradeNotifications(string, string, number, RedisListUpgradeNotificationsOptionalParams)	Obtiene las notificaciones de actualización de una caché de Redis.
regenerateKey(string, string, RedisRegenerateKeyParameters, RedisRegenerateKeyOptionalParams)	Vuelva a generar las claves de acceso de Redis Cache. Esta operación requiere permiso de escritura para el recurso de caché.

Detalles del método

beginCreate(string, string, RedisCreateParameters, RedisCreateOptionalParams)

Cree o reemplace (sobrescribir o volver a crear, con un posible tiempo de inactividad) una caché de Redis existente.

function beginCreate(resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams): Promise<SimplePollerLike<OperationState<RedisResource>, RedisResource>>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

parameters

RedisCreateParameters

Parámetros proporcionados a la operación Crear Redis.

options

RedisCreateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisResource>, RedisResource>>

beginCreateAndWait(string, string, RedisCreateParameters, RedisCreateOptionalParams)

Cree o reemplace (sobrescribir o volver a crear, con un posible tiempo de inactividad) una caché de Redis existente.

function beginCreateAndWait(resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams): Promise<RedisResource>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

parameters

RedisCreateParameters

Parámetros proporcionados a la operación Crear Redis.

options

RedisCreateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<RedisResource>

beginDelete(string, string, RedisDeleteOptionalParams)

Elimina una caché de Redis.

function beginDelete(resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

options

RedisDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, RedisDeleteOptionalParams)

Elimina una caché de Redis.

function beginDeleteAndWait(resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams): Promise<void>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

options

RedisDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

beginExportData(string, string, ExportRDBParameters, RedisExportDataOptionalParams)

Exporte datos de la caché de redis a blobs de un contenedor.

function beginExportData(resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

parameters

ExportRDBParameters

Parámetros para la operación de exportación de Redis.

options

RedisExportDataOptionalParams

Parámetros de opciones.

Devoluciones

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginExportDataAndWait(string, string, ExportRDBParameters, RedisExportDataOptionalParams)

Exporte datos de la caché de redis a blobs de un contenedor.

function beginExportDataAndWait(resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams): Promise<void>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

parameters

ExportRDBParameters

Parámetros para la operación de exportación de Redis.

options

RedisExportDataOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

beginFlushCache(string, string, RedisFlushCacheOptionalParams)

Elimina todas las claves de una memoria caché.

function beginFlushCache(resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams): Promise<SimplePollerLike<OperationState<RedisFlushCacheResponse>, RedisFlushCacheResponse>>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

cacheName

string

Nombre de la caché de Redis.

options

RedisFlushCacheOptionalParams

Parámetros de opciones.

Devoluciones

Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisFlushCacheResponse>, RedisFlushCacheResponse>>

beginFlushCacheAndWait(string, string, RedisFlushCacheOptionalParams)

Elimina todas las claves de una memoria caché.

function beginFlushCacheAndWait(resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams): Promise<RedisFlushCacheResponse>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

cacheName

string

Nombre de la caché de Redis.

options

RedisFlushCacheOptionalParams

Parámetros de opciones.

Devoluciones

Promise<RedisFlushCacheResponse>

beginImportData(string, string, ImportRDBParameters, RedisImportDataOptionalParams)

Importe datos en la caché de Redis.

function beginImportData(resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

parameters

ImportRDBParameters

Parámetros para la operación de importación de Redis.

options

RedisImportDataOptionalParams

Parámetros de opciones.

Devoluciones

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginImportDataAndWait(string, string, ImportRDBParameters, RedisImportDataOptionalParams)

Importe datos en la caché de Redis.

function beginImportDataAndWait(resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams): Promise<void>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

parameters

ImportRDBParameters

Parámetros para la operación de importación de Redis.

options

RedisImportDataOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

beginUpdate(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)

Actualice una caché de Redis existente.

function beginUpdate(resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams): Promise<SimplePollerLike<OperationState<RedisResource>, RedisResource>>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

parameters

RedisUpdateParameters

Parámetros proporcionados a la operación Actualizar Redis.

options

RedisUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisResource>, RedisResource>>

beginUpdateAndWait(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)

Actualice una caché de Redis existente.

function beginUpdateAndWait(resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams): Promise<RedisResource>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

parameters

RedisUpdateParameters

Parámetros proporcionados a la operación Actualizar Redis.

options

RedisUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<RedisResource>

checkNameAvailability(CheckNameAvailabilityParameters, RedisCheckNameAvailabilityOptionalParams)

Comprueba que el nombre de la caché de Redis es válido y que aún no está en uso.

function checkNameAvailability(parameters: CheckNameAvailabilityParameters, options?: RedisCheckNameAvailabilityOptionalParams): Promise<void>

Parámetros

parameters

CheckNameAvailabilityParameters

Parámetros proporcionados a la operación CheckNameAvailability Redis. El único tipo de recurso admitido es "Microsoft.Cache/redis".

options

RedisCheckNameAvailabilityOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

forceReboot(string, string, RedisRebootParameters, RedisForceRebootOptionalParams)

Reinicie los nodos de Redis especificados. Esta operación requiere permiso de escritura para el recurso de caché. Puede haber una posible pérdida de datos.

function forceReboot(resourceGroupName: string, name: string, parameters: RedisRebootParameters, options?: RedisForceRebootOptionalParams): Promise<RedisForceRebootResponse>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

parameters

RedisRebootParameters

Especifica los nodos de Redis que se reiniciarán.

options

RedisForceRebootOptionalParams

Parámetros de opciones.

Devoluciones

Promise<RedisForceRebootResponse>

get(string, string, RedisGetOptionalParams)

Obtiene una caché de Redis (descripción del recurso).

function get(resourceGroupName: string, name: string, options?: RedisGetOptionalParams): Promise<RedisResource>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

options

RedisGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<RedisResource>

listByResourceGroup(string, RedisListByResourceGroupOptionalParams)

Enumera todas las cachés de Redis en un grupo de recursos.

function listByResourceGroup(resourceGroupName: string, options?: RedisListByResourceGroupOptionalParams): PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

options

RedisListByResourceGroupOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>

listBySubscription(RedisListBySubscriptionOptionalParams)

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

function listBySubscription(options?: RedisListBySubscriptionOptionalParams): PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>

Parámetros

options

RedisListBySubscriptionOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>

listKeys(string, string, RedisListKeysOptionalParams)

Recupere las claves de acceso de una caché de Redis. Esta operación requiere permiso de escritura para el recurso de caché.

function listKeys(resourceGroupName: string, name: string, options?: RedisListKeysOptionalParams): Promise<RedisAccessKeys>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

options

RedisListKeysOptionalParams

Parámetros de opciones.

Devoluciones

Promise<RedisAccessKeys>

listUpgradeNotifications(string, string, number, RedisListUpgradeNotificationsOptionalParams)

Obtiene las notificaciones de actualización de una caché de Redis.

function listUpgradeNotifications(resourceGroupName: string, name: string, history: number, options?: RedisListUpgradeNotificationsOptionalParams): PagedAsyncIterableIterator<UpgradeNotification, UpgradeNotification[], PageSettings>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

history

number

número de minutos pasados para buscar notificaciones de actualización

options

RedisListUpgradeNotificationsOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<UpgradeNotification, UpgradeNotification[], PageSettings>

regenerateKey(string, string, RedisRegenerateKeyParameters, RedisRegenerateKeyOptionalParams)

Vuelva a generar las claves de acceso de Redis Cache. Esta operación requiere permiso de escritura para el recurso de caché.

function regenerateKey(resourceGroupName: string, name: string, parameters: RedisRegenerateKeyParameters, options?: RedisRegenerateKeyOptionalParams): Promise<RedisAccessKeys>

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

name

string

Nombre de la caché de Redis.

parameters

RedisRegenerateKeyParameters

Especifica la clave que desea volver a generar.

options

RedisRegenerateKeyOptionalParams

Parámetros de opciones.

Devoluciones

Promise<RedisAccessKeys>