SQL Server PowerShell モジュールをインストールする

適用対象: はいSQL Server (サポートされているすべてのバージョン) はいAzure SQL データベース はいAzure SQL Managed Instance はいAzure Synapse Analytics はいParallel Data Warehouse

この記事は、SqlServer PowerShell モジュールをインストールする手順を説明しています。

SQL Server 用の PowerShell モジュール

2 つの SQL Server PowerShell モジュールがあります。

  • SqlServer: SqlServer モジュールには、最新の SQL 機能をサポートする新しいコマンドレットが含まれています。 モジュールには、SQLPS 内のコマンドレットの更新バージョンも含まれています。 SqlServer モジュールをダウンロードするには、PowerShell ギャラリーの SqlServer モジュールにアクセスします。

  • SQLPS: SQLPS は、SQL Agent によって、PowerShell サブシステムを使用してエージェント ジョブ ステップでエージェント ジョブを実行するために使用されるモジュールです。

注意

PowerShell ギャラリーの SqlServer モジュールのバージョンは、バージョン管理をサポートし、PowerShell バージョン 5.0 以降が必要です。

ヘルプ トピックについては、次を参照してください。

  • SqlServer のコマンドレット。
  • SQLPS のコマンドレット。

SQL Server Management Studio

SQL Server Management Studio (SSMS) では、どちらの PowerShell モジュールもインストールされません。 PowerShell を SSMS で使用するには、SqlServer モジュールを PowerShell ギャラリーからインストールします。

注意

SSMS 16.x では、前のバージョンの SqlServer モジュールが SQL Server Management Studio (SSMS) に含まれています

Azure Data Studio

Azure Data Studio では、どちらの PowerShell モジュールもインストールされません。 PowerShell を Azure Data Studio で使用するには、SqlServer モジュールを PowerShell ギャラリーからインストールします。

PowerShell 拡張機能を使用できます。これにより、Azure Data Studio に高機能な PowerShell エディターのサポートが提供されます。

SqlServer モジュールのインストールまたは更新

PowerShell ギャラリーから SqlServer モジュールをインストールするには、PowerShell セッションを管理者として開始します。 管理者として Azure Data Studio を開始し、統合ターミナルの PowerShell セッションでこれらのコマンドを実行することもできます。

さらに、Install-Module SQLServer -Scope CurrentUser を使用して、管理者特権のアクセス許可を実行することもできます。 このコマンドレットは、環境の管理者ではないユーザーに役立ちます。 ただし、スコープは現在のユーザーに制限されるため、同じコンピューター上の他のユーザーはモジュールを使用できません。

SqlServer モジュールをインストールする

すべてのユーザー用に SqlServer モジュールをインストールするには、PowerShell セッションで次のコマンドを実行します。

Install-Module -Name SqlServer

インストールされている SqlServer モジュールのバージョンを表示するには

インストールされている SqlServer モジュールのバージョンを確認するには、次のコマンドを実行します。

Get-Module SqlServer -ListAvailable

管理者としてではなく、現在のユーザー用にインストールする

管理者として PowerShell セッションを実行できない場合は、次のコマンドを使用して現在のユーザー用にインストールします。

Install-Module -Name SqlServer -Scope CurrentUser

SqlServer モジュールの前のバージョンを上書きするには

Install-Module コマンドを使用して、前のバージョンを上書きすることもできます。

Install-Module -Name SqlServer -AllowClobber

注意

PowerShell では、インストールされている最新のモジュールが常に使用されます。

SqlServer モジュールのインストールされているバージョンを更新する

SqlServer モジュールの更新されたバージョンを使用できる場合は、次のコマンドを使用して新しいバージョンをインストールできます。

Install-Module -Name SqlServer -AllowClobber

Update-Module コマンドを使用して、SQLServer PowerShell モジュールの最新バージョンをインストールできますが、古いバージョンは削除されません。 新しいバージョンをサイドバイサイドでインストールすることで、古いモジュールをインストールしたまま、最新バージョンを試すことができます。

ただし、古いバージョンのモジュールを保持しない場合は、Uninstall-Module コマンドを使用して前のバージョンを削除できます。

次のコマンドを使用して、複数のバージョンがインストールされているかどうかを一覧表示できます。

Get-Module SqlServer -ListAvailable

次のコマンドを使用して、古いバージョンを削除できます。

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

トラブルシューティング

インストールに問題が発生した場合は、Install-module のドキュメントInstall-Module の参照をご覧ください。

SqlServer モジュールの特定のバージョンの使用

モジュールの特定のバージョンを使用するには、次のようなコマンドで、特定のバージョン番号を指定してインポートできます。

Import-Module SqlServer -Version 21.1.18218

SqlServer モジュールのプレリリース版

SqlServer モジュールのプレリリース ("プレビュー") 版は、PowerShell ギャラリーで入手できます。

重要

PowerShellGet モジュールの一部である更新された Find-Module コマンドレットと Install-Module コマンドレットを使用して -AllowPrerelease スイッチを渡すことで、これらのバージョンを検出してインストールできます。 これらのコマンドレットを使用するには、PowerShellGet モジュールをインストールしてから、新しいセッションを開きます。

SqlServer モジュールのプレリリース版を検出するには

SqlServer モジュールのプレリリース (プレビュー) 版を検出するには、次のコマンドを実行できます。

Find-Module SqlServer -AllowPrerelease

SqlServer モジュールの特定のプレリリース版をインストールするには

モジュールの特定のプレリリース版をインストールするには、特定のバージョン番号を指定してインストールします。

次のコマンドの使用を試すことができます。

Install-Module SqlServer -RequiredVersion 21.1.18218-preview -AllowPrerelease

SQL Server PowerShell on Linux

SQL Server PowerShell on Linux をインストールする方法については、「PowerShell Core で SQL Server on Linux を管理する」を参照してください。

その他のモジュール

  • Az.Sql - Windows PowerShell と PowerShell Core の Azure Resource Manager 用 SQL サービス コマンドレット。

  • SqlServerDsc - Microsoft SQL Server のデプロイと構成用の DSC リソースを含むモジュール。

コマンドレット リファレンス

次のステップ