Redis interface

Пакет:

@azure/arm-rediscache

Интерфейс, представляющий Redis.

Методы

beginCreate(string, string, RedisCreateParameters, RedisCreateOptionalParams)	Создайте или замените существующий кэш Redis (перезапись или повторное создание) с потенциальным временем простоя.
beginCreateAndWait(string, string, RedisCreateParameters, RedisCreateOptionalParams)	Создайте или замените существующий кэш Redis (перезапись или повторное создание) с потенциальным временем простоя.
beginDelete(string, string, RedisDeleteOptionalParams)	Удаляет кэш Redis.
beginDeleteAndWait(string, string, RedisDeleteOptionalParams)	Удаляет кэш Redis.
beginExportData(string, string, ExportRDBParameters, RedisExportDataOptionalParams)	Экспортируйте данные из кэша Redis в большие двоичные объекты в контейнере.
beginExportDataAndWait(string, string, ExportRDBParameters, RedisExportDataOptionalParams)	Экспортируйте данные из кэша Redis в большие двоичные объекты в контейнере.
beginFlushCache(string, string, RedisFlushCacheOptionalParams)	Удаляет все ключи в кэше.
beginFlushCacheAndWait(string, string, RedisFlushCacheOptionalParams)	Удаляет все ключи в кэше.
beginImportData(string, string, ImportRDBParameters, RedisImportDataOptionalParams)	Импортируйте данные в кэш Redis.
beginImportDataAndWait(string, string, ImportRDBParameters, RedisImportDataOptionalParams)	Импортируйте данные в кэш Redis.
beginUpdate(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)	Обновите существующий кэш Redis.
beginUpdateAndWait(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)	Обновите существующий кэш Redis.
checkNameAvailability(CheckNameAvailabilityParameters, RedisCheckNameAvailabilityOptionalParams)	Проверяет, является ли имя кэша Redis допустимым и еще не используется.
forceReboot(string, string, RedisRebootParameters, RedisForceRebootOptionalParams)	Перезагрузите указанные узлы Redis. Для этой операции требуется разрешение на запись в ресурс кэша. Может возникнуть потенциальная потеря данных.
get(string, string, RedisGetOptionalParams)	Возвращает кэш Redis (описание ресурса).
listByResourceGroup(string, RedisListByResourceGroupOptionalParams)	Перечисляет все кэши Redis в группе ресурсов.
listBySubscription(RedisListBySubscriptionOptionalParams)	Возвращает все кэши Redis в указанной подписке.
listKeys(string, string, RedisListKeysOptionalParams)	Получение ключей доступа кэша Redis. Для этой операции требуется разрешение на запись в ресурс кэша.
listUpgradeNotifications(string, string, number, RedisListUpgradeNotificationsOptionalParams)	Возвращает все уведомления об обновлении для кэша Redis.
regenerateKey(string, string, RedisRegenerateKeyParameters, RedisRegenerateKeyOptionalParams)	Повторно создайте ключи доступа кэша Redis. Для этой операции требуется разрешение на запись в ресурс кэша.

Сведения о методе

beginCreate(string, string, RedisCreateParameters, RedisCreateOptionalParams)

Создайте или замените существующий кэш Redis (перезапись или повторное создание) с потенциальным временем простоя.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

parameters

RedisCreateParameters

Параметры, предоставленные операции Create Redis.

options

RedisCreateOptionalParams

Параметры параметров.

Возвращаемое значение

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

beginCreateAndWait(string, string, RedisCreateParameters, RedisCreateOptionalParams)

Создайте или замените существующий кэш Redis (перезапись или повторное создание) с потенциальным временем простоя.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

parameters

RedisCreateParameters

Параметры, предоставленные операции Create Redis.

options

RedisCreateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<RedisResource>

beginDelete(string, string, RedisDeleteOptionalParams)

Удаляет кэш Redis.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

options

RedisDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

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

beginDeleteAndWait(string, string, RedisDeleteOptionalParams)

Удаляет кэш Redis.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

options

RedisDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

beginExportData(string, string, ExportRDBParameters, RedisExportDataOptionalParams)

Экспортируйте данные из кэша Redis в большие двоичные объекты в контейнере.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

parameters

ExportRDBParameters

Параметры операции экспорта Redis.

options

RedisExportDataOptionalParams

Параметры параметров.

Возвращаемое значение

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

beginExportDataAndWait(string, string, ExportRDBParameters, RedisExportDataOptionalParams)

Экспортируйте данные из кэша Redis в большие двоичные объекты в контейнере.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

parameters

ExportRDBParameters

Параметры операции экспорта Redis.

options

RedisExportDataOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

beginFlushCache(string, string, RedisFlushCacheOptionalParams)

Удаляет все ключи в кэше.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

cacheName

string

Имя кэша Redis.

options

RedisFlushCacheOptionalParams

Параметры параметров.

Возвращаемое значение

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

beginFlushCacheAndWait(string, string, RedisFlushCacheOptionalParams)

Удаляет все ключи в кэше.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

cacheName

string

Имя кэша Redis.

options

RedisFlushCacheOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<RedisFlushCacheResponse>

beginImportData(string, string, ImportRDBParameters, RedisImportDataOptionalParams)

Импортируйте данные в кэш Redis.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

parameters

ImportRDBParameters

Параметры операции импорта Redis.

options

RedisImportDataOptionalParams

Параметры параметров.

Возвращаемое значение

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

beginImportDataAndWait(string, string, ImportRDBParameters, RedisImportDataOptionalParams)

Импортируйте данные в кэш Redis.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

parameters

ImportRDBParameters

Параметры операции импорта Redis.

options

RedisImportDataOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

beginUpdate(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)

Обновите существующий кэш Redis.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

parameters

RedisUpdateParameters

Параметры, предоставленные операции Update Redis.

options

RedisUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

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

beginUpdateAndWait(string, string, RedisUpdateParameters, RedisUpdateOptionalParams)

Обновите существующий кэш Redis.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

parameters

RedisUpdateParameters

Параметры, предоставленные операции Update Redis.

options

RedisUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<RedisResource>

checkNameAvailability(CheckNameAvailabilityParameters, RedisCheckNameAvailabilityOptionalParams)

Проверяет, является ли имя кэша Redis допустимым и еще не используется.

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

Параметры

parameters

CheckNameAvailabilityParameters

Параметры, предоставленные операции CheckNameAvailability Redis. Единственным поддерживаемым типом ресурса является Microsoft.Cache/redis.

options

RedisCheckNameAvailabilityOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

forceReboot(string, string, RedisRebootParameters, RedisForceRebootOptionalParams)

Перезагрузите указанные узлы Redis. Для этой операции требуется разрешение на запись в ресурс кэша. Может возникнуть потенциальная потеря данных.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

parameters

RedisRebootParameters

Указывает, какие узлы Redis необходимо перезагрузить.

options

RedisForceRebootOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<RedisForceRebootResponse>

get(string, string, RedisGetOptionalParams)

Возвращает кэш Redis (описание ресурса).

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

options

RedisGetOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<RedisResource>

listByResourceGroup(string, RedisListByResourceGroupOptionalParams)

Перечисляет все кэши Redis в группе ресурсов.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

options

RedisListByResourceGroupOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>

listBySubscription(RedisListBySubscriptionOptionalParams)

Возвращает все кэши Redis в указанной подписке.

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

Параметры

options

RedisListBySubscriptionOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<RedisResource, RedisResource[], PageSettings>

listKeys(string, string, RedisListKeysOptionalParams)

Получение ключей доступа кэша Redis. Для этой операции требуется разрешение на запись в ресурс кэша.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

options

RedisListKeysOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<RedisAccessKeys>

listUpgradeNotifications(string, string, number, RedisListUpgradeNotificationsOptionalParams)

Возвращает все уведомления об обновлении для кэша Redis.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

history

number

сколько минут за последние минуты поиска уведомлений об обновлении

options

RedisListUpgradeNotificationsOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<UpgradeNotification, UpgradeNotification[], PageSettings>

regenerateKey(string, string, RedisRegenerateKeyParameters, RedisRegenerateKeyOptionalParams)

Повторно создайте ключи доступа кэша Redis. Для этой операции требуется разрешение на запись в ресурс кэша.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

name

string

Имя кэша Redis.

parameters

RedisRegenerateKeyParameters

Указывает, какой ключ необходимо повторно создать.

options

RedisRegenerateKeyOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<RedisAccessKeys>