ライセンスへの同意が必要なモジュール

  • [アーティクル]

概要

モジュールの発行元によっては、法務部門から顧客に対し、PowerShell ギャラリーのモジュールをインストールする前にライセンスに明示的に同意するよう求める場合があります。 ユーザーが、直接的か別のパッケージとの依存関係としてかにかかわらず、PowerShellGet を使用してモジュールのインストール、更新、または保存を行うときに、そのモジュールでユーザーにライセンスへの同意が求められている場合、ユーザーはライセンスに同意することを示す必要があります。そうしないと、操作は失敗します。

モジュールの発行要件

ユーザーにライセンスへの同意を求めるモジュールでは、次の要件を満たす必要があります。

  • モジュール マニフェストの PSData セクションに「RequireLicenseAcceptance = $True」と記載する。
  • モジュールのルート ディレクトリに license.txt ファイルを含める。
  • モジュール マニフェストにライセンス URI を記載する。
  • PowerShellGet のフォーマット バージョン 2.0 以降を使用してモジュールを公開する。

Install/Save/Update-Module に対する影響

  • Install、Save、Update コマンドレットでは、ユーザーがライセンスを確認した場合と同じ動作をする新しいパラメーター AcceptLicense がサポートされています。
  • RequiredLicenseAcceptance が True で、AcceptLicense が指定されていない場合、ユーザーには license.txt が表示され、次のプロンプトが表示されます: Do you accept these license terms (Yes/No/YesToAll/NoToAll)。
    • ライセンスに同意した場合:
      • Save-Module: ユーザーのシステムにモジュールがコピーされます
      • Install-Module: (スコープに基づいて) ユーザーのシステムの適切なフォルダーにモジュールがコピーされます
      • Update-Module: モジュールが更新されます。
    • ライセンスを拒否した場合:
      • 操作は取り消されます。
      • すべてのコマンドレットで、ライセンスへの同意が必要であることを示すメタデータ (requireLicenseAcceptance および形式のバージョン) が確認されます
      • クライアントの形式のバージョンが 2.0 よりも前の場合、操作は失敗し、ユーザーはクライアントを更新するように求められます。
      • 2\.0 よりも前の形式のバージョンを使用してモジュールが発行されている場合、requireLicenseAcceptance フラグは無視されます。

モジュールの依存関係

  • インストール/保存/更新操作中に、依存モジュール (目的のモジュールに依存する別のモジュール) でライセンスへの同意が求められた場合、上記のライセンスへの同意が必要です。
  • 該当するモジュールのバージョンがシステムへインストール済みであるとローカル カタログに記載されている場合、このライセンス チェックは省略されます。
  • インストール/保存/更新操作中に、依存モジュールでライセンスが必要とされ、ライセンスへの同意が行われなかった場合、操作は失敗し、インストール/保存/更新が失敗したパッケージに対して通常の処理が行われます。

-Force に対する影響

–Force を指定しても、ライセンスへの同意は行われません。 インストールを行うには、–AcceptLicense を指定する必要があります。 –Force を指定した場合に、RequiredLicenseAcceptance が True であり –AcceptLicense を指定していないと、操作は失敗します。

例

例 1: ライセンスへの同意を求めるようにモジュール マニフェストを更新する

Update-ModuleManifest -Path C:\modulemanifest.psd1 -RequireLicenseAcceptance -PrivateData @{
    PSData = @{
        # Flag to indicate whether the module requires explicit user acceptance
        RequireLicenseAcceptance = $true
    } # End of PSData hashtable

 } # End of PrivateData hashtable

次のコマンドでは、マニフェスト ファイルを更新して RequireLicenseAcceptance フラグを True に設定します。

例 2: ライセンスへの同意が必要なモジュールをインストールする

Install-Module -Name ModuleRequireLicenseAcceptance

License Acceptance

License 2.0
Copyright (c) 2016 PowerShell Team
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software.

Do you accept the license terms for module 'ModuleRequireLicenseAcceptance'.
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "N"):

次のコマンドでは、license.txt ファイルのライセンスが表示され、このライセンスへの同意がユーザーに求められます。

例 3: -AcceptLicense を使用してライセンスへの同意が必要なモジュールをインストールする

Install-Module -Name ModuleRequireLicenseAcceptance -AcceptLicense

ライセンスへの同意を求めることなく、モジュールがインストールされます。

例 4: -Force を使用してライセンスへの同意が必要なモジュールをインストールする

Install-Module -Name ModuleRequireLicenseAcceptance -Force

PackageManagement\Install-Package : License Acceptance is required for module 'ModuleRequireLicenseAcceptance'. Please specify '-AcceptLicense' to perform this operation.
At C:\Program Files\WindowsPowerShell\Modules\PowerShellGet\1.1.3.3\PSModule.psm1:1837 char:21
+ ...          $null = PackageManagement\Install-Package @PSBoundParameters
+                      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidArgument: (Microsoft.Power....InstallPackage:InstallPackage) [Install-Package], E
   xception
    + FullyQualifiedErrorId : ForceAcceptLicense,Install-PackageUtility,Microsoft.PowerShell.PackageManagement.Cmdlets
   .InstallPackage

例 5: ライセンスへの同意が必要な依存関係があるモジュールをインストールする

モジュール ModuleWithDependency はモジュール ModuleRequireLicenseAcceptance に依存しています。 ユーザーにはライセンスへの同意が求められます。

Install-Module -Name ModuleWithDependency

License Acceptance
MIT License 2.0
Copyright (c) 2016 PowerShell Team
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software.

Do you accept the license terms for module 'ModuleRequireLicenseAcceptance'.
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "N"):

例 6: -AcceptLicense を使用してライセンスへの同意が必要な依存関係があるモジュールをインストールする

モジュール ModuleWithDependency はモジュール ModuleRequireLicenseAcceptance に依存しています。 AcceptLicense を指定したため、ユーザーにライセンスへの同意は求められません。

Install-Module -Name ModuleWithDependency -AcceptLicense

例 7: PSGetFormatVersion 2.0 以前のクライアントでライセンスへの同意が必要なモジュールをインストールする

Install-Module -Name ModuleRequireLicenseAcceptance

WARNING: The specified module 'ModuleRequireLicenseAcceptance' with PowerShellGetFormatVersion
'2.0' is not supported by the current version of PowerShellGet. Get the latest version of the
PowerShellGet module to install this module, 'ModuleRequireLicenseAcceptance'.

例 8: ライセンスへの同意が必要なモジュールを保存する

Save-Module -Name ModuleRequireLicenseAcceptance -Path C:\Saved

License Acceptance

License 2.0
Copyright (c) 2016 PowerShell Team
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software.

Do you accept the license terms for module 'ModuleRequireLicenseAcceptance'.
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "N"):

次のコマンドでは、license.txt ファイルのライセンスが表示され、このライセンスへの同意がユーザーに求められます。

例 9: -AcceptLicense を使用してライセンスへの同意が必要なモジュールを保存する

Save-Module -Name ModuleRequireLicenseAcceptance -AcceptLicense -Path C:\Saved

ライセンスへの同意を求めることなく、モジュールが保存されます。

例 10: ライセンスへの同意が必要なモジュールを更新する

Update-Module -Name ModuleRequireLicenseAcceptance

License Acceptance

License 2.0
Copyright (c) 2016 PowerShell Team
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software.

Do you accept the license terms for module 'ModuleRequireLicenseAcceptance'.
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "N"):

次のコマンドでは、license.txt ファイルのライセンスが表示され、このライセンスへの同意がユーザーに求められます。

例 11: -AcceptLicense を使用してライセンスへの同意が必要なモジュールを更新する

Update-Module -Name ModuleRequireLicenseAcceptance -AcceptLicense

ライセンスへの同意を求めることなく、モジュールが更新されます。

詳細

スクリプトのライセンス同意リクエスト

PowerShellGallery でのライセンス同意リクエストのサポート

Azure Automation へのデプロイに表示されるライセンス同意リクエスト