Get-EXOMailbox
此 Cmdlet 僅適用于 Exchange Online PowerShell 模組。 如需詳細資訊,請參閱關於 Exchange Online PowerShell 模組。
使用 Get-EXOMailbox Cmdlet 來檢視信箱物件和屬性、填入屬性頁,或提供信箱資訊給其他工作。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
Syntax
Get-EXOMailbox
[[-Identity] <String>]
[-Archive]
[-Async]
[-ExternalDirectoryObjectId <Guid>]
[-Filter <String>]
[-GroupMailbox]
[-InactiveMailboxOnly]
[-IncludeInactiveMailbox]
[-MailboxPlan <String>]
[-Migration]
[-OrganizationalUnit <String>]
[-PrimarySmtpAddress <String>]
[-Properties <String[]>]
[-PropertySets <PropertySet[]>]
[-PublicFolder]
[-RecipientTypeDetails <String[]>]
[-ResultSize <Unlimited>]
[-SoftDeletedMailbox]
[-UserPrincipalName <String>]
[<CommonParameters>]
Get-EXOMailbox
[-Anr <String>]
[-Archive]
[-Async]
[-Filter <String>]
[-GroupMailbox]
[-InactiveMailboxOnly]
[-IncludeInactiveMailbox]
[-MailboxPlan <String>]
[-Migration]
[-OrganizationalUnit <String>]
[-Properties <String[]>]
[-PropertySets <PropertySet[]>]
[-PublicFolder]
[-RecipientTypeDetails <String[]>]
[-ResultSize <Unlimited>]
[-SoftDeletedMailbox]
[<CommonParameters>]
Description
根據預設,此 Cmdlet 會傳回摘要清單 (組織中所有信箱) 的最小屬性集。
範例
範例 1
Get-EXOMailbox -ResultSize unlimited
此範例會傳回組織中所有信箱的摘要清單,並包含預設的最小輸出屬性集。 若要傳回其他屬性,請使用 Properties 和/或 PropertySets 參數。
範例 2
Get-EXOMailbox -PropertySets Archive
此範例會傳回 Archive 屬性集中定義的屬性。 如需這些屬性的完整清單,請參閱 Get-EXOMailbox 屬性集。
範例 3
Get-EXOMailbox -Properties Name,DistinguishedName,Guid -PropertySets Archive,Audit
此範例會傳回組織中所有信箱的摘要清單,並包含下列屬性:
- 封存和稽核屬性集中的屬性。
- Name 和 DistinguishedName 屬性。
範例 4
Get-EXOMailbox -Identity John@contoso.com -Properties DisplayName,EmailAddresses,Alias
這個範例會傳回信箱 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 |
-Archive
封存參數會依啟用封存的信箱篩選結果 (只會傳回具有封存信箱的信箱) 。 您不需要使用此參數指定值。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-Async
將保留此參數供 Microsoft 內部使用。
Type: | SwitchParameter |
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 是可篩選的屬性。 如需可篩選屬性的詳細資訊,請參閱 Get-EXOMailbox 屬性集 和 Filter 參數的 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 |
-GroupMailbox
將保留此參數供 Microsoft 內部使用。
Type: | SwitchParameter |
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 |
-InactiveMailboxOnly
InactiveMailboxOnly 參數會指定是否只傳回結果中的非作用中信箱。 您不需要使用此參數指定值。
非使用中信箱是指在虛刪除信箱之前,將其狀態設定為「訴訟資料暫留」或「就地保留」的信箱。 非作用中信箱的內容會保留,直到移除保留為止。
若要傳回結果中的使用中信箱和非作用中信箱,請勿使用此參數。 請改用 IncludeInactiveMailbox 參數。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-IncludeInactiveMailbox
IncludeInactiveMailbox 參數會指定是否要在結果中包含非作用中的信箱。 您不需要使用此參數指定值。
非使用中信箱是指在虛刪除信箱之前,將其狀態設定為「訴訟資料暫留」或「就地保留」的信箱。 非作用中信箱的內容會保留,直到移除保留為止。
若只要在結果中傳回非作用中的信箱,請勿使用此參數。 請改用 InactiveMailboxOnly 參數。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-MailboxPlan
MailboxPlan 參數會依信箱計畫篩選結果。 當您使用此參數時,結果中只會傳回指派指定信箱方案的信箱。 您可以使用唯一識別信箱計劃的任何值。 例如:
- 名稱
- 別名
- 顯示名稱
- 辨別名稱 (DN)
- GUID
信箱方案會指定雲端式組織中信箱使用者可用的許可權和功能。 您可以使用 Get-MailboxPlan 指令程式來檢視可用的信箱計劃。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-Migration
將保留此參數供 Microsoft 內部使用。
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-EXOMailbox 屬性集。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-PropertySets
PropertySets 參數會指定在此 Cmdlet 輸出中傳回之屬性的邏輯群組。 有效值為:
- 全部
- 最小 (這是預設值)
- AddressList
- 封存
- 稽核
- 自訂
- Delivery
- Hold
- 仲裁
- Move
- 原則
- PublicFolder
- 配額
- 資源
- 保留
- SCL
- SoftDelete
- StatisticsSeed
您可以指定多個以逗號分隔的值。
如需每個屬性集內含之屬性的詳細資訊,請參閱 Get-EXOMailbox 屬性集。
Type: | PropertySet[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-PublicFolder
將保留此參數供 Microsoft 內部使用。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Online |
-RecipientTypeDetails
RecipientTypeDetails 參數會依指定的信箱子類型來篩選結果。 有效值為:
- DiscoveryMailbox
- EquipmentMailbox
- GroupMailbox
- LegacyMailbox
- LinkedMailbox
- LinkedRoomMailbox
- RoomMailbox
- SchedulingMailbox
- SharedMailbox
- TeamMailbox
- UserMailbox
您可以指定多個以逗號分隔的值。
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 |
-SoftDeletedMailbox
需要 SoftDeletedMailbox 參數,才能在結果中傳回虛刪除的信箱。 您不需要使用此參數指定值。
虛刪除的信箱會刪除仍可復原的信箱。
Type: | SwitchParameter |
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 |
輸入
Input types
下列Get-Mailbox參數無法在 Get-EXOMailbox 中使用或無法運作:
- Async
- GroupMailbox
- 移轉
- PublicFolder
- SortBy
輸出
Output types
下列屬性不包含在 Get-EXOMailbox 的輸出中:
- RunspaceId
- Servername
- AdminDisplayVersion
- DelayReleaseHoldApplied
- EnforcedTimestamps
- 描述
- OriginatingServer
- IsValid
- ObjectState