Get-EXORecipient

參考

模組:: ExchangePowerShell

適用於:: Exchange Online

此 Cmdlet 僅適用于 Exchange Online PowerShell 模組。如需詳細資訊，請參閱關於 Exchange Online PowerShell 模組。

使用 Get-ExORecipient Cmdlet 來檢視組織中現有的收件者物件。此指令程式會傳回所有擁有郵件功能的物件 (例如信箱、郵件使用者、郵件連絡人和通訊群組)。

如需下方＜語法＞一節中參數集的詳細資訊，請參閱 Exchange Cmdlet 語法。

Syntax

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>]

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@contosot.com

此範例會傳回使用者的收件者屬性詳細資料 john@contoso.com

參數

-Anr

Anr 參數會指定用來執行模糊名稱解析 (ANR) 搜尋的字串。您可以指定部分字串，然後搜尋屬性符合該字串的物件。搜尋的預設屬性如下：

CommonName (CN)
DisplayName
FirstName
LastName
別名

您無法搭配 ExternalDirectoryObjectId、Identity、PrimarySmtpAddress 或 UserPrincipalName 參數使用此參數。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-ExternalDirectoryObjectId

ExternalDirectoryObjectId 參數會識別您想要在 Azure Active Directory 中由 ObjectId 檢視的收件者。

您無法搭配 Anr、Identity、PrimarySmtpAddress 或 UserPrincipalName 參數使用此參數。

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Online

-Filter

Filter 參數會使用 OPATH 語法，依指定的屬性和值來篩選結果。搜尋準則使用語法 "Property -ComparisonOperator 'Value'"。

以雙引號「」括住整個 OPATH 篩選準則。如果篩選條件包含系統值 (例如 $true、 $false 或 $null)，請改為使用單引號 ' '。雖然此參數是字串 (不是系統區塊)，您也可以使用大括弧 { }，但只有在篩選條件不包含變數時。
Property 是可篩選的屬性。如需可篩選屬性的詳細資訊，請參閱 Filter 參數的 Get-EXORecipient 屬性集和 Filterable 屬性。
ComparisonOperator 是 OPATH 比較運算子 (例如 -eq equals 和 -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 語法資訊。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-Identity

Identity 參數會指定您要檢視的收件者物件。為了獲得最佳效能，建議您使用下列值來識別收件者：

使用者識別碼或使用者主要名稱 (UPN)
GUID

否則，您可以使用可唯一識別收件者的任何值。例如：

名稱
別名
辨別名稱 (DN)
Domain\Username
電子郵件地址
LegacyExchangeDN
SamAccountName

您無法搭配 Anr、ExternalDirectoryObjectId、PrimarySmtpAddress 或 UserPrincipalName 參數使用此參數。

Type:	String
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Online

-IncludeSoftDeletedRecipients

IncludeSoftDeletedRecipients 參數會指定是否要在結果中包含虛刪除的收件者。您不需要使用此參數指定值。

虛刪除的收件者是仍可復原的已刪除收件者。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-OrganizationalUnit

OrganizationalUnit 參數會根據物件在 Active Directory 中的位置來篩選結果。系統只會傳回存在於指定位置的物件。這個參數的有效輸入是可使用 Get-OrganizationalUnit Cmdlet 查看的組織單位 (OU) 或網域。您可以使用唯一識別 OU 或網域的任何值。例如：

名稱
名稱
辨別名稱 (DN)
GUID

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-PrimarySmtpAddress

PrimarySmtpAddress 會識別您想要依主要 SMTP 電子郵件地址檢視的收件者 (例如， navin@contoso.com) 。

您無法搭配 Anr、ExternalDirectoryObjectId、Identity 或 UserPrincipalName 參數使用此參數。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Online

-Properties

Properties 參數會指定在這個 Cmdlet 的輸出中傳回的屬性。您可以指定多個以逗號分隔的值。

如需可用屬性的詳細資訊，請參閱 Get-EXORecipient 屬性集。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-PropertySets

PropertySets 參數會指定在此 Cmdlet 輸出中傳回之屬性的邏輯群組。有效值為：

最小 (這是預設值)
封存
自訂
MailboxMove
原則

如需每個屬性集內含之屬性的詳細資訊，請參閱 Get-EXORecipient 屬性集。

Type:	PropertySet[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-RecipientPreviewFilter

將保留此參數供 Microsoft 內部使用。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-RecipientType

RecipientType 參數會依指定的收件者類型篩選結果。有效值為：

DynamicDistributionGroup
MailContact
MailNonUniversalGroup
MailUniversalDistributionGroup
MailUniversalSecurityGroup
MailUser
PublicFolder
UserMailbox

您可以指定多個以逗號分隔的值。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-RecipientTypeDetails

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 都不會包含在任何指定的收件者類型中。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-ResultSize

ResultSize 參數會指定傳回的結果筆數上限。若要傳回符合查詢的所有要求，請使用 unlimited 作為此參數的值。預設值為 1000。

Type:	Unlimited
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-UserPrincipalName

UserPrincipalName 參數會識別您想要由 UPN 檢視的收件者 (例如， navin@contoso.onmicrosoft.com) 。

您無法搭配 Anr、ExternalDirectoryObjectId、Identity 或 PrimarySmtpAddress 參數使用此參數。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Online

共用方式為