共用方式為


Get-Recipient

內部部署 Exchange 和雲端式服務有提供此 Cmdlet。 有些參數和設定可能是某一個環境所專屬。

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

注意:在 Exchange Online PowerShell 中,建議您使用 Get-EXORecipient Cmdlet,而不是此 Cmdlet。 如需詳細資訊,請參閱<連線至 Exchange Online PowerShell>。

在雲端環境中,若要傳回Microsoft 365 群組,您必須使用 RecipientTypeDetails 參數搭配 GroupMailbox 值。

如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法

Syntax

Get-Recipient
   [-Anr <String>]
   [-AuthenticationType <AuthenticationType>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-Capabilities <MultiValuedProperty>]
   [-Database <DatabaseIdParameter>]
   [-Properties <String[]>]
   [-IncludeSoftDeletedRecipients]
   [<CommonParameters>]
Get-Recipient
   [[-Identity] <RecipientIdParameter>]
   [-AuthenticationType <AuthenticationType>]
   [-BookmarkDisplayName <String>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-IncludeBookmarkObject <Boolean>]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-Capabilities <MultiValuedProperty>]
   [-Properties <String[]>]
   [-IncludeSoftDeletedRecipients]
   [<CommonParameters>]
Get-Recipient
   [-Database <DatabaseIdParameter>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-Properties <String[]>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [-IncludeSoftDeletedRecipients] [<CommonParameters>]
   [<CommonParameters>]
Get-Recipient
   [-RecipientPreviewFilter <String>]
   [-AuthenticationType <AuthenticationType>]
   [-Capabilities <MultiValuedProperty>]
   [-Credential <PSCredential>]
   [-DomainController <Fqdn>]
   [-Filter <String>]
   [-IgnoreDefaultScope]
   [-IncludeSoftDeletedRecipients]
   [-OrganizationalUnit <OrganizationalUnitIdParameter>]
   [-Properties <String[]>]
   [-PropertySet <PropertySet>]
   [-ReadFromDomainController]
   [-RecipientType <RecipientType[]>]
   [-RecipientTypeDetails <RecipientTypeDetails[]>]
   [-ResultSize <Unlimited>]
   [-SortBy <String>]
   [<CommonParameters>]

Description

Get-Recipient 指令程式可能不會傳回收件者的所有物件特定內容。 若要檢視收件者的物件特定內容,您需要使用以物件類型 (例如 Get-Mailbox、Get-MailUser 或 Get-DistributionGroup) 為基礎的對應指令程式。

您必須已獲指派權限,才能執行此指令程式。 雖然本主題已列出這個指令程式的所有參數,不過,如果某些參數並未包含在指派給您的權限中,您可能就無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限,請參閱 Find the permissions required to run any Exchange cmdlet

範例

範例 1

Get-Recipient -ResultSize unlimited

此範例會擷取您組織中所有收件者的摘要清單。

範例 2

Get-Recipient -Identity "Marketing Department" | Format-List

此範例會傳回名為 Marketing Department 之收件者的詳細資訊。

範例 3

Get-Recipient -RecipientType MailContact -SortBy Office | Format-Table -Auto Office,Name

此範例會擷取您組織中所有郵件連絡人的相關資訊,並依辦公室加以排序。

參數

-Anr

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

  • CommonName (CN)
  • DisplayName
  • FirstName
  • LastName
  • 別名
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-AuthenticationType

此參數只能在雲端式服務中使用。

AuthenticationType 參數會依驗證類型指定收件者。 請使用下列其中一個值:

  • 聯邦
  • 受管理
Type:AuthenticationType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online, Security & Compliance, Exchange Online Protection

-BookmarkDisplayName

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-Capabilities

此參數只能在雲端式服務中使用。

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

Type:MultiValuedProperty
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online, Security & Compliance, Exchange Online Protection

-Credential

此參數僅適用於內部部署 Exchange。

Credential 參數會指定用來執行此命令的使用者名稱和密碼。 通常您會在指令碼中使用此參數,或在您必須提供具有必要權限的其他認證時使用此參數。

此參數的值需要使用 Get-Credential Cmdlet。 若要暫停此命令並收到輸入認證的提示,請使用值 (Get-Credential)。 或者,在您執行此命令之前,將認證儲存在變數中 (例如,$cred = Get-Credential),然後將變數名稱 ($cred) 用於此參數。 如需詳細資訊,請參閱 Get-Credential

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Database

此參數僅適用於內部部署 Exchange。

Database 參數會傳回儲存在指定信箱資料庫上的所有收件者。 您可以使用唯一識別資料庫的任何值。 例如:

  • 名稱
  • 辨別名稱 (DN)
  • GUID
Type:DatabaseIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-DomainController

此參數僅適用於內部部署 Exchange。

DomainController 參數會指定此 Cmdlet 用來向 Active Directory 讀取或寫入資料的網域控制站。 您可以透過網域控制站的完整網域名稱 (FQDN) 來識別網域控制站。 例如,dc01.contoso.com。

Type:Fqdn
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Filter

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

  • 以雙引號 「」 括住整個 OPATH 篩選準則。 如果篩選條件包含系統值 (例如 $true$false$null),請改為使用單引號 ' '。 雖然此參數是字串 (不是系統區塊),您也可以使用大括弧 { },但只有在篩選條件不包含變數時。
  • Property 是可篩選的屬性。 如需 Exchange Server 和 Exchange Online 中可篩選屬性的詳細資訊,請參閱Filter 參數的可篩選屬性
  • 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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-Identity

Identity 參數會指定您要檢視的收件者物件。 您可以使用唯一識別收件者的任何值。 例如:

  • 名稱
  • 別名
  • 辨別名稱 (DN)
  • 辨別名稱 (DN)
  • 標準 DN
  • GUID
Type:RecipientIdParameter
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-IgnoreDefaultScope

此參數僅適用於內部部署 Exchange。

IgnoreDefaultScope 參數會指示命令忽略 Exchange PowerShell 會話的預設收件者範圍設定,並使用整個樹系作為範圍。 您不需要使用此參數指定值。

此參數可讓 命令存取預設範圍中目前無法使用的 Active Directory 物件,但也引進下列限制:

  • 您不能使用 DomainController 參數。 此命令會自動使用適當的通用類別目錄伺服器。
  • 您不能使用 DomainController 參數。 此命令會自動使用適當的通用類別目錄伺服器。
Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-IncludeBookmarkObject

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

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-IncludeSoftDeletedRecipients

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

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

注意:使用此參數搭配 Identity 或 RecipientTypeDetails 參數來取得 SoftDeletedRecipients。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-OrganizationalUnit

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

  • 名稱
  • 名稱
  • 辨別名稱 (DN)
  • GUID
Type:OrganizationalUnitIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection

-Properties

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

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-PropertySet

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

Type:PropertySet
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-ReadFromDomainController

此參數僅適用於內部部署 Exchange。

ReadFromDomainController 參數會指定應從使用者網域的網域控制站讀取的資訊。 您不需要使用此參數指定值。

命令: Set-AdServerSettings -ViewEntireForest $true 若要包含樹系中的所有物件,需要 ReadFromDomainController 參數。 否則,命令可能會使用包含過期資訊的通用類別目錄。 此外,您可能需要使用 ReadFromDomainController 參數來執行命令的多個反復專案,以取得資訊。

根據預設,收件者範圍會設定為裝載 Exchange 伺服器的網域。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-RecipientPreviewFilter

RecipientPreviewFilter 參數會測試您要在動態通訊群組、通訊清單或電子郵件地址原則中使用的收件者篩選。 此參數使用 LDAP 篩選語法。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-RecipientType

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

  • DynamicDistributionGroup
  • MailContact
  • MailNonUniversalGroup
  • MailUniversalDistributionGroup
  • MailUniversalSecurityGroup
  • MailUser
  • PublicFolder
  • UserMailbox

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

Type:RecipientType[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-RecipientTypeDetails

RecipientTypeDetails 參數會依指定的收件者子類型來篩選結果。 有效值為:

  • DiscoveryMailbox
  • DynamicDistributionGroup
  • EquipmentMailbox
  • GroupMailbox (Exchange 2013 或更新版本和雲端)
  • GuestMailUser (Exchange 2016 或更新版本和雲端)
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox (Exchange 2013 或更新版本和雲端)
  • MailContact
  • MailForestContact
  • MailNonUniversalGroup
  • MailUniversalDistributionGroup
  • MailUniversalSecurityGroup
  • MailUser
  • PublicFolder
  • PublicFolderMailbox (Exchange 2013 或更新版本和雲端)
  • RemoteEquipmentMailbox
  • RemoteRoomMailbox
  • RemoteSharedMailbox
  • RemoteTeamMailbox (Exchange 2013 或更新版本和雲端)
  • RemoteUserMailbox
  • RoomList
  • RoomMailbox
  • SchedulingMailbox (Exchange 2016 或更新版本和雲端)
  • SharedMailbox
  • SharedWithMailUser 僅 (雲端)
  • TeamMailbox (Exchange 2013 或更新版本和雲端)
  • UserMailbox

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

RecipientType 參數的值會影響您可以用於此參數的值。 例如,如果您使用 RecipientType 值 MailContact,就無法使用 UserMailbox 這個參數的值。 您會收到錯誤:任何指定的 RecipientTypeDetails 都不會包含在任何指定的收件者類型中。

Type:RecipientTypeDetails[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-ResultSize

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

Type:Unlimited
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

-SortBy

SortBy 參數會指定排序結果依據的屬性。 您一次只能依據一個屬性進行排序。 結果會以遞增順序排序。

如果預設檢視不包含您要排序的屬性,您可以使用 附加命令 | Format-Table -Auto Property1,Property2,...PropertyX 。 建立包含您想要查看之所有屬性的新檢視。 支援在屬性名稱中使用萬用字元 (*)。

您可以依下列內容排序:

  • 名稱
  • DisplayName
  • 別名
  • 城市
  • FirstName
  • LastName
  • Office
  • ServerLegacyDN
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection

輸入

Input types

若要查看此指令程式可接受的輸入類型,請參閱指令程式輸入和輸出類型。 如果指令程式的 [輸入類型] 欄位是空的,表示指令程式不接受輸入資料。

輸出

Output types

若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型),請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的,表示指令程式不會傳回資料。