Databases interface

Пакет:: @azure/arm-redisenterprisecache

Интерфейс, представляющий базы данных.

Методы

beginCreate(string, string, string, Database, DatabasesCreateOptionalParams)	Создание базы данных
beginCreateAndWait(string, string, string, Database, DatabasesCreateOptionalParams)	Создание базы данных
beginDelete(string, string, string, DatabasesDeleteOptionalParams)	Удаляет отдельную базу данных
beginDeleteAndWait(string, string, string, DatabasesDeleteOptionalParams)	Удаляет отдельную базу данных
beginExport(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)	Экспортирует файл базы данных из целевой базы данных.
beginExportAndWait(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)	Экспортирует файл базы данных из целевой базы данных.
beginFlush(string, string, string, DatabasesFlushOptionalParams)	Очищает все ключи в этой базе данных, а также из связанных баз данных.
beginFlushAndWait(string, string, string, DatabasesFlushOptionalParams)	Очищает все ключи в этой базе данных, а также из связанных баз данных.
beginForceLinkToReplicationGroup(string, string, string, ForceLinkParameters, DatabasesForceLinkToReplicationGroupOptionalParams)	Принудительно воссоздает существующую базу данных в указанном кластере и повторно присоединит ее к существующей группе репликации. ВАЖНОЕ ПРИМЕЧАНИЕ. Все данные в этой базе данных будут удалены, и база данных временно будет недоступна при повторном присоединении к группе репликации.
beginForceLinkToReplicationGroupAndWait(string, string, string, ForceLinkParameters, DatabasesForceLinkToReplicationGroupOptionalParams)	Принудительно воссоздает существующую базу данных в указанном кластере и повторно присоединит ее к существующей группе репликации. ВАЖНОЕ ПРИМЕЧАНИЕ. Все данные в этой базе данных будут удалены, и база данных временно будет недоступна при повторном присоединении к группе репликации.
beginForceUnlink(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)	Принудительно удаляет ссылку на указанный ресурс базы данных.
beginForceUnlinkAndWait(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)	Принудительно удаляет ссылку на указанный ресурс базы данных.
beginImport(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)	Импортирует файлы базы данных в целевую базу данных.
beginImportAndWait(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)	Импортирует файлы базы данных в целевую базу данных.
beginRegenerateKey(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)	Повторно генерирует ключи доступа базы данных Redis Enterprise.
beginRegenerateKeyAndWait(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)	Повторно генерирует ключи доступа базы данных Redis Enterprise.
beginUpdate(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)	Обновление базы данных
beginUpdateAndWait(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)	Обновление базы данных
beginUpgradeDBRedisVersion(string, string, string, DatabasesUpgradeDBRedisVersionOptionalParams)	Обновляет версию Redis базы данных до последней доступной.
beginUpgradeDBRedisVersionAndWait(string, string, string, DatabasesUpgradeDBRedisVersionOptionalParams)	Обновляет версию Redis базы данных до последней доступной.
get(string, string, string, DatabasesGetOptionalParams)	Возвращает сведения о базе данных в кластере Redis Enterprise.
listByCluster(string, string, DatabasesListByClusterOptionalParams)	Получает все базы данных в указанном кластере Redis Enterprise.
listKeys(string, string, string, DatabasesListKeysOptionalParams)	Извлекает ключи доступа к базе данных Redis Enterprise.

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

beginCreate(string, string, string, Database, DatabasesCreateOptionalParams)

Создание базы данных

function beginCreate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>

Параметры

resourceGroupName: string

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

clusterName: string

Имя кластера Redis Enterprise. Имя должно иметь длину 1–60 символов. Допустимые символы (A-Z, a-z, 0-9) и дефис(-). Не может быть ни ведущих, ни конечных, ни последовательных дефисов

databaseName: string

Имя базы данных Redis Enterprise.

parameters: Database

Параметры, предоставленные операции создания или обновления базы данных.

options: DatabasesCreateOptionalParams

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

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

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

beginCreateAndWait(string, string, string, Database, DatabasesCreateOptionalParams)

Создание базы данных

function beginCreateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<Database>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

parameters: Database

Параметры, предоставленные операции создания или обновления базы данных.

options: DatabasesCreateOptionalParams

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

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

Promise<Database>

beginDelete(string, string, string, DatabasesDeleteOptionalParams)

Удаляет отдельную базу данных

function beginDelete(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

options: DatabasesDeleteOptionalParams

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

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

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

beginDeleteAndWait(string, string, string, DatabasesDeleteOptionalParams)

Удаляет отдельную базу данных

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<void>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

options: DatabasesDeleteOptionalParams

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

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

Promise<void>

beginExport(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)

Экспортирует файл базы данных из целевой базы данных.

function beginExport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

parameters: ExportClusterParameters

Сведения о хранилище для экспорта в кластер

options: DatabasesExportOptionalParams

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

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

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

beginExportAndWait(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)

Экспортирует файл базы данных из целевой базы данных.

function beginExportAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams): Promise<void>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

parameters: ExportClusterParameters

Сведения о хранилище для экспорта в кластер

options: DatabasesExportOptionalParams

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

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

Promise<void>

beginFlush(string, string, string, DatabasesFlushOptionalParams)

Очищает все ключи в этой базе данных, а также из связанных баз данных.

function beginFlush(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

options: DatabasesFlushOptionalParams

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

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

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

beginFlushAndWait(string, string, string, DatabasesFlushOptionalParams)

Очищает все ключи в этой базе данных, а также из связанных баз данных.

function beginFlushAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams): Promise<void>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

options: DatabasesFlushOptionalParams

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

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

Promise<void>

beginForceLinkToReplicationGroup(string, string, string, ForceLinkParameters, DatabasesForceLinkToReplicationGroupOptionalParams)

Принудительно воссоздает существующую базу данных в указанном кластере и повторно присоединит ее к существующей группе репликации. ВАЖНОЕ ПРИМЕЧАНИЕ. Все данные в этой базе данных будут удалены, и база данных временно будет недоступна при повторном присоединении к группе репликации.

function beginForceLinkToReplicationGroup(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams): Promise<SimplePollerLike<OperationState<DatabasesForceLinkToReplicationGroupHeaders>, DatabasesForceLinkToReplicationGroupHeaders>>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

parameters: ForceLinkParameters

Сведения, определяющие базу данных для отмены связи.

options: DatabasesForceLinkToReplicationGroupOptionalParams

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

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

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

beginForceLinkToReplicationGroupAndWait(string, string, string, ForceLinkParameters, DatabasesForceLinkToReplicationGroupOptionalParams)

function beginForceLinkToReplicationGroupAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams): Promise<DatabasesForceLinkToReplicationGroupHeaders>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

parameters: ForceLinkParameters

Сведения, определяющие базу данных для отмены связи.

options: DatabasesForceLinkToReplicationGroupOptionalParams

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

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

Promise<DatabasesForceLinkToReplicationGroupHeaders>

beginForceUnlink(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)

Принудительно удаляет ссылку на указанный ресурс базы данных.

function beginForceUnlink(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

parameters: ForceUnlinkParameters

Сведения, определяющие базу данных для отмены связи.

options: DatabasesForceUnlinkOptionalParams

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

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

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

beginForceUnlinkAndWait(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)

Принудительно удаляет ссылку на указанный ресурс базы данных.

function beginForceUnlinkAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams): Promise<void>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

parameters: ForceUnlinkParameters

Сведения, определяющие базу данных для отмены связи.

options: DatabasesForceUnlinkOptionalParams

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

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

Promise<void>

beginImport(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)

Импортирует файлы базы данных в целевую базу данных.

function beginImport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

parameters: ImportClusterParameters

Сведения о хранилище для импорта в кластер

options: DatabasesImportOptionalParams

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

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

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

beginImportAndWait(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)

Импортирует файлы базы данных в целевую базу данных.

function beginImportAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams): Promise<void>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

parameters: ImportClusterParameters

Сведения о хранилище для импорта в кластер

options: DatabasesImportOptionalParams

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

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

Promise<void>

beginRegenerateKey(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)

Повторно генерирует ключи доступа базы данных Redis Enterprise.

function beginRegenerateKey(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<AccessKeys>, AccessKeys>>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

parameters: RegenerateKeyParameters

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

options: DatabasesRegenerateKeyOptionalParams

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

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

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

beginRegenerateKeyAndWait(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)

Повторно генерирует ключи доступа базы данных Redis Enterprise.

function beginRegenerateKeyAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams): Promise<AccessKeys>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

parameters: RegenerateKeyParameters

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

options: DatabasesRegenerateKeyOptionalParams

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

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

Promise<AccessKeys>

beginUpdate(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)

Обновление базы данных

function beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

parameters: DatabaseUpdate

Параметры, предоставленные операции создания или обновления базы данных.

options: DatabasesUpdateOptionalParams

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

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

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

beginUpdateAndWait(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)

Обновление базы данных

function beginUpdateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<Database>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

parameters: DatabaseUpdate

Параметры, предоставленные операции создания или обновления базы данных.

options: DatabasesUpdateOptionalParams

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

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

Promise<Database>

beginUpgradeDBRedisVersion(string, string, string, DatabasesUpgradeDBRedisVersionOptionalParams)

Обновляет версию Redis базы данных до последней доступной.

function beginUpgradeDBRedisVersion(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams): Promise<SimplePollerLike<OperationState<DatabasesUpgradeDBRedisVersionHeaders>, DatabasesUpgradeDBRedisVersionHeaders>>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

options: DatabasesUpgradeDBRedisVersionOptionalParams

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

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

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

beginUpgradeDBRedisVersionAndWait(string, string, string, DatabasesUpgradeDBRedisVersionOptionalParams)

Обновляет версию Redis базы данных до последней доступной.

function beginUpgradeDBRedisVersionAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams): Promise<DatabasesUpgradeDBRedisVersionHeaders>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

options: DatabasesUpgradeDBRedisVersionOptionalParams

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

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

Promise<DatabasesUpgradeDBRedisVersionHeaders>

get(string, string, string, DatabasesGetOptionalParams)

Возвращает сведения о базе данных в кластере Redis Enterprise.

function get(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesGetOptionalParams): Promise<Database>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

options: DatabasesGetOptionalParams

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

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

Promise<Database>

listByCluster(string, string, DatabasesListByClusterOptionalParams)

Получает все базы данных в указанном кластере Redis Enterprise.

function listByCluster(resourceGroupName: string, clusterName: string, options?: DatabasesListByClusterOptionalParams): PagedAsyncIterableIterator<Database, Database[], PageSettings>

Параметры

resourceGroupName: string

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

clusterName: string

options: DatabasesListByClusterOptionalParams

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

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

PagedAsyncIterableIterator<Database, Database[], PageSettings>

listKeys(string, string, string, DatabasesListKeysOptionalParams)

Извлекает ключи доступа к базе данных Redis Enterprise.

function listKeys(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesListKeysOptionalParams): Promise<AccessKeys>

Параметры

resourceGroupName: string

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

clusterName: string

databaseName: string

Имя базы данных Redis Enterprise.

options: DatabasesListKeysOptionalParams

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

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

Promise<AccessKeys>