Get-EXORecipient
此 Cmdlet 僅適用於 Exchange Online PowerShell 模組。 如需詳細資訊，請參閱關於 Exchange Online PowerShell 模組。
使用 Get-EXORecipient Cmdlet 來檢視組織中現有的收件者物件。 此指令程式會傳回所有擁有郵件功能的物件 (例如信箱、郵件使用者、郵件連絡人和通訊群組)。
如需下方＜語法＞一節中參數集的詳細資訊，請參閱 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 屬性集 和 篩選參數的可篩選屬性。
- ComparisonOperator 是一種 OPATH 比較運算子 (例如
-eq，用於等號和-like字串比較) 。 如需比較運算子的詳細資訊，請參閱 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 參數會依指定的收件者類型篩選結果。 有效值為：
- DynamicDistributionGroup
- MailContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- UserMailbox
您可以指定多個以逗號分隔的值。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RecipientTypeDetails
適用：Exchange Online
RecipientTypeDetails 參數會依指定的收件者子類型篩選結果。 有效值為：
- DiscoveryMailbox
- DynamicDistributionGroup
- EquipmentMailbox
- GroupMailbox
- GuestMailUser
- LegacyMailbox
- LinkedMailbox
- LinkedRoomMailbox
- MailContact
- MailForestContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- PublicFolderMailbox
- RemoteEquipmentMailbox
- RemoteRoomMailbox
- RemoteSharedMailbox
- RemoteTeamMailbox
- RemoteUserMailbox
- RoomList
- RoomMailbox
- SchedulingMailbox
- SharedMailbox
- SharedWithMailUser
- 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。