PowerShellモジュールのインストール、インポート、管理方法を徹底解説！初心者向けガイドと演習問題付き

PowerShellモジュールとは？

PowerShellモジュールは、複数のコマンドレット（Cmdlet）、関数、変数、エイリアスをまとめたパッケージです。

これにより、特定のタスクを簡単に実行できるようになります。

たとえば、Active DirectoryやAzure、Exchangeの管理など、目的に応じたモジュールが豊富に提供されています。

モジュールは、ローカルマシンにインストールすることで利用可能となり、適切にインポートすることで、セッション内でその機能を利用できます。

# モジュールファイル: MyModule.psm1

# 関数の定義
function Get-Greeting {
    param(
        [string]$Name = "World"
    )
    return "Hello, $Name!"
}

function Get-Farewell {
    param(
        [string]$Name = "World"
    )
    return "Goodbye, $Name!"
}

# エクスポートする関数の指定
Export-ModuleMember -Function Get-Greeting, Get-Farewell

# モジュールマニフェストファイル: MyModule.psd1

@{
    ModuleName = 'MyModule'
    ModuleVersion = '1.0.0'
    ExportedFunctions = @('Get-Greeting', 'Get-Farewell')
    # その他の設定
}

PowerShellギャラリーからのモジュールのインストール

モジュールのインストールは、PowerShellギャラリー（PowerShell Gallery）というオンラインリポジトリから行うのが一般的です。

ギャラリーには数千のモジュールが公開されており、必要なモジュールを簡単に検索してインストールできます。

インストール手順

PowerShellギャラリーからのモジュール検索

PowerShellギャラリーからモジュールを検索するには、Find-Moduleコマンドを使用します。

たとえば、Azure関連のモジュールを探す場合は以下のようにします。

Find-Module -Name Azure*

このコマンドで「Azure」関連のモジュールが一覧表示されます。

モジュールのインストール

モジュールをインストールするには、Install-Moduleコマンドを使用します。

たとえば、「Az」モジュールをインストールするには以下のコマンドを実行します。

Install-Module -Name Az -AllowClobber -Force

• -AllowClobber オプションは、既存のコマンドレットと競合する場合でも上書きすることを許可します。
• -Force オプションは、確認をスキップしてインストールを強制します。

信頼されていないリポジトリへの対応

インストールの際に、信頼されていないリポジトリからモジュールをインストールするかどうかを確認するメッセージが表示されることがあります。

その場合、以下のメッセージが表示されます。

Untrusted repository
You are installing the modules from an untrusted repository. Are you sure you want to install the modules from 'PSGallery'?

これに対して「Y」を入力し、続行してください。

モジュールのインポート

インストールが完了したモジュールは、そのままでは使用できません。

まずはインポートする必要があります。

インポートすると、そのモジュール内のコマンドレットや機能が使用可能になります。

インポート手順

モジュールのインポート

Import-Moduleコマンドを使用して、モジュールをインポートします。

たとえば、Azモジュールをインポートするには以下のコマンドを実行します。

Import-Module -Name Az

モジュールをインポートすると、そのモジュール内のコマンドを使えるようになります。

自動インポート

PowerShellの最新バージョンでは、モジュールの自動インポート機能があります。

モジュールがインストールされている場合、該当モジュール内のコマンドを実行すると、自動的にインポートされます。

しかし、Import-Moduleコマンドで明示的にインポートする方が確実です。

インポート済みモジュールの確認

現在インポートされているモジュールを確認するには、Get-Moduleコマンドを使用します。

Get-Module

これにより、現在のセッションでインポートされているモジュールのリストが表示されます。

モジュールの管理

PowerShellでは、モジュールのバージョン管理やアンインストールなど、管理が重要な要素となります。

モジュールのバージョン確認

モジュールのバージョンを確認するには、Get-ModuleまたはGet-InstalledModuleコマンドを使用します。

Get-InstalledModule -Name Az

これにより、インストールされている「Az」モジュールのバージョンが表示されます。

モジュールの更新

モジュールは定期的に更新されるため、最新バージョンにアップデートすることが推奨されます。

モジュールの更新には、Update-Moduleコマンドを使用します。

Update-Module -Name Az

これにより、最新バージョンがPowerShellギャラリーから取得されます。

モジュールのアンインストール

不要になったモジュールはアンインストールできます。

Uninstall-Moduleコマンドを使用します。

Uninstall-Module -Name Az

これで、ローカルマシンから「Az」モジュールが削除されます。

PowerShellプロファイルへのモジュールの追加

毎回手動でモジュールをインポートするのは面倒なため、PowerShellプロファイルにモジュールのインポートを追加することができます。

PowerShellプロファイルとは、PowerShellを起動するたびに自動的に実行されるスクリプトファイルのことです。

プロファイルの作成

まず、プロファイルが存在するかを確認します。

プロファイルがない場合は作成する必要があります。

if (!(Test-Path -Path $PROFILE)) {
    New-Item -Type File -Path $PROFILE -Force
}

モジュールの自動インポート設定

プロファイルファイルを編集し、使用したいモジュールを自動的にインポートするコマンドを追加します。

以下のように記述します。

Import-Module -Name Az

このスクリプトをプロファイルに保存すれば、PowerShellを起動するたびに「Az」モジュールが自動的にインポートされるようになります。

Add-PSSnapin SnapinName

Get-PSSnapin -Registered

Find-Module -Name AzureAD

Install-Module -Name AzureAD -AllowClobber -Force

Import-Module -Name AzureAD

Get-InstalledModule -Name AzureAD

if (!(Test-Path -Path $PROFILE)) {
    New-Item -Type File -Path $PROFILE -Force
}

Add-Content -Path $PROFILE -Value "Import-Module -Name AzureAD"