Databases interface
Interface que representa um Banco de Dados.
Métodos
Detalhes do método
beginCreate(string, string, string, Database, DatabasesCreateOptionalParams)
Cria um banco de dados
function beginCreate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- parameters
- Database
Parâmetros fornecidos para a operação de criação ou atualização do banco de dados.
- options
- DatabasesCreateOptionalParams
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>
beginCreateAndWait(string, string, string, Database, DatabasesCreateOptionalParams)
Cria um banco de dados
function beginCreateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<Database>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- parameters
- Database
Parâmetros fornecidos para a operação de criação ou atualização do banco de dados.
- options
- DatabasesCreateOptionalParams
Os parâmetros de opções.
Retornos
Promise<Database>
beginDelete(string, string, string, DatabasesDeleteOptionalParams)
Exclui um único banco de dados
function beginDelete(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): 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.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- options
- DatabasesDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, DatabasesDeleteOptionalParams)
Exclui um único banco de dados
function beginDeleteAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<void>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- options
- DatabasesDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
beginExport(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)
Exporta um arquivo de banco de dados do banco de dados de destino.
function beginExport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams): 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.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- parameters
- ExportClusterParameters
Informações de armazenamento para exportação para o cluster
- options
- DatabasesExportOptionalParams
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginExportAndWait(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)
Exporta um arquivo de banco de dados do banco de dados de destino.
function beginExportAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams): Promise<void>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- parameters
- ExportClusterParameters
Informações de armazenamento para exportação para o cluster
- options
- DatabasesExportOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
beginFlush(string, string, string, DatabasesFlushOptionalParams)
Libera todas as chaves neste banco de dados e também de seus bancos de dados vinculados.
function beginFlush(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams): 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.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- options
- DatabasesFlushOptionalParams
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginFlushAndWait(string, string, string, DatabasesFlushOptionalParams)
Libera todas as chaves neste banco de dados e também de seus bancos de dados vinculados.
function beginFlushAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams): Promise<void>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- options
- DatabasesFlushOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
beginForceLinkToReplicationGroup(string, string, string, ForceLinkParameters, DatabasesForceLinkToReplicationGroupOptionalParams)
Recria à força um banco de dados existente no cluster especificado e o reencontra em um grupo de replicação existente. OBSERVAÇÃO IMPORTANTE: Todos os dados neste banco de dados serão descartados e o banco de dados ficará temporariamente indisponível ao se juntar ao grupo de replicação.
function beginForceLinkToReplicationGroup(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams): Promise<SimplePollerLike<OperationState<DatabasesForceLinkToReplicationGroupHeaders>, DatabasesForceLinkToReplicationGroupHeaders>>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- parameters
- ForceLinkParameters
Informações que identificam o banco de dados a ser desvinculado.
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabasesForceLinkToReplicationGroupHeaders>, DatabasesForceLinkToReplicationGroupHeaders>>
beginForceLinkToReplicationGroupAndWait(string, string, string, ForceLinkParameters, DatabasesForceLinkToReplicationGroupOptionalParams)
Recria à força um banco de dados existente no cluster especificado e o reencontra em um grupo de replicação existente. OBSERVAÇÃO IMPORTANTE: Todos os dados neste banco de dados serão descartados e o banco de dados ficará temporariamente indisponível ao se juntar ao grupo de replicação.
function beginForceLinkToReplicationGroupAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams): Promise<DatabasesForceLinkToReplicationGroupHeaders>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- parameters
- ForceLinkParameters
Informações que identificam o banco de dados a ser desvinculado.
Os parâmetros de opções.
Retornos
beginForceUnlink(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)
Remove à força o link para o recurso de banco de dados especificado.
function beginForceUnlink(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams): 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.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- parameters
- ForceUnlinkParameters
Informações que identificam o banco de dados a ser desvinculado.
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginForceUnlinkAndWait(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)
Remove à força o link para o recurso de banco de dados especificado.
function beginForceUnlinkAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams): Promise<void>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- parameters
- ForceUnlinkParameters
Informações que identificam o banco de dados a ser desvinculado.
Os parâmetros de opções.
Retornos
Promise<void>
beginImport(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)
Importa arquivos de banco de dados para o banco de dados de destino.
function beginImport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams): 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.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- parameters
- ImportClusterParameters
Informações de armazenamento para importação para o cluster
- options
- DatabasesImportOptionalParams
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportAndWait(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)
Importa arquivos de banco de dados para o banco de dados de destino.
function beginImportAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams): Promise<void>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- parameters
- ImportClusterParameters
Informações de armazenamento para importação para o cluster
- options
- DatabasesImportOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
beginRegenerateKey(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)
Regenera as chaves de acesso do banco de dados do Redis Enterprise.
function beginRegenerateKey(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<AccessKeys>, AccessKeys>>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- parameters
- RegenerateKeyParameters
Especifica qual chave regenerar.
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<AccessKeys>, AccessKeys>>
beginRegenerateKeyAndWait(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)
Regenera as chaves de acesso do banco de dados do Redis Enterprise.
function beginRegenerateKeyAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams): Promise<AccessKeys>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- parameters
- RegenerateKeyParameters
Especifica qual chave regenerar.
Os parâmetros de opções.
Retornos
Promise<AccessKeys>
beginUpdate(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)
Atualiza um banco de dados
function beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- parameters
- DatabaseUpdate
Parâmetros fornecidos para a operação de criação ou atualização do banco de dados.
- options
- DatabasesUpdateOptionalParams
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>
beginUpdateAndWait(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)
Atualiza um banco de dados
function beginUpdateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<Database>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- parameters
- DatabaseUpdate
Parâmetros fornecidos para a operação de criação ou atualização do banco de dados.
- options
- DatabasesUpdateOptionalParams
Os parâmetros de opções.
Retornos
Promise<Database>
beginUpgradeDBRedisVersion(string, string, string, DatabasesUpgradeDBRedisVersionOptionalParams)
Atualiza a versão do Banco de Dados Redis para a mais recente disponível.
function beginUpgradeDBRedisVersion(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams): Promise<SimplePollerLike<OperationState<DatabasesUpgradeDBRedisVersionHeaders>, DatabasesUpgradeDBRedisVersionHeaders>>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
Os parâmetros de opções.
Retornos
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabasesUpgradeDBRedisVersionHeaders>, DatabasesUpgradeDBRedisVersionHeaders>>
beginUpgradeDBRedisVersionAndWait(string, string, string, DatabasesUpgradeDBRedisVersionOptionalParams)
Atualiza a versão do Banco de Dados Redis para a mais recente disponível.
function beginUpgradeDBRedisVersionAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams): Promise<DatabasesUpgradeDBRedisVersionHeaders>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
Os parâmetros de opções.
Retornos
get(string, string, string, DatabasesGetOptionalParams)
Obtém informações sobre um banco de dados em um cluster Redis Enterprise.
function get(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesGetOptionalParams): Promise<Database>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- options
- DatabasesGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<Database>
listByCluster(string, string, DatabasesListByClusterOptionalParams)
Obtém todos os bancos de dados no cluster do Redis Enterprise especificado.
function listByCluster(resourceGroupName: string, clusterName: string, options?: DatabasesListByClusterOptionalParams): PagedAsyncIterableIterator<Database, Database[], PageSettings>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
Os parâmetros de opções.
Retornos
listKeys(string, string, string, DatabasesListKeysOptionalParams)
Recupera as chaves de acesso do banco de dados do Redis Enterprise.
function listKeys(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesListKeysOptionalParams): Promise<AccessKeys>
Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- clusterName
-
string
O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos
- databaseName
-
string
O nome do banco de dados Redis Enterprise.
- options
- DatabasesListKeysOptionalParams
Os parâmetros de opções.
Retornos
Promise<AccessKeys>