PowerShellで特定のコマンドのすべてのオプションを出力するには、Get-Help
コマンドを使用します。特定のコマンドに関する詳細な情報を表示するために、次のようにします。
例えば、Copy-Item
コマンドのすべてのオプションを表示する場合:
> Get-Help Copy-Item -Full
名前
Copy-Item
構文
Copy-Item [-Path] <string[]> [[-Destination] <string>] [<CommonParameters>]
Copy-Item [[-Destination] <string>] [<CommonParameters>]
パラメーター
-Confirm
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス cf
動的 false
-Container
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-Credential <pscredential>
必須 false
位置 名前付き
パイプライン入力を許可する true (ByPropertyName)
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-Destination <string>
必須 false
位置 1
パイプライン入力を許可する true (ByPropertyName)
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-Exclude <string[]>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-Filter <string>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-Force
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-FromSession <PSSession>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 true
-Include <string[]>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-LiteralPath <string[]>
必須 true
位置 名前付き
パイプライン入力を許可する true (ByPropertyName)
パラメーター セット名 LiteralPath
エイリアス PSPath
動的 false
-PassThru
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-Path <string[]>
必須 true
位置 0
パイプライン入力を許可する true (ByValue, ByPropertyName)
パラメーター セット名 Path
エイリアス なし
動的 false
-Recurse
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-ToSession <PSSession>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 true
-UseTransaction
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス usetx
動的 false
-WhatIf
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス wi
動的 false
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
OutBuffer, PipelineVariable、および OutVariable。詳細については、
about_CommonParameters (<https://go.microsoft.com/fwlink/?LinkID=113216>)
を参照してください。
入力
System.String[]
System.String
System.Management.Automation.PSCredential
出力
System.Object
エイリアス
cpi
cp
copy
注釈
Get-Help を実行しましたが、このコンピューターにこのコマンドレットのヘルプ ファイルは見つかりませんでした。ヘルプの一部だけが表示されています。
-- このコマンドレットを含むモジュールのヘルプ ファイルをダウンロードしてインストールするには、Update-Help を使用してください。
-- このコマンドレットのヘルプ トピックをオンラインで確認するには、「Get-Help Copy-Item -Online」と入力するか、
<https://go.microsoft.com/fwlink/?LinkID=113292> を参照してください。
Full
スイッチは、そのコマンドのすべての詳細情報を表示します。もし、オプションのみを確認したい場合は、Parameter
スイッチを使用することもできます。> Get-Help Copy-Item -Parameter *
-Confirm
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス cf
動的 false
-Container
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-Credential <pscredential>
必須 false
位置 名前付き
パイプライン入力を許可する true (ByPropertyName)
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-Destination <string>
必須 false
位置 1
パイプライン入力を許可する true (ByPropertyName)
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-Exclude <string[]>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-Filter <string>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-Force
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-FromSession <PSSession>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 true
-Include <string[]>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-LiteralPath <string[]>
必須 true
位置 名前付き
パイプライン入力を許可する true (ByPropertyName)
パラメーター セット名 LiteralPath
エイリアス PSPath
動的 false
-PassThru
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-Path <string[]>
必須 true
位置 0
パイプライン入力を許可する true (ByValue, ByPropertyName)
パラメーター セット名 Path
エイリアス なし
動的 false
-Recurse
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 false
-ToSession <PSSession>
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス なし
動的 true
-UseTransaction
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス usetx
動的 false
-WhatIf
必須 false
位置 名前付き
パイプライン入力を許可する false
パラメーター セット名 (すべて)
エイリアス wi
動的 false
> (Get-Help Copy-Item -Parameter *).name
Confirm
Container
Credential
Destination
Exclude
Filter
Force
FromSession
Include
LiteralPath
PassThru
Path
Recurse
ToSession
UseTransaction
WhatIf
これにより、Copy-Item
コマンドのすべてのパラメーターとその説明が表示されます。
また、PowerShell 5.1以降では、次のようにしてオンラインドキュメントにアクセスすることもできます。
Get-Help Copy-Item -Online
これにより、Microsoftの公式ドキュメントサイトにアクセスして、より詳細な情報を確認できます。
さらに、特定のパラメーターに関する情報だけを取得したい場合は、次のようにします。
> Get-Help Copy-Item -Parameter Destination
-Destination <string>
必須 false
位置 1
パイプライン入力を許可する true (ByPropertyName)
パラメーター セット名 (すべて)
エイリアス なし
動的 false
このようにすることで、Destination
パラメーターに関する詳細な情報を取得できます。
以上の方法を使用することで、PowerShellコマンドのすべてのオプションとその詳細を確認することができます。