← Back to Home

PowerShellモジュールの作成：ステップバイステップガイド

Views: 1031

You can try the commands on our interactive shell.

PowerShellモジュールの作成：ステップバイステップガイド

PowerShellモジュールは、再利用可能なパッケージ化された機能セットです。これでスクリプティングタスクを簡単にし、ストリーミンイングできます。このチュートリアルでは、PowerShellモジュールを作成するプロセスについて説明します。

前提

作成する前に、以下のことが必要です：

モジュールの作成

モジュールを作成するには、次のような手順を踏みます。

  1. 新しいフォルダーを作成: 望ましい場所に、新しいフォルダーを作成します。これは、モジュールのファイルが格納されるルートディレクトリーです。
  2. モジュールマニフェストの作成: モジュールフォルダー内に、新しいファイルを作成してください。このファイルには、モジュールに関する基本的な情報や、その内容を記述します。

例えば、module.xml ファイルは次のように書きます：

<?xml version="1.0" encoding="utf-8"?>
<assembly xmlns="http://schemas.microsoft.com/microsoftpscore/2014/04/module">
  <root>
    <manifest>
      <name>MyModule</name>
      <version>1.0</version>
      <author>Your Name</author>
      <description>A brief description of your module</description>
    </manifest>
    <files>
      <file src="functions\*.ps1" dest="functions"/>
      <file src="scripts\script.ps1" dest="scripts"/>
    </files>
  </root>
</assembly>

このファイルでは、モジュールの名前、バージョン、アウター、および説明を定義しています。また、その内容（functionやスクリプトなど）も指定しています。

モジュールコードの書き方

次に、モジュールコード自身を書く必要があります。これには、関数、スクリプト、PowerShellコードなどが含まれます。

例えば、簡単な関数が次のように書けます：

function Get-Today'sDate {
  [datetime]::Today
}

この関数は、現在の日時を返します。より多くの関数やスクリプトなどを追加できます。

モジュールのパッケージング

コードを書いた後、モジュールを単一のファイルにパッケージングする必要があります。

このため、New-Module コマンドレットを使用して、新しいモジュールを作成します：

New-Module -Name MyModule -Path .\MyModule -RootDir .

このコマンドは、新しいモジュール MyModule を作成し、現在のディレクトリーに配置します。 -Path パラメーターには、モジュールのファイルが格納される場所を指定し、 -RootDir パラメーターには、モジュールのルートディレクトリーを設定します。

モジュールのパブリッシング

モジュールを他の機械に共有したい場合、PowerShellギャラリー oder NuGet などのパッケージマネージャーに公開することができます。

モジュールをパブリッシュするには、以下のような手順を踏みます。

  1. psd1 ファイルの作成: モジュールのルートディレクトリー内に、新しいファイルを作成してください。このファイルは、PowerShell スクリプトファイルであり、モジュールを定義します。
  2. psd1 ファイルにメタデータを追加: psd1 ファイルに、モジュールに関する基本的な情報を追加します： powershell @{ ModuleName = 'MyModule' ModuleVersion = '1.0' Guid = 'your-guid-goes-here' Author = 'Your Name' Copyright = '(c) 2023 Your Company' Description = 'A brief description of your module' } このメタデータは、モジュールとその内容を説明します。 3. モジュールのパブリッシュ: Publish-Module コマンドレットを使用して、モジュールをパブリッシュします： powershell Publish-Module -Path .\MyModule -Name MyModule -Repository PSGallery このコマンドは、PowerShellギャラリーにモジュールを公開します。

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

モジュールをパブリッシュした後、その他の機械でインストールすることができます。

インストールするには、Install-Module コマンドレットを使用してください：

Install-Module -Name MyModule -Repository PSGallery

このコマンドは、PowerShellギャラリーからモジュールをインストールします。

結論

PowerShell モジュールを作成することは、コードを共有し、スクリプティングタスクを簡単化するための良い方法です。このチュートリアルでは、PowerShell モジュールを作成するプロセスについて説明しました。次に作成したモジュールを使って、スクリプティングタスクを簡単化できます！

Try it Now!