Get-EXORecipient
此 cmdlet 僅在 Exchange Online PowerShell 模組中提供。 欲了解更多資訊，請參閱「關於 Exchange Online PowerShell 模組」。
使用 Get-EXORecipient 指令碼來查看組織中現有的接收物件。 此指令程式會傳回所有擁有郵件功能的物件 (例如信箱、郵件使用者、郵件連絡人和通訊群組)。
如需下方＜語法＞一節中參數集的詳細資訊，請參閱 Exchange Cmdlet 語法。
語法
Identity (預設值)
Get-EXORecipient
[[-Identity] <String>]
[-ExternalDirectoryObjectId <Guid>]
[-Filter <String>]
[-IncludeSoftDeletedRecipients]
[-OrganizationalUnit <String>]
[-PrimarySmtpAddress <String>]
[-Properties <String[]>]
[-PropertySets <PropertySet[]>]
[-RecipientPreviewFilter <String>]
[-RecipientType <String[]>]
[-RecipientTypeDetails <String[]>]
[-ResultSize <Unlimited>]
[-UserPrincipalName <String>]
[<CommonParameters>]
Anr
Get-EXORecipient
[-Anr <String>]
[-Filter <String>]
[-IncludeSoftDeletedRecipients]
[-OrganizationalUnit <String>]
[-Properties <String[]>]
[-PropertySets <PropertySet[]>]
[-RecipientPreviewFilter <String>]
[-RecipientType <String[]>]
[-RecipientTypeDetails <String[]>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
Description
Get-EXORecipient cmdlet 可用來檢視組織中現有的接收物件。 此指令程式會傳回所有擁有郵件功能的物件 (例如信箱、郵件使用者、郵件連絡人和通訊群組)。
範例
範例 1
Get-EXORecipient -ResultSize 100
此範例會以名稱排序順序回傳前 100 個接收物件。
範例 2
Get-EXORecipient -Identity john@contoso.com
此範例回傳使用者的接收者屬性細節 john@contoso.com
參數
-Anr
適用：Exchange Online
Anr 參數會指定用來執行模糊名稱解析 (ANR) 搜尋的字串。 您可以指定部分字串，然後搜尋屬性符合該字串的物件。 搜尋的預設屬性如下：
- CommonName (CN)
- DisplayName
- FirstName
- LastName
- 別名
你不能將此參數與 ExternalDirectoryObjectId、Identity、PrimarySmtpAddress 或 UserPrincipalName 等參數一起使用。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Anr
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ExternalDirectoryObjectId
適用：Exchange Online
ExternalDirectoryObjectId 參數會透過 Microsoft Entra ID 中的 ObjectID 來識別你想查看的收件人。
你不能將這個參數與 Anr、Identity、PrimarySmtpAddress 或 UserPrincipalName 等參數一起使用。
參數屬性
| 類型: | Guid |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Identity
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Filter
適用：Exchange Online
Filter 參數使用 OPATH 語法，依照指定的屬性與值來篩選結果。 搜尋準則使用語法 "Property -ComparisonOperator 'Value'"。
- 將整個 OPATH 濾波器包在雙引號中 “”。 如果篩選條件包含系統值 (例如
$true、$false或$null)，請改為使用單引號 ' '。 雖然此參數是字串 (不是系統區塊)，您也可以使用大括弧 { }，但只有在篩選條件不包含變數時。 - Property 是可篩選的屬性。 欲了解更多可篩選屬性的資訊，請參閱 Get-EXORecipient 屬性集 及 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 |
-Identity
適用：Exchange Online
Identity 參數會指定您要檢視的收件者物件。 為了達到最佳表現，我們建議使用以下數值來識別受獎者：
- 使用者識別碼或使用者主要名稱 (UPN)
- GUID
否則，你可以使用任何能唯一識別收件人的值。 例如：
- 名稱
- 別名
- 辨別名稱 (DN)
- 網域\使用者名稱
- 電子郵件地址
- LegacyExchangeDN
- SamAccountName
你不能用這個參數搭配 Anr、ExternalDirectoryObjectId、PrimarySmtpAddress 或 UserPrincipalName 這些參數。
注意：Identity 參數的值$null或不存在的值，會回傳 所有 物件，就像你執行 Get- 指令時沒有 Identity 參數一樣。 請確認 Identity 參數的值清單是否準確，且不包含不存在的 $null 值。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Identity
| Position: | 0 |
| 必要: | False |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-IncludeSoftDeletedRecipients
適用：Exchange Online
IncludeSoftDeletedRecipients 開關會指定是否將軟刪除的收件人納入結果。 您不需要使用此參數指定值。
軟刪除的接收者是指仍可恢復的已刪除收件人。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-OrganizationalUnit
適用：Exchange Online
OrganizationalUnit 參數會根據物件在 Active Directory 中的位置來過濾結果。 系統只會傳回存在於指定位置的物件。 這個參數的有效輸入是可使用 Get-OrganizationalUnit Cmdlet 查看的組織單位 (OU) 或網域。 您可以使用唯一識別 OU 或網域的任何值。 例如：
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PrimarySmtpAddress
適用：Exchange Online
PrimarySmtpAddress 會依據主要 SMTP 電子郵件地址 (navin@contoso.com) 來識別你想查看的收件人。
你不能用這個參數搭配 Anr、ExternalDirectoryObjectId、Identity 或 UserPrincipalName 這些參數。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Identity
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Properties
適用：Exchange Online
Properties 參數指定了 cmdlet 輸出中回傳的屬性。 您可以指定多個以逗號分隔的值。
欲了解更多可用屬性的資訊，請參見 Get-EXORecipient 屬性集合。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PropertySets
適用：Exchange Online
PropertySets 參數指定了該 cmdlet 輸出中回傳的屬性的邏輯分組。 有效值為：
- 最低 (這是預設值)
- 封存
- 自訂
- MailboxMove
- 原則
欲了解更多關於每個屬性集中所包含屬性的資訊，請參閱 Get-EXORecipient 屬性集合。
參數屬性
| 類型: | PropertySet[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RecipientPreviewFilter
適用：Exchange Online
將保留此參數供 Microsoft 內部使用。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RecipientType
適用：Exchange Online
RecipientType 參數會依照指定的接收者類型過濾結果。 有效值為：
- 動態分布組
- 郵件聯絡
- MailNonUniversalGroup
- 郵件通用分發群組
- 郵件通用安全集團
- MailUser
- PublicFolder
- UserMailbox
您可以指定多個以逗號分隔的值。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RecipientTypeDetails
適用：Exchange Online
RecipientTypeDetails 參數會依指定的接收者子類型過濾結果。 有效值為：
- 發現信箱
- 動態分布組
- 設備郵箱
- GroupMailbox
- GuestMailUser
- 傳承郵箱
- LinkedMailbox
- 連結室郵箱
- 郵件聯絡
- MailForest聯絡
- MailNonUniversalGroup
- 郵件通用分發群組
- 郵件通用安全集團
- MailUser
- PublicFolder
- PublicFolderMailbox
- 遠端設備信箱
- 遠端房間郵箱
- 遠端共享郵箱
- 遠端團隊郵箱
- 遠端使用者郵箱
- 房間列表
- 房間信箱
- 排程郵件箱
- SharedMailbox
- 共享郵件用戶
- TeamMailbox
- UserMailbox
您可以指定多個以逗號分隔的值。
RecipientType 參數的值會影響你可以用來設定這個參數的值。 例如，如果你使用 RecipientType 值 MailContact，你不能用 UserMailbox 來設定這個參數。 你會收到錯誤訊息：任何指定的 RecipientTypeDetails 都不包含在任何指定的收件人類型中。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ResultSize
適用：Exchange Online
ResultSize 參數會指定傳回的結果筆數上限。 若要傳回符合查詢的所有要求，請使用 unlimited 作為此參數的值。 預設值為 1000。
參數屬性
| 類型: | Unlimited |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-UserPrincipalName
適用：Exchange Online
UserPrincipalName 參數用 UPN (navin@contoso.onmicrosoft.com) 來識別你想查看的收件人。
你不能用這個參數搭配 Anr、ExternalDirectoryObjectId、Identity 或 PrimarySmtpAddress 參數。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Identity
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
CommonParameters
此 cmdlet 支援常見參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。