PowerShell 入門 2：使用幫助系統

🎯 一、認識 PowerShell 幫助系統

1. 使用 Get-Help 查看命令說明

Get-Help Get-Service

或使用別名：

gsv

2. 更新幫助系統

Update-Help

3. 搜索包含關鍵詞的命令（模糊搜索）

Help *log*

📌 例如查找和事件日志相關的命令（如 Get-EventLog）。

---

🧩 二、Cmdlet 命名規范：動詞-名詞

PowerShell 中的命令遵循 動詞-名詞 結構，如：

• Get-Process
• Set-Date
• Get-EventLog

---

📚 三、Get-EventLog 命令語法解析

Get-EventLog [-AsString] [-ComputerName <string[]>] [-List][<CommonParameters>]Get-EventLog [-LogName] <string>[[-InstanceId] <Int64[]>][-After <DateTime>] [-AsBaseObject][-Before <DateTime>] [-ComputerName <string[]>][-EntryType <string[]>] [-Index <Int32[]>][-Message <string>] [-Newest <int>][-Source <string[]>] [-UserName <string[]>][<CommonParameters>]

參數集說明：

• -List, -AsString 僅用于列出日志名稱（參數集1）
• -LogName, -Newest, -EntryType 等用于讀取具體日志內容（參數集2）
• -ComputerName 是兩個參數集共享的

🔺 注意：不能同時混用兩個參數集的參數

---

🧾 四、可選與必選參數

寫法	含義
[-Param <type>]	可選參數（必須寫參數名）
[-Param] <type>	必選參數 + 是位置參數
[[-Param] <type>]	可選參數 + 是位置參數

• 方括號 [ ] 表示參數是可選的
• 可省略參數名（前提是該參數是位置參數且位置正確）
• 縮寫參數名需唯一（如 -Li 表示 -List，但 -L 不唯一會報錯）

---

🧠 五、使用參數的最佳實踐

? 推薦做法：

• 編寫腳本或筆記時，總是使用完整參數名

Get-EventLog -LogName Application -Newest 20

• 熟練后在命令行交互中使用縮寫

---

🧱 六、位置參數的判斷方法

方法一：通過語法概要判斷

示例：

[-LogName] <string>              # 必選位置參數
[[-InstanceId] <int64[]>]        # 可選位置參數
[-Before <datetime>]             # 非位置參數（必須寫參數名）

方法二：查看完整幫助文檔

Help Get-EventLog -Full

輸出段落示例：

-LogName <string>是否必需？        True位置？            0接受通配符？      False

---

🎚? 七、開關參數與數據類型

1. Switch 參數

• 示例： -AsString
• 無需指定值，只要寫出來就等于啟用

Get-EventLog -List -AsString

2. 常見數據類型說明

類型	示例	說明
string	'Application'	含空格需加引號
int/int64	5	整數
datetime	2025-08-05	日期格式自動解析
string[]	'Server01','Server02'	字符串數組，用逗號隔開

🔺 若字符串中有空格需加引號（如 "C:\Program Files"）

---

📂 八、如何批量傳遞數組參數

可使用文件：
📁 computers.txt

Server01
Server02
Server03

Get-EventLog -LogName System -ComputerName (Get-Content computers.txt)

---

🔍 九、查看示例與“關于”主題

1. 只查看示例

Help Get-EventLog -Examples

2. 查看通用參數幫助

Help about_CommonParameters

3. 列出所有“about_”幫助主題

Help about*

常見 about_ 主題涵蓋：

• 類型系統
• 錯誤處理
• 腳本變量作用域
• 管道行為

---

🧾 十、常用命令小結

命令	功能
Help Get-EventLog -Full	查看完整幫助與參數解釋
Help Get-EventLog -Examples	快速學習命令示例
Update-Help	更新本地幫助文件
Help Get-EventLog -ShowWindow	GUI 幫助（僅限桌面系統）
Get-Command Get-EventLog	查看命令基本定義
(Get-Command Get-EventLog).Parameters[...]	查看參數詳情
Help about_CommonParameters	查看通用參數詳細說明
Help about*	列出所有“about_”主題