Installer le module SQL Server PowerShell

S’applique à :SQL ServerAzure SQL DatabaseAzure SQL Managed InstanceAzure Synapse AnalyticsAnalytics Platform System (PDW)

Cet article fournit des instructions pour installer le module PowerShell SqlServer.

Modules PowerShell pour SQL Server

Il existe deux modules SQL Server PowerShell :

  • SqlServer : Le module SqlServer inclut de nouvelles applets de commande pour prendre en charge les dernières fonctionnalités SQL. Le module contient également des versions mises à jour des applets de commande dans SQLPS. Pour télécharger le module SqlServer, accédez à Module SqlServer dans PowerShell Gallery.

  • SQLPS : Le SQLPS est le module utilisé par SQL Agent pour exécuter les travaux de l’agent dans les étapes de travail de l’agent à l’aide du sous-système PowerShell.

Notes

Les versions du module SqlServer dans PowerShell Gallery prennent en charge le versioning et nécessitent PowerShell version 5.1 ou ultérieure.

Pour consulter les rubriques d’aide, accédez à :

SQL Server Management Studio

SQL Server Management Studio (SSMS) n’installe aucun module PowerShell. Pour utiliser PowerShell avec SSMS, installez le module SqlServer à partir de PowerShell Gallery.

Notes

SQL Server Management Studio (SSMS) 16.x (et versions antérieures) incluait le module SQLPS.

Azure Data Studio

Azure Data Studio n’installe aucun module PowerShell. Pour utiliser PowerShell avec Azure Data Studio, installez le module SqlServer à partir de PowerShell Gallery.

Vous pouvez utiliser l’extension PowerShell, qui fournit une prise en charge complète de l’éditeur PowerShell dans Azure Data Studio.

Installer ou mettre à jour le module SqlServer

Pour installer le module SqlServer à partir de PowerShell Gallery, démarrez une session PowerShell et exécutez Install-Module SQLServer.

Install-Module -Name SqlServer

Si vous êtes sur Windows PowerShell, vous pouvez utiliser Install-Module SQLServer -Scope CurrentUser pour installer le module juste pour l’utilisateur actuel et éviter d’avoir besoin d’autorisations élevées.

Installer le module SqlServer pour tous les utilisateurs

Pour installer le module SqlServer pour tous les utilisateurs, exécutez la commande ci-dessous dans une session PowerShell avec élévation de privilèges ; démarrez une session PowerShell en tant qu’administrateur :

Install-Module -Name SqlServer

Installer le module SqlServer sur un ordinateur hors connexion

Cette section vous guide tout au long des étapes d’installation du module SqlServer PowerShell sur un ordinateur qui n’a pas accès à Internet. Vous avez besoin de deux ordinateurs pour effectuer cette installation : un ordinateur connecté à Internet et l’ordinateur de destination qui est hors connexion (et non connecté à Internet).

  1. Sur un ordinateur connecté à Internet, téléchargez le module SQLServer PowerShell. Cette commande télécharge et enregistre tous les fichiers du module dans l’échantillon de dossier $env:TEMP\SQLServer\<SomeVersion>, qui est défini dans le paramètre -Path. Vous pouvez choisir un dossier de votre choix comme destination sur votre ordinateur connecté à Internet.

    Save-Module -Name SqlServer -Path $env:TEMP
    
  2. Accédez à l’emplacement du dossier dans Explorateur de fichiers pour vérifier qu’un dossier $env:TEMP\SQLServer\<SomeVersion> existe ou exécutez cette commande :

    Get-ChildItem -Path $env:TEMP\SQLServer\
    
  3. Copiez le dossier $env:TEMP\SQLServer\<SomeVersion> que vous avez trouvé à l’étape 2 de l’ordinateur hors connexion de destination dans le dossier %ProgramFiles%\WindowsPowerShell\Modules\SqlServer (ce dossier fonctionne à la fois pour PS5 et PS7). Veillez à remplacer <SomeVersion> par la valeur que vous avez trouvée à l’étape précédente.

  4. Vérifiez que le module SqlServer PowerShell est disponible sur l’ordinateur hors connexion en exécutant la cmdlet PowerShell suivante :

    Get-Module SqlServer -ListAvailable
    

    La sortie peut ressembler à ceci (la version réelle peut être différente et doit correspondre <SomeVersion> répertorié précédemment) :

       PS C:\Users\user1> Get-Module SqlServer -ListAvailable
    
           Directory: C:\Program Files\WindowsPowerShell\Modules
    
       ModuleType Version    Name                     ExportedCommands
       ---------- -------    ----                     ----------------
       Script     22.1.1     SqlServer                {Add-RoleMember, Add-SqlAvail...
    

Afficher les versions du module SqlServer installées

Exécutez la commande suivante pour afficher les versions du module SqlServer qui ont été installées

Get-Module SqlServer -ListAvailable

Pour afficher la version du module SqlServer chargé dans la session active

(Get-Module SqlServer).Version

Remplacer une version précédente du module SqlServer

Vous pouvez également utiliser la commande Install-Module pour remplacer une version précédente.

Install-Module -Name SqlServer -AllowClobber

Notes

PowerShell utilise toujours le dernier module installé.

Mettre à jour la version installée du module SqlServer

Quand des versions mises à jour du module SqlServer sont disponibles, vous pouvez installer la dernière version à l’aide de la commande suivante :

Update-Module -Name SqlServer -AllowClobber

Vous pouvez utiliser la commande Update-Module pour installer la version la plus récente du module SQL Server PowerShell, mais cela ne supprime pas les versions antérieures. Cette commande installe la version la plus récente côte à côte pour vous permettre de tester la version la plus récente en conservant les anciens modules installés.

Toutefois, si vous ne souhaitez pas conserver les anciennes versions du module, vous pouvez utiliser la commande Uninstall-Module pour supprimer les versions précédentes.

Vous pouvez utiliser la commande suivante pour répertorier les différentes versions installées :

Get-Module SqlServer -ListAvailable

Vous pouvez utiliser la commande suivante pour supprimer les anciennes versions :

Uninstall-module -Name SQLServer -RequiredVersion "<version number>"

Dépanner

Si vous rencontrez des problèmes d’installation, consultez la documentation sur Install-Module et les informations de référence sur Install-Module.

Utiliser une version spécifique du module SqlServer

Pour utiliser une version spécifique du module, importez-la avec un numéro de version spécifique comme dans la commande suivante :

Import-Module SqlServer -Version 21.1.18218

Versions préliminaires du module SqlServer

Les versions préliminaires (ou « préversions ») du module SqlServer peuvent être disponibles dans PowerShell Gallery.

Important

Vous pouvez découvrir et installer ces versions à l’aide des applets de commande Find-Module et Install-Module mises à jour (qui font partie du module PowerShellGet) en passant le commutateur - AllowPrerelease. Pour utiliser ces applets de commande, installez le module PowerShellGet, puis ouvrez une nouvelle session.

Découvrir des versions préliminaires du module SqlServer

Pour découvrir les versions préliminaires (préversions) du module SqlServer, exécutez la commande suivante :

Find-Module SqlServer -AllowPrerelease

Installer une version préliminaire spécifique du module SqlServer

Pour installer une version préliminaire spécifique du module, installez-la avec un numéro de version spécifique.

Vous pouvez essayer d’utiliser la commande suivante :

Install-Module SqlServer -RequiredVersion 21.1.18218-preview -AllowPrerelease

SQL Server PowerShell sur Linux

Visitez Gérer SQL Server sur Linux avec PowerShell pour savoir comment installer SQL Server PowerShell sur Linux.

Autres modules

  • Az.Sql : applets de commande du service SQL pour Azure Resource Manager dans Windows PowerShell et PowerShell.

  • SqlServerDsc : module avec des ressources DSC pour le déploiement et la configuration de Microsoft SQL Server.

Référence des applets de commande

Étapes suivantes