Save-Module

モジュールとその依存関係をローカル コンピューターに保存しますが、モジュールはインストールされません。

構文

Save-Module
    [-Name] <String[]>
    [-MinimumVersion <String>]
    [-MaximumVersion <String>]
    [-RequiredVersion <String>]
    [-Repository <String[]>]
    [-Path] <String>
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-Credential <PSCredential>]
    [-Force]
    [-AllowPrerelease]
    [-AcceptLicense]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Save-Module
    [-Name] <String[]>
    [-MinimumVersion <String>]
    [-MaximumVersion <String>]
    [-RequiredVersion <String>]
    [-Repository <String[]>]
    -LiteralPath <String>
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-Credential <PSCredential>]
    [-Force]
    [-AllowPrerelease]
    [-AcceptLicense]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Save-Module
    [-InputObject] <PSObject[]>
    -LiteralPath <String>
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-Credential <PSCredential>]
    [-Force]
    [-AcceptLicense]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Save-Module
    [-InputObject] <PSObject[]>
    [-Path] <String>
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-Credential <PSCredential>]
    [-Force]
    [-AcceptLicense]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

コマンドレットは Save-Module 、登録済みリポジトリからモジュールと依存関係をダウンロードします。 Save-Module モジュールの最新バージョンをダウンロードして保存します。 ファイルは、ローカル コンピューター上の指定したパスに保存されます。 モジュールはインストールされていませんが、内容は管理者が検査できます。 その後、保存したモジュールをオフライン コンピューターの適切な $env:PSModulePath 場所にコピーできます。

Get-PSRepository には、ローカル コンピューターの登録済みリポジトリが表示されます。 コマンドレットを Find-Module 使用して、登録済みリポジトリを検索できます。

モジュールのバージョン番号を受け取るパラメーターでは、バージョン番号として書式設定された文字列が必要です。

  • 標準バージョン番号の形式 x.y.z は x、y、z は数値です
  • プレリリースバージョンには、 がそのリリースに割り当てられた任意のx.y.z-<prerelease_label><prerelease_label>文字列である という形式があります。

例 1: モジュールを保存する

この例では、モジュールとその依存関係がローカル コンピューターに保存されます。

Save-Module -Name PowerShellGet -Path C:\Test\Modules -Repository PSGallery
Get-ChildItem -Path C:\Test\Modules

Directory: C:\Test\Modules

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----         7/1/2019     13:31                PackageManagement
d-----         7/1/2019     13:31                PowerShellGet

Save-Module では、 Name パラメーターを使用してモジュール PowerShellGet を指定します。 Path パラメーターは、ダウンロードしたモジュールを格納する場所を指定します。 Repository パラメーターは、登録されているリポジトリ PSGallery を指定します。 ダウンロードが完了すると、 Get-ChildItem ファイルが格納されている Path の内容が表示されます。

例 2: モジュールの特定のバージョンを保存する

この例では、 MaximumVersionRequiredVersion などのパラメーターを使用してモジュールのバージョンを指定する方法を示します。

Save-Module -Name PowerShellGet -Path C:\Test\Modules -Repository PSGallery -MaximumVersion 2.1.0
Get-ChildItem -Path C:\Test\Modules\PowerShellGet\

Directory: C:\Test\Modules\PowerShellGet

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----         7/1/2019     13:40                2.1.0

Save-Module では、 Name パラメーターを使用してモジュール PowerShellGet を指定します。 Path パラメーターは、ダウンロードしたモジュールを格納する場所を指定します。 Repository パラメーターは、登録されているリポジトリ PSGallery を指定しますMaximumVersion は、バージョン 2.1.0 をダウンロードして保存することを指定します。 ダウンロードが完了すると、 Get-ChildItem ファイルが格納されている Path の内容が表示されます。

例 3: モジュールの特定のバージョンを検索して保存する

この例では、必要なモジュール バージョンがリポジトリに見つかり、ローカル コンピューターに保存されます。

Find-Module -Name PowerShellGet -Repository PSGallery -RequiredVersion 1.6.5 |
  Save-Module -Path C:\Test\Modules
Get-ChildItem -Path C:\Test\Modules\PowerShellGet

Directory: C:\Test\Modules\PowerShellGet

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----         7/1/2019     14:04                1.6.5

Find-Module では、 Name パラメーターを使用してモジュール PowerShellGet を指定します。 Repository パラメーターは、登録されているリポジトリ PSGallery を指定しますRequiredVersion はバージョン 1.6.5 を指定します。

オブジェクトは、パイプラインから に Save-Module送信されます。 Path パラメーターは、ダウンロードしたモジュールを格納する場所を指定します。 ダウンロードが完了すると、 Get-ChildItem ファイルが格納されている Path の内容が表示されます。

パラメーター

-AcceptLicense

パッケージで必要な場合は、使用許諾契約書に自動的に同意します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AllowPrerelease

プレリリースとしてマークされたモジュールを保存できます。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

を実行する前に確認を求めるメッセージが表示されます Save-Module

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

モジュールを保存する権限を持つユーザー アカウントを指定します。

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Force

Path パラメーターで指定された場所が存在しない場合、コマンドレットはエラーを返します。 Force パラメーターを使用すると、ターゲット パスが作成されます。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

PSRepositoryItemInfo オブジェクトを受け入れます。 たとえば、変数に出力 Find-Module し、その変数を InputObject 引数として使用します。

Type:PSObject[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LiteralPath

1 つ以上の場所へのパスを指定します。 LiteralPath パラメーターの値は、入力したとおりに使用されます。 ワイルドカードとして解釈される文字はありません。 パスにエスケープ文字が含まれている場合は、それらを単一引用符で囲みます。 PowerShell では、単一引用符で囲まれた文字はエスケープ シーケンスとして解釈されません。

Type:String
Aliases:PSPath
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-MaximumVersion

保存するモジュールの最大バージョン (最新) を指定します。 MaximumVersion パラメーターと RequiredVersion パラメーターは、同じコマンドでは使用できません。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-MinimumVersion

保存する 1 つのモジュールの最小バージョンを指定します。 複数のモジュールをインストールしようとしている場合は、このパラメーターを追加できません。 MinimumVersion パラメーターと RequiredVersion パラメーターは、同じコマンドでは使用できません。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

保存するモジュールの名前の配列を指定します。

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

保存されたモジュールを格納するローカル コンピューター上の場所を指定します。 ワイルドカード文字を受け入れます。

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-Proxy

インターネット リソースに直接接続するのではなく、要求のプロキシ サーバーを指定します。

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ProxyCredential

Proxy パラメーターに指定したプロキシ サーバーを使用するアクセス許可を持つユーザー アカウントを指定します。

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Repository

を実行 Register-PSRepositoryして登録されたリポジトリのフレンドリ名を指定します。 を使用して Get-PSRepository 、登録済みリポジトリを表示します。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-RequiredVersion

保存するモジュールの正確なバージョン番号を指定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

が実行された場合の動作を Save-Module 示します。 コマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

String[]

PSObject[]

String

Uri

PSCredential

出力

Object

メモ

重要

2020 年 4 月時点で、PowerShell ギャラリーでは、トランスポート層セキュリティ (TLS) バージョン 1.0 および 1.1 がサポートされなくなります。 TLS 1.2 以降を使用していない場合、PowerShell ギャラリーにアクセスしようとするとエラーが発生します。 次のコマンドを使用して、確実に TLS 1.2 を使用するようにします。

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

詳細については、PowerShell ブログのお知らせを参照してください。