Redis interface
Interface que representa um Redis.
Métodos
Detalhes do método
beginCreate(string, string, RedisCreateParameters, RedisCreateOptionalParams)
Criar ou substituir (substituir/recriar, com tempo de inatividade potencial) um cache 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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- parameters
- RedisCreateParameters
Parâmetros fornecidos para a operação Criar Redis.
- options
- RedisCreateOptionalParams
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisResource>, RedisResource>>
beginCreateAndWait(string, string, RedisCreateParameters, RedisCreateOptionalParams)
Criar ou substituir (substituir/recriar, com tempo de inatividade potencial) um cache 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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- parameters
- RedisCreateParameters
Parâmetros fornecidos para a operação Criar Redis.
- options
- RedisCreateOptionalParams
Os parâmetros de opções.
Retornos
Promise<RedisResource>
beginDelete(string, string, RedisDeleteOptionalParams)
Exclui um cache 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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- options
- RedisDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, RedisDeleteOptionalParams)
Exclui um cache 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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- options
- RedisDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
beginExportData(string, string, ExportRDBParameters, RedisExportDataOptionalParams)
Exportar dados do cache redis para blobs em um contêiner.
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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- parameters
- ExportRDBParameters
Parâmetros para a operação de exportação do Redis.
- options
- RedisExportDataOptionalParams
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginExportDataAndWait(string, string, ExportRDBParameters, RedisExportDataOptionalParams)
Exportar dados do cache redis para blobs em um contêiner.
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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- parameters
- ExportRDBParameters
Parâmetros para a operação de exportação do Redis.
- options
- RedisExportDataOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
beginFlushCache(string, string, RedisFlushCacheOptionalParams)
Exclui todas as chaves em um 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 diferencia maiúsculas de minúsculas.
- cacheName
-
string
O nome do cache Redis.
- options
- RedisFlushCacheOptionalParams
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisFlushCacheResponse>, RedisFlushCacheResponse>>
beginFlushCacheAndWait(string, string, RedisFlushCacheOptionalParams)
Exclui todas as chaves em um 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 diferencia maiúsculas de minúsculas.
- cacheName
-
string
O nome do cache Redis.
- options
- RedisFlushCacheOptionalParams
Os parâmetros de opções.
Retornos
Promise<RedisFlushCacheResponse>
beginImportData(string, string, ImportRDBParameters, RedisImportDataOptionalParams)
Importar dados para o cache 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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- parameters
- ImportRDBParameters
Parâmetros para a operação de importação do Redis.
- options
- RedisImportDataOptionalParams
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportDataAndWait(string, string, ImportRDBParameters, RedisImportDataOptionalParams)
Importar dados para o cache 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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- parameters
- ImportRDBParameters
Parâmetros para a operação de importação do Redis.
- options
- RedisImportDataOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
beginUpdate(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)
Atualize um cache 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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- parameters
- RedisUpdateParameters
Parâmetros fornecidos para a operação Atualizar Redis.
- options
- RedisUpdateOptionalParams
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisResource>, RedisResource>>
beginUpdateAndWait(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)
Atualize um cache 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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- parameters
- RedisUpdateParameters
Parâmetros fornecidos para a operação Atualizar Redis.
- options
- RedisUpdateOptionalParams
Os parâmetros de opções.
Retornos
Promise<RedisResource>
checkNameAvailability(CheckNameAvailabilityParameters, RedisCheckNameAvailabilityOptionalParams)
Verifica se o nome do cache redis é válido e ainda não está em uso.
function checkNameAvailability(parameters: CheckNameAvailabilityParameters, options?: RedisCheckNameAvailabilityOptionalParams): Promise<void>Parâmetros
- parameters
- CheckNameAvailabilityParameters
Parâmetros fornecidos para a operação CheckNameAvailability Redis. O único tipo de recurso com suporte é 'Microsoft.Cache/redis'
Os parâmetros de opções.
Retornos
Promise<void>
forceReboot(string, string, RedisRebootParameters, RedisForceRebootOptionalParams)
Reinicialize os nós Redis especificados. Essa operação requer permissão de gravação para o recurso de cache. Pode haver uma possível perda 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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- parameters
- RedisRebootParameters
Especifica quais nós redis serão reinicializados.
- options
- RedisForceRebootOptionalParams
Os parâmetros de opções.
Retornos
Promise<RedisForceRebootResponse>
get(string, string, RedisGetOptionalParams)
Obtém um cache 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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- options
- RedisGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<RedisResource>
listByResourceGroup(string, RedisListByResourceGroupOptionalParams)
Lista todos os caches Redis em um 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 diferencia maiúsculas de minúsculas.
Os parâmetros de opções.
Retornos
listBySubscription(RedisListBySubscriptionOptionalParams)
Obtém todos os caches Redis na assinatura especificada.
function listBySubscription(options?: RedisListBySubscriptionOptionalParams): PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>Parâmetros
Os parâmetros de opções.
Retornos
listKeys(string, string, RedisListKeysOptionalParams)
Recupere as chaves de acesso de um cache Redis. Essa operação requer permissão de gravação 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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- options
- RedisListKeysOptionalParams
Os parâmetros de opções.
Retornos
Promise<RedisAccessKeys>
listUpgradeNotifications(string, string, number, RedisListUpgradeNotificationsOptionalParams)
Obtém quaisquer notificações de atualização para um cache 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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- history
-
number
quantos minutos no passado para procurar notificações de atualização
Os parâmetros de opções.
Retornos
regenerateKey(string, string, RedisRegenerateKeyParameters, RedisRegenerateKeyOptionalParams)
Regenerar as chaves de acesso do cache Redis. Essa operação requer permissão de gravação 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 diferencia maiúsculas de minúsculas.
- name
-
string
O nome do cache Redis.
- parameters
- RedisRegenerateKeyParameters
Especifica qual chave regenerar.
- options
- RedisRegenerateKeyOptionalParams
Os parâmetros de opções.
Retornos
Promise<RedisAccessKeys>