共用方式為


Get-EXOMailbox

此 cmdlet 僅在 Exchange Online PowerShell 模組中提供。 欲了解更多資訊,請參閱「關於 Exchange Online PowerShell 模組」。

使用 Get-EXOMailbox cmdlet 來檢視郵箱物件與屬性、填充屬性頁面,或提供信箱資訊給其他任務。

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

語法

Identity (預設值)

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

Anr

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

預設情況下,此指令小程式會回傳一份摘要清單, (組織中所有信箱) 的最低屬性集合。

範例

範例 1

Get-EXOMailbox -ResultSize unlimited

此範例回傳組織中所有郵箱的摘要清單,並包含預設的最小輸出屬性集合。 若要回傳更多屬性,請使用 Properties 和/或 PropertySets 參數。

範例 2

Get-EXOMailbox -PropertySets Archive

此範例回傳了封存屬性集中定義的屬性。 欲了解這些屬性的完整清單,請參見 Get-EXOMailbox 屬性集合。

範例 3

Get-EXOMailbox -Properties Name,DistinguishedName,Guid -PropertySets Archive,Audit

此範例回傳組織中所有信箱的摘要清單,並包含以下屬性:

  • 這些屬性在封存與審計屬性集合中。
  • 名稱與卓越名稱的特性。

範例 4

Get-EXOMailbox -Identity John@contoso.com -Properties DisplayName,EmailAddresses,Alias

此範例回傳信箱 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

-Archive

適用:Exchange Online

封存開關會依啟用歸檔功能的信箱過濾結果 (只有具備歸檔信箱的信箱會被) 。 您不需要使用此參數指定值。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Async

適用:Exchange Online

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

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
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-EXOMailbox 屬性集Filterable 屬性(Filter 參數)。
  • 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

-GroupMailbox

適用:Exchange Online

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

參數屬性

類型:SwitchParameter
預設值: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

-InactiveMailboxOnly

適用:Exchange Online

InactiveMailboxOnly 交換器會在結果中指定是否只回傳非活躍的信箱。 您不需要使用此參數指定值。

非使用中信箱是指在虛刪除信箱之前,將其狀態設定為「訴訟資料暫留」或「就地保留」的信箱。 非活躍信箱的內容會被保留,直到該保留物被移除。

若要同時返回結果中的活躍與非活躍信箱,請不要使用此交換器。 改用 IncludeInactiveMailbox 交換器。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-IncludeInactiveMailbox

適用:Exchange Online

IncludeInactiveMailbox 開關會指定是否將非活躍信箱納入結果。 您不需要使用此參數指定值。

非使用中信箱是指在虛刪除信箱之前,將其狀態設定為「訴訟資料暫留」或「就地保留」的信箱。 非活躍信箱的內容會被保留,直到該保留物被移除。

若要只在結果中返回非活躍的信箱,請不要使用這個開關。 改用 InactiveMailboxOnly 交換器。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-MailboxPlan

適用:Exchange Online

MailboxPlan 參數會依照郵箱計畫過濾結果。 使用此參數後,只有分配到指定郵箱計畫的信箱會回傳結果。 您可以使用唯一識別信箱計劃的任何值。 例如:

  • 名稱
  • 別名
  • 顯示名稱
  • 辨別名稱 (DN)
  • GUID

信箱計畫規範了雲端組織中信箱使用者可使用的權限與功能。 您可以使用 Get-MailboxPlan 指令程式來檢視可用的信箱計劃。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Migration

適用:Exchange Online

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

參數屬性

類型: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-EXOMailbox 屬性集。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-PropertySets

適用:Exchange Online

PropertySets 參數指定了該 cmdlet 輸出中回傳的屬性的邏輯分組。 有效值為:

  • 全部
  • 最低 (這是預設值)
  • AddressList
  • 封存
  • 稽核
  • 自訂
  • Delivery
  • Hold
  • 仲裁
  • Move
  • 原則
  • PublicFolder
  • 配額
  • 資源
  • 保留
  • SCL
  • SoftDelete
  • StatisticsSeed

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

欲了解更多關於每個屬性集中所包含屬性的資訊,請參閱 Get-EXOMailbox 屬性集合。

參數屬性

類型:

PropertySet[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-PublicFolder

適用:Exchange Online

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

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RecipientTypeDetails

適用:Exchange Online

RecipientTypeDetails 參數會依照指定的信箱子類型過濾結果。 有效值為:

  • 發現信箱
  • 設備郵箱
  • 傳承郵箱
  • LinkedMailbox
  • 連結室郵箱
  • 房間信箱
  • 排程郵件箱
  • SharedMailbox
  • TeamMailbox
  • UserMailbox

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

參數屬性

類型:

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

-SoftDeletedMailbox

適用:Exchange Online

SoftDeletedMailbox 交換器是必須的,才能在結果中回傳軟刪除的信箱。 您不需要使用此參數指定值。

軟刪除的信箱是指仍可恢復的已刪除信箱。

參數屬性

類型:SwitchParameter
預設值: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

輸入

Input types

以下 Get-Mailbox 參數在 Get-EXOMailbox 中無法使用或無法運作:

  • Async
  • GroupMailbox
  • 移轉
  • PublicFolder
  • SortBy

輸出

Output types

以下屬性未包含在 Get-EXOMailbox 的輸出中:

  • RunspaceID
  • 伺服器名稱
  • 管理員顯示版本
  • 延遲、釋放、暫停已套用
  • 強制時間戳記
  • 描述
  • 起源伺服器
  • IsValid
  • 物件狀態