Update-Help

モジュール:: Microsoft.PowerShell.Core Module

コンピューターに最新のヘルプファイルをダウンロードしてインストールします。

構文

Path (既定)

Update-Help
    [[-Module] <String[]>]
    [[-SourcePath] <String[]>]
    [[-UICulture] <CultureInfo[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [-Recurse]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-Force]
    [-Scope <UpdateHelpScope>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

LiteralPath

Update-Help
    [[-Module] <String[]>]
    [[-UICulture] <CultureInfo[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [-LiteralPath <String[]>]
    [-Recurse]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-Force]
    [-Scope <UpdateHelpScope>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

Update-Help コマンドレットは、PowerShell モジュールの最新のヘルプファイルをダウンロードし、コンピューターにインストールします。変更を有効にするために PowerShell を再起動する必要はありません。 Get-Help コマンドレットを使用すると、新しいヘルプファイルをすぐに表示できます。

Update-Help は、コンピューター上のヘルプファイルのバージョンを確認します。モジュールのヘルプファイルがない場合、またはヘルプファイルが古い場合は、Update-Help は最新のヘルプファイルをダウンロードします。ヘルプファイルは、インターネットまたはファイル共有からダウンロードしてインストールできます。

パラメーターを指定しない場合、 Update-Help は、セッション内のモジュールと、更新可能ヘルプをサポートするすべてのインストール済みモジュールのヘルプ・ファイルを更新します。インストールされているが、現在のセッションにロードされていないモジュールが含まれます。 PowerShell モジュールは、 $env:PSModulePath 環境変数に一覧表示されている場所に格納されます。詳しくは、「about_Updatable_Help」をご覧ください。

Module パラメーターを使用して、特定のモジュールのヘルプファイルを更新できます。 UICulture パラメーターを使用して、複数の言語とロケールのヘルプファイルをダウンロードします。

インターネットに接続されていないコンピューターでも Update-Help を使用できます。まず、 Save-Helpコマンドレットを使用してインターネットからヘルプファイルをダウンロードし、インターネットに接続されていないシステムからアクセスできる共有フォルダーに保存します。次に、の Update-Help パラメーターを使用して、更新されたヘルプファイルを共有からダウンロードし、コンピューターにインストールします。

PowerShell プロファイルに Update-Help コマンドレットを追加することで、ヘルプの更新を自動化できます。既定では、 Update-Help は各コンピューターで 1 日に 1 回のみ実行されます。 1 日 1 回の制限をオーバーライドするには、 Force パラメーターを使用します。

Update-Help コマンドレットは、Windows PowerShell 3.0 で導入されました。

Von Bedeutung

Update-Help には、PowerShell 6.0 以降の管理特権が必要です。 PowerShell 6.1 以降では、既定の Scope を CurrentUserに設定します。 PowerShell 6.1 より前は、 Scope パラメーターは使用できませんでした。

コア PowerShell モジュールのヘルプファイルを更新するには、コンピューターの Administrators グループのメンバーである必要があります。

PowerShell Core モジュールを含む PowerShell インストールディレクトリ ($PSHOME\Modules) のモジュールのヘルプファイルをダウンロードまたは更新するには、[管理者として実行] オプションを使用して PowerShell を起動します。たとえば、 Start-Process pwsh.exe -Verb RunAsと指定します。

例

例 1: すべてのモジュールのヘルプファイルを更新する

Update-Help コマンドレットは、更新可能なヘルプをサポートするインストール済みモジュールのヘルプファイルを更新します。ユーザーインターフェイス (UI) カルチャ言語は、オペレーティングシステムで設定されます。

Update-Help

例 2: 指定したモジュールのヘルプファイルを更新する

Update-Help コマンドレットは、Microsoft.PowerShell で始まるモジュール名ヘルプファイルのみを更新します。

Update-Help -Module Microsoft.PowerShell*

例 3: 異なる言語のヘルプファイルを更新する

Update-Help コマンドレットは、すべてのモジュールの日本語 (ja-JP) と英語 (en-US) のヘルプファイルを更新します。

モジュールが指定した UI カルチャのヘルプファイルを提供していない場合は、モジュールと UI カルチャのエラーメッセージが表示されます。この例では、エラーメッセージは、モジュール Microsoft.PowerShell.Utility の ja-JP ヘルプファイルが見つからなかったことを示しています。

Update-Help -UICulture ja-JP, en-US

Update-Help : Failed to update Help for the module(s) 'Microsoft.PowerShell.Utility' with UI culture(s) {ja-JP}
No UI culture was found that matches the following pattern: ja-JP.

例 4: ファイル共有から複数のコンピューター上のヘルプファイルを更新する

この例では、更新されたヘルプファイルがインターネットからダウンロードされ、ファイル共有に保存されます。ファイル共有にアクセスして更新プログラムをインストールするためのアクセス許可を持つユーザー資格情報が必要です。ファイル共有を使用すると、ファイアウォールの内側にあるコンピューターやインターネットに接続されていないコンピューターを更新できます。

Save-Help -DestinationPath \\Server01\Share\PSHelp -Credential Domain01\Admin01
Invoke-Command -ComputerName (Get-Content Servers.txt) -ScriptBlock {
     Update-Help -SourcePath \\Server01\Share\PSHelp -Credential Domain01\Admin01
}

Save-Help コマンドは、更新可能なヘルプをサポートするすべてのモジュールの最新のヘルプファイルをダウンロードします。 DestinationPath パラメーターは、\\Server01\Share\PSHelp ファイル共有にファイルを保存します。 Credential パラメーターは、ファイル共有にアクセスする権限を持つユーザーを指定します。

Invoke-Command コマンドレットは、複数のコンピューターでリモート Update-Help コマンドを実行します。 ComputerName パラメーターは、Servers.txt ファイルからリモートコンピューターの一覧を取得します。 ScriptBlock パラメーターは Update-Help コマンドを実行し、SourcePath パラメーターを使用して、更新されたヘルプファイルを含むファイル共有を指定します。 Credential パラメーターは、ファイル共有にアクセスしてリモート Update-Help コマンドを実行できるユーザーを指定します。

例 5: 更新されたヘルプファイルの一覧を取得する

Update-Help コマンドレットは、指定したモジュールのヘルプを更新します。コマンドレットは、Verbose 共通パラメーターを使用して、更新されたヘルプファイルの一覧を表示します。詳細使用して、特定のモジュールのすべてのヘルプファイルまたはヘルプファイルの出力を表示できます。

Verbose パラメーターがないと、Update-Help はコマンドの結果を表示しません。 Verbose パラメーターの出力は、ヘルプファイルが更新されたか、最新バージョンがインストールされているかどうかを確認するのに役立ちます。

Update-Help -Module Microsoft.PowerShell.Utility -Verbose

例 6: 更新可能なヘルプをサポートするモジュールを検索する

この例では、更新可能なヘルプをサポートするモジュールの一覧を示します。このコマンドは、モジュールの HelpInfoUri プロパティを使用して、更新可能なヘルプをサポートするモジュールを識別します。 HelpInfoUri プロパティには、Update-Help コマンドレットの実行時にリダイレクトされるアドレスが含まれています。

Get-Module -ListAvailable | Where-Object -Property HelpInfoUri

   Directory: C:\program files\powershell\6\Modules

ModuleType Version    Name                                PSEdition ExportedCommands
---------- -------    ----                                --------- ----------------
Manifest   6.1.0.0    CimCmdlets                          Core      {Get-CimAssociatedInstance... }
Manifest   1.2.2.0    Microsoft.PowerShell.Archive        Desk      {Compress-Archive... }
Manifest   6.1.0.0    Microsoft.PowerShell.Diagnostics    Core      {Get-WinEvent, New-WinEvent}

    Directory: C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules

ModuleType Version    Name                                PSEdition ExportedCommands
---------- -------    ----                                --------- ----------------
Manifest   2.0.1.0    Appx                                Core,Desk {Add-AppxPackage, ... }
Script     1.0.0.0    AssignedAccess                      Core,Desk {Clear-AssignedAccess, ... }
Manifest   1.0.0.0    BitLocker                           Core,Desk {Unlock-BitLocker, ... }

例 7: 更新されたヘルプファイルのインベントリ

この例では、スクリプト Get-UpdateHelpVersion.ps1 は、各モジュールとそのバージョン番号の更新可能なヘルプファイルのインベントリを作成します。

このスクリプトは、モジュールの HelpInfoUri プロパティを使用して、更新可能なヘルプをサポートするモジュールを識別します。更新可能なヘルプをサポートするモジュールの場合、スクリプトはヘルプ情報ファイル (*helpinfo.xml) を検索して解析し、最新バージョン番号を検索します。

このスクリプトでは、PSCustomObject クラスとハッシュテーブルを使用して、カスタム出力オブジェクトを作成します。

# Get-UpdateHelpVersion.ps1
Param(
    [parameter(Mandatory=$False)]
    [String[]]
    $Module
)
$HelpInfoNamespace = @{helpInfo='http://schemas.microsoft.com/powershell/help/2010/05'}

if ($Module) { $Modules = Get-Module $Module -ListAvailable | where {$_.HelpInfoUri} }
else { $Modules = Get-Module -ListAvailable | where {$_.HelpInfoUri} }

foreach ($mModule in $Modules)
{
    $mDir = $mModule.ModuleBase

    if (Test-Path $mdir\*helpinfo.xml)
    {
        $mName=$mModule.Name
        $mNodes = dir $mdir\*helpinfo.xml -ErrorAction SilentlyContinue |
            Select-Xml -Namespace $HelpInfoNamespace -XPath "//helpInfo:UICulture"
        foreach ($mNode in $mNodes)
        {
            $mCulture=$mNode.Node.UICultureName
            $mVer=$mNode.Node.UICultureVersion

            [PSCustomObject]@{"ModuleName"=$mName; "Culture"=$mCulture; "Version"=$mVer}
        }
    }
}

ModuleName                              Culture                                 Version
----------                              -------                                 -------
ActiveDirectory                         en-US                                   3.0.0.0
ADCSAdministration                      en-US                                   3.0.0.0
ADCSDeployment                          en-US                                   3.0.0.0
ADDSDeployment                          en-US                                   3.0.0.0
ADFS                                    en-US                                   3.0.0.0

パラメーター

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	False
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	cf

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Credential

SourcePath で指定されたファイルシステムの場所にアクセスするアクセス許可を持つユーザー資格情報を指定します。このパラメーターは、SourcePath または LiteralPath パラメーターがコマンドで使用されている場合にのみ有効です。

Credential パラメーターを使用すると、リモートコンピューターで Update-Help パラメーターコマンドを実行できます。明示的な資格情報を指定することで、アクセス拒否エラーが発生したり、CredSSP 認証を使用して資格情報を委任したりすることなく、リモートコンピューターでコマンドを実行し、3 番目のコンピューター上のファイル共有にアクセスできます。

User01 や Domain01\User01などのユーザー名を入力するか、コマンドレットによって生成された Get-Credential オブジェクトを入力します。ユーザー名を入力すると、パスワードの入力を求められます。

資格情報は PSCredential オブジェクトに格納され、パスワードは SecureStringとして格納されます。

注

SecureString データ保護についての詳細は、「SecureString はどのくらい安全ですか？」を参照してください。.

パラメーターのプロパティ

型:	PSCredential
規定値:	Current user
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Force

このコマンドレットが 1 日 1 回の制限に従っていないことを示し、バージョンチェックをスキップし、1 GB の制限を超えるファイルをダウンロードします。

このパラメーターを指定しない場合、Update-Help は 24 時間ごとに 1 回だけ実行されます。ダウンロードはモジュールごとに 1 GB の非圧縮コンテンツに制限され、ヘルプファイルはコンピューター上の既存のファイルよりも新しい場合にのみインストールされます。

1 日に 1 回の制限により、ヘルプファイルをホストするサーバーが保護され、Update-Help コマンドを PowerShell プロファイルに追加する際に、接続やダウンロードの繰り返しのリソースコストを発生させることなく、実用的になります。

Force パラメーターを使用せずに複数の UI カルチャのモジュールのヘルプを更新するには、次のようなすべての UI カルチャを同じコマンドに含めます。

Update-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-FullyQualifiedModule

ModuleSpecification オブジェクトの形式で指定される名前を持つモジュールを指定します。これらのモジュールについては、 ModuleSpecification コンストラクタ (Hashtable) の解説セクションで説明されています。

たとえば、 FullyQualifiedModule パラメーターは、次の形式で指定されるモジュール名を受け入れます。

@{ModuleName = "modulename"; ModuleVersion = "version_number"}

又は

@{ModuleName = "modulename"; ModuleVersion = "version_number"; Guid = "GUID"}.

ModuleName と ModuleVersion は必須ですが、 Guid は省略可能です。

Module パラメーターと同じコマンドで、FullyQualifiedModule パラメーターを指定することはできません。

パラメーターのプロパティ

型:	ModuleSpecification[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-LiteralPath

インターネットからダウンロードするのではなく、更新されたヘルプファイルのフォルダーを指定します。コマンドレットを使用してヘルプファイルをディレクトリにダウンロードした場合は、このパラメーターを使用するか、SourcePath Save-Help します。

Get-Item や Get-ChildItem コマンドレットなどのディレクトリオブジェクトをパイプライン処理して、Update-Helpできます。

SourcePathの値とは異なり、LiteralPath の値は、型指定されたとおりに使用されます。ワイルドカード文字として解釈される文字はありません。パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。単一引用符は、エスケープシーケンスとして文字を解釈しないように PowerShell に指示します。

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	PSPath, LP

パラメーターセット

LiteralPath

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Module

指定したモジュールのヘルプを更新します。コンマ区切りリストに 1 つ以上のモジュール名または名前パターンを入力するか、各行に 1 つのモジュール名をリストするファイルを指定します。ワイルドカード文字を使用できます。 Get-Module コマンドレットから Update-Help コマンドレットにモジュールをパイプライン処理できます。

指定するモジュールはコンピューターにインストールする必要がありますが、現在のセッションにインポートする必要はありません。セッション内の任意のモジュール、または $env:PSModulePath 環境変数にリストされている場所にインストールされている任意のモジュールを指定できます。

値が * (all) の場合、コンピューターにインストールされているすべてのモジュールのヘルプの更新が試行されます。更新可能なヘルプをサポートしていないモジュールが含まれています。この値は、更新可能なヘルプをサポートしていないモジュールがコマンドで検出されたときにエラーが発生する可能性があります。代わりに、パラメーターを指定せずに Update-Help を実行します。

コマンドレットの Update-Help パラメーターは、モジュールファイルまたはモジュールマニフェストファイルの完全なパスを受け入れられません。 $env:PSModulePath の場所にないモジュールのヘルプを更新するには、Update-Help コマンドを実行する前に、モジュールを現在のセッションにインポートします。

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	True
DontShow:	False
Aliases:	名前

パラメーターセット

(All)

配置:	0
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Recurse

指定したディレクトリ内のヘルプファイルを再帰的に検索します。このパラメーターは、コマンドが SourcePath パラメーターを使用する場合にのみ有効です。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Scope

ヘルプが更新されるシステムスコープを指定します。 AllUsers スコープでの更新には、Windows システムに対する管理特権が必要です。 -Scope パラメーターは、PowerShell Core バージョン 6.1 で導入されました。

CurrentUser は、PowerShell 6.1 以降のヘルプファイルの既定のスコープです。 AllUsers を指定して、すべてのユーザーのヘルプをインストールまたは更新できます。 Unix システムでは、すべてのユーザーのヘルプを更新するには、sudo 特権が必要です。例: sudo pwsh -c Update-Help

許容される値は次のとおりです。

現在のユーザー
すべてのユーザー

パラメーターのプロパティ

型:	UpdateHelpScope
規定値:	CurrentUser
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-SourcePath

インターネットからダウンロードするのではなく、Update-Help が更新されたヘルプファイルを取得するファイルシステムフォルダーを指定します。フォルダーのパスを入力します。ファイル名またはファイル名拡張子を指定しないでください。 Get-Item または Get-ChildItem コマンドレットのフォルダーなど、フォルダーをパイプライン処理して Update-Helpできます。

既定では、Update-Help は更新されたヘルプファイルをインターネットからダウンロードします。コマンドレット Save-Help を使用します。

SourcePathの既定値を指定するには、[グループポリシーの ][コンピューターの構成] に移動し、[Update-Help の既定のソースパスを設定する] をします。このグループポリシー設定により、ユーザーは Update-Help を使用してインターネットからヘルプファイルをダウンロードできなくなります。詳細については、about_Group_Policy_Settingsを参照してください。

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	経路

パラメーターセット

Path

配置:	1
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-UICulture

更新されたヘルプファイルの取得に使用 Update-Help UI カルチャ値を指定します。 es-ES、カルチャオブジェクトを含む変数、カルチャオブジェクトを取得するコマンド (Get-Culture コマンドや Get-UICulture コマンドなど) など、1 つ以上の言語コードを入力します。ワイルドカード文字は使用できません。また、deなど、部分的な言語コードを送信することはできません。

既定では、Update-Help はオペレーティングシステムの UI カルチャセット内のヘルプファイルを取得します。 UICulture パラメーターを指定 Update-Help、指定した UI カルチャについてのみヘルプを検索します。

注

Ubuntu 18.04 では、既定のロケール設定が C.UTF.8 に変更されましたが、これは認識される UI カルチャではありません。 Update-Help サポートされているロケール (en-USなど) でこのパラメーターを使用しない限り、ヘルプのダウンロードは自動的に失敗します。これは、サポートされていない値を使用するすべてのプラットフォームで発生する可能性があります。

UICulture パラメーターを使用するコマンドは、モジュールが指定した UI カルチャのヘルプファイルを提供する場合にのみ成功します。指定した UI カルチャがサポートされていないためにコマンドが失敗した場合は、エラーメッセージが表示されます。

パラメーターのプロパティ

型:	CultureInfo[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	2
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-UseDefaultCredentials

Update-Help が現在のユーザーの資格情報を使用して、インターネットダウンロードを含むコマンドを実行することを示します。既定では、コマンドは明示的な資格情報なしで実行されます。

このパラメーターは、Web ダウンロードで NT LAN Manager (NTLM)、ネゴシエート、または Kerberos ベースの認証が使用されている場合にのみ有効です。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-WhatIf

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

パラメーターのプロパティ

型:	SwitchParameter
規定値:	False
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	ウィスコンシン

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。詳細については、about_CommonParametersを参照してください。

入力

DirectoryInfo

ディレクトリパスを Update-Help にパイプできます。

PSModuleInfo

モジュールオブジェクトを Get-Module コマンドレットから Update-Help にパイプ処理できます。

出力

None

Update-Help 出力は生成されません。

メモ

PowerShell でインストールされているコマンド、または $PSHOME\Modules ディレクトリ内のモジュールを含む主要な PowerShell モジュールのヘルプを更新するには、[管理者として実行] をオプションを使用して PowerShell を起動します。

コンピューター上の Administrators グループのメンバーのみが、コア PowerShell モジュール、PowerShell と共にインストールされるコマンド、および $PSHOME\Modules フォルダー内のモジュールのヘルプを更新できます。ヘルプファイルを更新するアクセス許可がない場合は、ヘルプファイルをオンラインで読み取ることができます。たとえば、Get-Help Update-Help -Online のようにします。

モジュールは、更新可能なヘルプの最小単位です。特定のコマンドレットのヘルプを更新することはできません。特定のコマンドレットを含むモジュールを検索するには、コマンドレットの Get-Command プロパティ ((Get-Command Update-Help).ModuleName など) を使用します。

ヘルプファイルはモジュールディレクトリにインストールされるため、Update-Help コマンドレットは、コンピューターにインストールされているモジュールに対してのみ、更新されたヘルプファイルをインストールできます。ただし、Save-Help コマンドレットは、コンピューターにインストールされていないモジュールのヘルプを保存できます。

モジュールの更新されたヘルプファイル Update-Help 見つからない場合、または指定した言語で更新されたヘルプが見つからない場合は、エラーメッセージを表示せずにサイレントプロンプトで続行されます。ステータスと進行状況の詳細を表示するには、 Verbose パラメータを使用します。

Update-Help コマンドレットは、Windows PowerShell 3.0 で導入されました。以前のバージョンの PowerShell では機能しません。 Windows PowerShell 2.0 と Windows PowerShell 3.0 の両方を持つコンピューターでは、Windows PowerShell 3.0 セッションの Update-Help コマンドレットを使用して、ヘルプファイルをダウンロードして更新します。ヘルプファイルは、Windows PowerShell 2.0 と Windows PowerShell 3.0 の両方で使用できます。

Update-Help および Save-Help コマンドレットは、ヘルプファイルをダウンロードするために次のポートを使用します。HTTP の場合はポート 80、HTTPS の場合はポート 443 です。

Update-Help では、すべてのモジュールとコア PowerShell スナップインがサポートされます。他のスナップインはサポートされていません。

$env:PSModulePath 環境変数にリストされていない場所にあるモジュールのヘルプを更新するには、モジュールを現在のセッションにインポートしてから、Update-Help コマンドを実行します。パラメーターを指定せずに Update-Help を実行するか、Module パラメーターを使用してモジュール名を指定します。コマンドレットと Update-Help コマンドレットの Save-Help パラメーターは、モジュールファイルまたはモジュールマニフェストファイルの完全なパスを受け入れられません。

どのモジュールでも、更新可能なヘルプをサポートできます。作成するモジュールで更新可能なヘルプをサポートする手順については、「更新可能なヘルプのサポートを参照してください。

Update-Help コマンドレットと Save-Help コマンドレットは、Windows プレインストール環境 (Windows PE) ではサポートされていません。

次の方法で共有

Update-Help

構文

Path (既定)

LiteralPath

説明

例

例 1: すべてのモジュールのヘルプ ファイルを更新する

例 2: 指定したモジュールのヘルプ ファイルを更新する

例 3: 異なる言語のヘルプ ファイルを更新する

例 4: ファイル共有から複数のコンピューター上のヘルプ ファイルを更新する

例 5: 更新されたヘルプ ファイルの一覧を取得する

例 6: 更新可能なヘルプをサポートするモジュールを検索する

例 7: 更新されたヘルプ ファイルのインベントリ

パラメーター

-Confirm

パラメーターのプロパティ

パラメーター セット

-Credential

パラメーターのプロパティ

パラメーター セット

-Force

パラメーターのプロパティ

パラメーター セット

-FullyQualifiedModule

パラメーターのプロパティ

パラメーター セット

-LiteralPath

パラメーターのプロパティ

パラメーター セット

-Module

パラメーターのプロパティ

パラメーター セット

-Recurse

パラメーターのプロパティ

パラメーター セット

-Scope

パラメーターのプロパティ

パラメーター セット

-SourcePath

パラメーターのプロパティ

パラメーター セット

-UICulture

パラメーターのプロパティ

パラメーター セット

-UseDefaultCredentials

パラメーターのプロパティ

パラメーター セット

-WhatIf

パラメーターのプロパティ

パラメーター セット

CommonParameters

入力

DirectoryInfo

PSModuleInfo

出力

None

メモ

関連リンク

例 1: すべてのモジュールのヘルプファイルを更新する

例 2: 指定したモジュールのヘルプファイルを更新する

例 3: 異なる言語のヘルプファイルを更新する

例 4: ファイル共有から複数のコンピューター上のヘルプファイルを更新する

例 5: 更新されたヘルプファイルの一覧を取得する

例 7: 更新されたヘルプファイルのインベントリ

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット