PowerShellでコマンドのパラメータを一覧で表示する方法 | 新人SEの備忘録

SEに必須なドキュメント作成の自動化を目論んでいます。

PowerShellを使用していますが、作業の際に多種多様なコマンドを使用します。
このコマンドのパラメータの一覧が欲しくなる時が多々あるので、一覧の表示方法をメモします。

そもそもパラメータとは

パラメータとは、コマンドの追加効果です。
僕は追記の[-Append]や、文字コードを変更する[-Encode]をよく使います。

ただパラメータという単語が頭に浮ばず、検索に苦労した思い出がたくさんあります。
この記事よ、PowerShell初心者に届け！（届かない）

一覧を表示する方法

**[Get-Help (コマンド) -Detailed]**を使用することで表示できます。

# exsample [Get-Help]
PS C:\> Get-Help Get-Service -Detailed

名前
    Get-Service

構文
    Get-Service [[-Name] <string[]>]  [<CommonParameters>]

    Get-Service  [<CommonParameters>]

    Get-Service  [<CommonParameters>]


パラメーター
    -ComputerName <string[]>

    -DependentServices

    -DisplayName <string[]>

    -Exclude <string[]>

    -Include <string[]>

    -InputObject <ServiceController[]>

    -Name <string[]>

    -RequiredServices

    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer, PipelineVariable、および OutVariable。詳細については、
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216)
        を参照してください。


エイリアス
    gsv


注釈
    Get-Help を実行しましたが、このコンピューターにこのコマンドレットのヘルプ ファイルは見つかりませんでした。ヘルプの一部だけが表示されています。
        -- このコマンドレットを含むモジュールのヘルプ ファイルをダウンロードしてインストールするには、Update-Help を使用してください。
        -- このコマンドレットのヘルプ トピックをオンラインで確認するには、「Get-Help Get-Service -Online」と入力するか、
           https://go.microsoft.com/fwlink/?LinkID=113332 を参照してください。

参考
PowerShell/コマンドレットのヘルプの引き方・Get-Help | PukiWiki 1.5.1
https://win.just4fun.biz/?PowerShell/%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89%E3%83%AC%E3%83%83%E3%83%88%E3%81%AE%E3%83%98%E3%83%AB%E3%83%97%E3%81%AE%E5%BC%95%E3%81%8D%E6%96%B9%E3%83%BBGet-Help