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

根據預設,這個 Cmdlet 會傳回摘要清單, (組織中所有信箱) 的一組最小屬性。

範例

範例 1

Get-EXOMailbox -ResultSize unlimited

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

範例 2

Get-EXOMailbox -PropertySets 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

適用: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 屬性集 和 Filter 參數的可篩選屬性。
  • 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

-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 參數會依指定的信箱子類型篩選結果。 有效值為:

  • DiscoveryMailbox
  • EquipmentMailbox
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox
  • RoomMailbox
  • SchedulingMailbox
  • 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
  • Servername
  • AdminDisplayVersion
  • DelayReleaseHoldApplied
  • EnforcedTimestamps
  • 描述
  • OriginatingServer
  • IsValid
  • ObjectState