Databases interface
Interface représentant une base de données.
Méthodes
Détails de la méthode
beginCreate(string, string, string, Database, DatabasesCreateOptionalParams)
Crée une base de données
function beginCreate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- parameters
- Database
Paramètres fournis à l’opération de création ou de mise à jour de la base de données.
- options
- DatabasesCreateOptionalParams
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>
beginCreateAndWait(string, string, string, Database, DatabasesCreateOptionalParams)
Crée une base de données
function beginCreateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOptionalParams): Promise<Database>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- parameters
- Database
Paramètres fournis à l’opération de création ou de mise à jour de la base de données.
- options
- DatabasesCreateOptionalParams
Paramètres d’options.
Retours
Promise<Database>
beginDelete(string, string, string, DatabasesDeleteOptionalParams)
Supprime une base de données unique
function beginDelete(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- options
- DatabasesDeleteOptionalParams
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, DatabasesDeleteOptionalParams)
Supprime une base de données unique
function beginDeleteAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<void>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- options
- DatabasesDeleteOptionalParams
Paramètres d’options.
Retours
Promise<void>
beginExport(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)
Exporte un fichier de base de données à partir de la base de données cible.
function beginExport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- parameters
- ExportClusterParameters
Informations de stockage pour l’exportation dans le cluster
- options
- DatabasesExportOptionalParams
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginExportAndWait(string, string, string, ExportClusterParameters, DatabasesExportOptionalParams)
Exporte un fichier de base de données à partir de la base de données cible.
function beginExportAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ExportClusterParameters, options?: DatabasesExportOptionalParams): Promise<void>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- parameters
- ExportClusterParameters
Informations de stockage pour l’exportation dans le cluster
- options
- DatabasesExportOptionalParams
Paramètres d’options.
Retours
Promise<void>
beginFlush(string, string, string, DatabasesFlushOptionalParams)
Vide toutes les clés de cette base de données et de ses bases de données liées.
function beginFlush(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- options
- DatabasesFlushOptionalParams
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginFlushAndWait(string, string, string, DatabasesFlushOptionalParams)
Vide toutes les clés de cette base de données et de ses bases de données liées.
function beginFlushAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesFlushOptionalParams): Promise<void>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- options
- DatabasesFlushOptionalParams
Paramètres d’options.
Retours
Promise<void>
beginForceLinkToReplicationGroup(string, string, string, ForceLinkParameters, DatabasesForceLinkToReplicationGroupOptionalParams)
Recrée de force une base de données existante sur le cluster spécifié et la rejoint à un groupe de réplication existant. REMARQUE IMPORTANTE : Toutes les données de cette base de données seront ignorées et la base de données sera temporairement indisponible lors de la jointion du groupe de réplication.
function beginForceLinkToReplicationGroup(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams): Promise<SimplePollerLike<OperationState<DatabasesForceLinkToReplicationGroupHeaders>, DatabasesForceLinkToReplicationGroupHeaders>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- parameters
- ForceLinkParameters
Informations identifiant la base de données à dissocier.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabasesForceLinkToReplicationGroupHeaders>, DatabasesForceLinkToReplicationGroupHeaders>>
beginForceLinkToReplicationGroupAndWait(string, string, string, ForceLinkParameters, DatabasesForceLinkToReplicationGroupOptionalParams)
Recrée de force une base de données existante sur le cluster spécifié et la rejoint à un groupe de réplication existant. REMARQUE IMPORTANTE : Toutes les données de cette base de données seront ignorées et la base de données sera temporairement indisponible lors de la jointion du groupe de réplication.
function beginForceLinkToReplicationGroupAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceLinkParameters, options?: DatabasesForceLinkToReplicationGroupOptionalParams): Promise<DatabasesForceLinkToReplicationGroupHeaders>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- parameters
- ForceLinkParameters
Informations identifiant la base de données à dissocier.
Paramètres d’options.
Retours
beginForceUnlink(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)
Supprime de force le lien vers la ressource de base de données spécifiée.
function beginForceUnlink(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- parameters
- ForceUnlinkParameters
Informations identifiant la base de données à dissocier.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginForceUnlinkAndWait(string, string, string, ForceUnlinkParameters, DatabasesForceUnlinkOptionalParams)
Supprime de force le lien vers la ressource de base de données spécifiée.
function beginForceUnlinkAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ForceUnlinkParameters, options?: DatabasesForceUnlinkOptionalParams): Promise<void>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- parameters
- ForceUnlinkParameters
Informations identifiant la base de données à dissocier.
Paramètres d’options.
Retours
Promise<void>
beginImport(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)
Importe les fichiers de base de données dans la base de données cible.
function beginImport(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- parameters
- ImportClusterParameters
Informations de stockage pour l’importation dans le cluster
- options
- DatabasesImportOptionalParams
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginImportAndWait(string, string, string, ImportClusterParameters, DatabasesImportOptionalParams)
Importe les fichiers de base de données dans la base de données cible.
function beginImportAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: ImportClusterParameters, options?: DatabasesImportOptionalParams): Promise<void>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- parameters
- ImportClusterParameters
Informations de stockage pour l’importation dans le cluster
- options
- DatabasesImportOptionalParams
Paramètres d’options.
Retours
Promise<void>
beginRegenerateKey(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)
Régénère les clés d’accès de la base de données Redis Enterprise.
function beginRegenerateKey(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<AccessKeys>, AccessKeys>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- parameters
- RegenerateKeyParameters
Spécifie la clé à régénérer.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<AccessKeys>, AccessKeys>>
beginRegenerateKeyAndWait(string, string, string, RegenerateKeyParameters, DatabasesRegenerateKeyOptionalParams)
Régénère les clés d’accès de la base de données Redis Enterprise.
function beginRegenerateKeyAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: RegenerateKeyParameters, options?: DatabasesRegenerateKeyOptionalParams): Promise<AccessKeys>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- parameters
- RegenerateKeyParameters
Spécifie la clé à régénérer.
Paramètres d’options.
Retours
Promise<AccessKeys>
beginUpdate(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)
Met à jour une base de données
function beginUpdate(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- parameters
- DatabaseUpdate
Paramètres fournis à l’opération de création ou de mise à jour de la base de données.
- options
- DatabasesUpdateOptionalParams
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>
beginUpdateAndWait(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)
Met à jour une base de données
function beginUpdateAndWait(resourceGroupName: string, clusterName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<Database>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- parameters
- DatabaseUpdate
Paramètres fournis à l’opération de création ou de mise à jour de la base de données.
- options
- DatabasesUpdateOptionalParams
Paramètres d’options.
Retours
Promise<Database>
beginUpgradeDBRedisVersion(string, string, string, DatabasesUpgradeDBRedisVersionOptionalParams)
Met à niveau la version redis de la base de données vers la dernière version disponible.
function beginUpgradeDBRedisVersion(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams): Promise<SimplePollerLike<OperationState<DatabasesUpgradeDBRedisVersionHeaders>, DatabasesUpgradeDBRedisVersionHeaders>>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<DatabasesUpgradeDBRedisVersionHeaders>, DatabasesUpgradeDBRedisVersionHeaders>>
beginUpgradeDBRedisVersionAndWait(string, string, string, DatabasesUpgradeDBRedisVersionOptionalParams)
Met à niveau la version redis de la base de données vers la dernière version disponible.
function beginUpgradeDBRedisVersionAndWait(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesUpgradeDBRedisVersionOptionalParams): Promise<DatabasesUpgradeDBRedisVersionHeaders>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
Paramètres d’options.
Retours
get(string, string, string, DatabasesGetOptionalParams)
Obtient des informations sur une base de données dans un cluster Redis Enterprise.
function get(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesGetOptionalParams): Promise<Database>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- options
- DatabasesGetOptionalParams
Paramètres d’options.
Retours
Promise<Database>
listByCluster(string, string, DatabasesListByClusterOptionalParams)
Obtient toutes les bases de données du cluster Redis Enterprise spécifié.
function listByCluster(resourceGroupName: string, clusterName: string, options?: DatabasesListByClusterOptionalParams): PagedAsyncIterableIterator<Database, Database[], PageSettings>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
Paramètres d’options.
Retours
listKeys(string, string, string, DatabasesListKeysOptionalParams)
Récupère les clés d’accès de la base de données Redis Enterprise.
function listKeys(resourceGroupName: string, clusterName: string, databaseName: string, options?: DatabasesListKeysOptionalParams): Promise<AccessKeys>
Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- clusterName
-
string
Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
- databaseName
-
string
Nom de la base de données Redis Enterprise.
- options
- DatabasesListKeysOptionalParams
Paramètres d’options.
Retours
Promise<AccessKeys>