Get-MailUser
內部部署 Exchange 和雲端式服務有提供此 Cmdlet。 有些參數和設定可能只限於某一環境。
使用 Get-MailUser 指令碼來查看郵件使用者以及雲端環境中的訪客用戶Microsoft 365 群組。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
語法
AnrSet
Get-MailUser
[-Anr <String>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-ResultSize <Unlimited>]
[-SharedWithMailUser]
[-SoftDeletedMailUser]
[-SortBy <String>]
[<CommonParameters>]
Identity
Get-MailUser
[[-Identity] <MailUserIdParameter>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-ResultSize <Unlimited>]
[-SharedWithMailUser]
[-SoftDeletedMailUser]
[-SortBy <String>]
[<CommonParameters>]
HVEAccount
Get-MailUser
[-HVEAccount]
[-Filter <String>]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ResultSize <Unlimited>]
[-SharedWithMailUser]
[-SortBy <String>]
[-SoftDeletedMailUser]
[<CommonParameters>]
Description
您必須已獲指派權限,才能執行此指令程式。 雖然這篇文章列出了 cmdlet 的所有參數,但如果某些參數未包含在你分配的權限中,你可能無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限,請參閱 Find the permissions required to run any Exchange cmdlet。
範例
範例 1
Get-MailUser
本範例傳回組織中所有郵件使用者的摘要清單。
範例 2
Get-MailUser -Identity Ed | Format-List
此範例會回傳名為 Ed 的郵件使用者的詳細資訊。
參數
-Anr
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內建本地安全外掛信箱
Anr 參數會指定用來執行模糊名稱解析 (ANR) 搜尋的字串。 您可以指定部分字串,然後搜尋屬性符合該字串的物件。 搜尋的預設屬性如下:
- CommonName (CN)
- DisplayName
- FirstName
- LastName
- 別名
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
AnrSet
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Credential
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
此參數僅適用於內部部署 Exchange。
Credential 參數指定執行此指令所使用的使用者名稱和密碼。 通常您會在指令碼中使用此參數,或在您必須提供具有必要權限的其他認證時使用此參數。
此參數需要建立及傳遞認證物件。 此認證物件是透過使用 Get-Credential Cmdlet 來建立。 如需詳細資訊,請參閱 Get-Credential。
參數屬性
| 類型: | PSCredential |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
AnrSet
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
Identity
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-DomainController
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
此參數僅適用於內部部署 Exchange。
DomainController 參數會指定此 Cmdlet 用來向 Active Directory 讀取或寫入資料的網域控制站。 您可以透過網域控制站的完整網域名稱 (FQDN) 來識別網域控制站。 例如,dc01.contoso.com。
參數屬性
| 類型: | Fqdn |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
AnrSet
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
Identity
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Filter
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內建本地安全外掛信箱
Filter 參數使用 OPATH 語法,依照指定的屬性與值來篩選結果。 搜尋準則使用語法 "Property -ComparisonOperator 'Value'"。
- 將整個 OPATH 濾波器包在雙引號中 “”。 如果篩選條件包含系統值 (例如
$true、$false或$null),請改為使用單引號 ' '。 雖然此參數是字串 (不是系統區塊),您也可以使用大括弧 { },但只有在篩選條件不包含變數時。 - Property 是可篩選的屬性。 欲了解更多關於 Exchange Server 與 Exchange Online 中可篩選屬性的資訊,請參閱 Filterable 屬性中的篩選參數。
- ComparisonOperator 是一種 OPATH 比較運算子,例如用於等值和
-like字串比較) (-eq。 如需比較運算子的詳細資訊,請參閱 about_Comparison_Operators。 - Value 是要搜尋的屬性值。 以單引號括住文字值和變數 (
'Value'或'$Variable')。 如果變數值包含單引號,您必須識別 (逸出) 單引號,以正確展開變數。 例如,使用'$($User -Replace "'","''")',而不是'$User'。 不要用引號包住整數或系統值, (例如,使用500、、$true$false,或$null) 。
您可以使用邏輯運算子 -and 和 -or 將多個搜尋準則鏈結在一起。 例如,"Criteria1 -and Criteria2" 或 "(Criteria1 -and Criteria2) -or Criteria3"。
欲了解 Exchange 中 OPATH 過濾器的詳細資訊,請參見 「額外 OPATH 語法資訊」。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-HVEAccount
適用:Exchange Online,內建本地信箱安全外掛
此參數只能在雲端式服務中使用。
HVEAccount 交換器指定此郵件使用者帳號專門用於 高流量電子郵件服務。 您不需要使用此參數指定值。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
HVEAccount
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Identity
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內建本地安全外掛信箱
Identity 參數指定你想查看的郵件使用者。 您可以使用唯一識別郵件使用者的任何值。 例如:
- 名稱
- 別名
- 辨別名稱 (DN)
- 辨別名稱 (DN)
- 標準 DN
- GUID
注意:Identity 參數的值$null或不存在的值,會回傳 所有 物件,就像你執行 Get- 指令時沒有 Identity 參數一樣。 請確認 Identity 參數的值清單是否準確,且不包含不存在的 $null 值。
參數屬性
| 類型: | MailUserIdParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Identity
| Position: | 1 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-IgnoreDefaultScope
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
此參數僅適用於內部部署 Exchange。
IgnoreDefaultScope 交換器告訴指令忽略 Exchange PowerShell 會話的預設接收者範圍設定,並使用整個森林作為範圍。 您不需要使用此參數指定值。
此切換使指令能存取目前未在預設範圍內可用的 Active Directory 物件,但同時引入以下限制:
- 您不能使用 DomainController 參數。 此命令會自動使用適當的通用類別目錄伺服器。
- 您不能使用 DomainController 參數。 此命令會自動使用適當的通用類別目錄伺服器。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
AnrSet
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
Identity
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-OrganizationalUnit
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內建本地安全外掛信箱
OrganizationalUnit 參數會根據物件在 Active Directory 中的位置來過濾結果。 系統只會傳回存在於指定位置的物件。 此參數的有效輸入是由 Get-OrganizationalUnit 指令碼返回 (OU) 或領域中的組織單位。 您可以使用唯一識別 OU 或網域的任何值。 例如:
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
參數屬性
| 類型: | OrganizationalUnitIdParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ReadFromDomainController
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
此參數僅適用於內部部署 Exchange。
ReadFromDomainController 參數會指定應從使用者網域的網域控制站讀取的資訊。 您不需要使用此參數指定值。
指令: Set-AdServerSettings -ViewEntireForest $true 要包含森林中的所有物件需要 ReadFromDomainController 交換器。 否則,指令可能會使用包含過時資訊的全域目錄。 另外,你可能需要用 ReadFromDomainController 交換器執行多次指令來取得資訊。
預設情況下,接收範圍設定為承載你 Exchange 伺服器的網域。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
AnrSet
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
Identity
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ResultSize
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內建本地安全外掛信箱
ResultSize 參數會指定傳回的結果筆數上限。 若要傳回符合查詢的所有要求,請使用 unlimited 作為此參數的值。 預設值為 1000。
參數屬性
| 類型: | Unlimited |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-SharedWithMailUser
適用:Exchange Online,內建本地信箱安全外掛
此參數只能在雲端式服務中使用。
{{ 填寫 SharedWithMailUser 描述 }}
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
AnrSet
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
Identity
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-SoftDeletedMailUser
適用:Exchange Online,內建本地信箱安全外掛
此參數只能在雲端式服務中使用。
SoftDeletedMailUser 開關會指定是否將軟刪除的郵件使用者納入結果。 您不需要使用此參數指定值。
軟刪除的郵件用戶是仍可恢復的已刪除郵件用戶。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-SortBy
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內建本地安全外掛信箱
SortBy 參數會指定排序結果依據的屬性。 您一次只能依據一個屬性進行排序。 結果會以遞增順序排序。
如果預設視圖沒有包含你排序的屬性,你可以在指令 | Format-Table -Auto Property1,Property2,...PropertyX上加上 。 建立一個包含你想看到的所有屬性的新檢視。 支援在屬性名稱中使用萬用字元 (*)。
您可以依下列內容排序:
- 名稱
- DisplayName
- 別名
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 cmdlet 支援常見參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。
輸入
Input types
若要查看此指令程式可接受的輸入類型,請參閱指令程式輸入和輸出類型。 如果指令程式的 [輸入類型] 欄位是空的,表示指令程式不接受輸入資料。
輸出
Output types
若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型),請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的,表示指令程式不會傳回資料。