Redis interface
Interface que representa um Redis.
Métodos
Detalhes de Método
beginCreate(string, string, RedisCreateParameters, RedisCreateOptionalParams)
Criar ou substituir (substituir/recriar, com potencial tempo de inatividade) uma cache de Redis existente.
function beginCreate(resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams): Promise<SimplePollerLike<OperationState<RedisResource>, RedisResource>>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- parameters
- RedisCreateParameters
Parâmetros fornecidos para a operação Criar Redis.
- options
- RedisCreateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisResource>, RedisResource>>
beginCreateAndWait(string, string, RedisCreateParameters, RedisCreateOptionalParams)
Criar ou substituir (substituir/recriar, com potencial tempo de inatividade) uma cache de Redis existente.
function beginCreateAndWait(resourceGroupName: string, name: string, parameters: RedisCreateParameters, options?: RedisCreateOptionalParams): Promise<RedisResource>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- parameters
- RedisCreateParameters
Parâmetros fornecidos para a operação Criar Redis.
- options
- RedisCreateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<RedisResource>
beginDelete(string, string, RedisDeleteOptionalParams)
Elimina uma cache de Redis.
function beginDelete(resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- options
- RedisDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, RedisDeleteOptionalParams)
Elimina uma cache de Redis.
function beginDeleteAndWait(resourceGroupName: string, name: string, options?: RedisDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- options
- RedisDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
beginExportData(string, string, ExportRDBParameters, RedisExportDataOptionalParams)
Exportar dados da cache de redis para blobs num contentor.
function beginExportData(resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- parameters
- ExportRDBParameters
Parâmetros para a operação de exportação de Redis.
- options
- RedisExportDataOptionalParams
Os parâmetros de opções.
Devoluções
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginExportDataAndWait(string, string, ExportRDBParameters, RedisExportDataOptionalParams)
Exportar dados da cache de redis para blobs num contentor.
function beginExportDataAndWait(resourceGroupName: string, name: string, parameters: ExportRDBParameters, options?: RedisExportDataOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- parameters
- ExportRDBParameters
Parâmetros para a operação de exportação de Redis.
- options
- RedisExportDataOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
beginFlushCache(string, string, RedisFlushCacheOptionalParams)
Elimina todas as chaves numa cache.
function beginFlushCache(resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams): Promise<SimplePollerLike<OperationState<RedisFlushCacheResponse>, RedisFlushCacheResponse>>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- cacheName
-
string
O nome da cache de Redis.
- options
- RedisFlushCacheOptionalParams
Os parâmetros de opções.
Devoluções
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisFlushCacheResponse>, RedisFlushCacheResponse>>
beginFlushCacheAndWait(string, string, RedisFlushCacheOptionalParams)
Elimina todas as chaves numa cache.
function beginFlushCacheAndWait(resourceGroupName: string, cacheName: string, options?: RedisFlushCacheOptionalParams): Promise<RedisFlushCacheResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- cacheName
-
string
O nome da cache de Redis.
- options
- RedisFlushCacheOptionalParams
Os parâmetros de opções.
Devoluções
Promise<RedisFlushCacheResponse>
beginImportData(string, string, ImportRDBParameters, RedisImportDataOptionalParams)
Importar dados para a cache de Redis.
function beginImportData(resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- parameters
- ImportRDBParameters
Parâmetros para a operação de importação de Redis.
- options
- RedisImportDataOptionalParams
Os parâmetros de opções.
Devoluções
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportDataAndWait(string, string, ImportRDBParameters, RedisImportDataOptionalParams)
Importar dados para a cache de Redis.
function beginImportDataAndWait(resourceGroupName: string, name: string, parameters: ImportRDBParameters, options?: RedisImportDataOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- parameters
- ImportRDBParameters
Parâmetros para a operação de importação de Redis.
- options
- RedisImportDataOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
beginUpdate(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)
Atualizar uma cache de Redis existente.
function beginUpdate(resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams): Promise<SimplePollerLike<OperationState<RedisResource>, RedisResource>>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- parameters
- RedisUpdateParameters
Parâmetros fornecidos para a operação Atualizar Redis.
- options
- RedisUpdateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisResource>, RedisResource>>
beginUpdateAndWait(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)
Atualizar uma cache de Redis existente.
function beginUpdateAndWait(resourceGroupName: string, name: string, parameters: RedisUpdateParameters, options?: RedisUpdateOptionalParams): Promise<RedisResource>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- parameters
- RedisUpdateParameters
Parâmetros fornecidos para a operação Atualizar Redis.
- options
- RedisUpdateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<RedisResource>
checkNameAvailability(CheckNameAvailabilityParameters, RedisCheckNameAvailabilityOptionalParams)
Verifica se o nome da cache de redis é válido e ainda não está a ser utilizado.
function checkNameAvailability(parameters: CheckNameAvailabilityParameters, options?: RedisCheckNameAvailabilityOptionalParams): Promise<void>Parâmetros
- parameters
- CheckNameAvailabilityParameters
Parâmetros fornecidos à operação CheckNameAvailability Redis. O único tipo de recurso suportado é "Microsoft.Cache/redis"
Os parâmetros de opções.
Devoluções
Promise<void>
forceReboot(string, string, RedisRebootParameters, RedisForceRebootOptionalParams)
Reinicie os nós de Redis especificados. Esta operação requer permissão de escrita para o recurso de cache. Pode haver potenciais perdas de dados.
function forceReboot(resourceGroupName: string, name: string, parameters: RedisRebootParameters, options?: RedisForceRebootOptionalParams): Promise<RedisForceRebootResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- parameters
- RedisRebootParameters
Especifica os nós de Redis a reiniciar.
- options
- RedisForceRebootOptionalParams
Os parâmetros de opções.
Devoluções
Promise<RedisForceRebootResponse>
get(string, string, RedisGetOptionalParams)
Obtém uma cache de Redis (descrição do recurso).
function get(resourceGroupName: string, name: string, options?: RedisGetOptionalParams): Promise<RedisResource>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- options
- RedisGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<RedisResource>
listByResourceGroup(string, RedisListByResourceGroupOptionalParams)
Lista todas as caches de Redis num grupo de recursos.
function listByResourceGroup(resourceGroupName: string, options?: RedisListByResourceGroupOptionalParams): PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
Os parâmetros de opções.
Devoluções
listBySubscription(RedisListBySubscriptionOptionalParams)
Obtém todas as caches de Redis na subscrição especificada.
function listBySubscription(options?: RedisListBySubscriptionOptionalParams): PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>Parâmetros
Os parâmetros de opções.
Devoluções
listKeys(string, string, RedisListKeysOptionalParams)
Obter as chaves de acesso de uma cache de Redis. Esta operação requer permissão de escrita para o recurso de cache.
function listKeys(resourceGroupName: string, name: string, options?: RedisListKeysOptionalParams): Promise<RedisAccessKeys>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- options
- RedisListKeysOptionalParams
Os parâmetros de opções.
Devoluções
Promise<RedisAccessKeys>
listUpgradeNotifications(string, string, number, RedisListUpgradeNotificationsOptionalParams)
Obtém notificações de atualização para uma cache de Redis.
function listUpgradeNotifications(resourceGroupName: string, name: string, history: number, options?: RedisListUpgradeNotificationsOptionalParams): PagedAsyncIterableIterator<UpgradeNotification, UpgradeNotification[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- history
-
number
quantos minutos no passado para procurar notificações de atualização
Os parâmetros de opções.
Devoluções
regenerateKey(string, string, RedisRegenerateKeyParameters, RedisRegenerateKeyOptionalParams)
Regenerar as chaves de acesso da cache de Redis. Esta operação requer permissão de escrita para o recurso de cache.
function regenerateKey(resourceGroupName: string, name: string, parameters: RedisRegenerateKeyParameters, options?: RedisRegenerateKeyOptionalParams): Promise<RedisAccessKeys>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- name
-
string
O nome da cache de Redis.
- parameters
- RedisRegenerateKeyParameters
Especifica a chave a regenerar.
- options
- RedisRegenerateKeyOptionalParams
Os parâmetros de opções.
Devoluções
Promise<RedisAccessKeys>