Get-RemoteMailbox
內部部署 Exchange 才有提供此 Cmdlet。
使用 Get-RemoteMailbox 指令小程式來取得本地組織中與雲端服務相關信箱的使用者郵件屬性。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
語法
AnrSet
Get-RemoteMailbox
[-Anr <String>]
[-Archive]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>]
Identity
Get-RemoteMailbox
[[-Identity] <RemoteMailboxIdParameter>]
[-Archive]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>]
Description
Get-RemoteMailbox 指令小程式會取得郵件使用者在內部部署的 Active Directory中與郵件相關的屬性。 它不會取得相關的雲端信箱的屬性。 本地郵件使用者與相關雲端信箱的大多數郵件屬性應該是相同的。 不過,雲端信箱有額外屬性,使用這個 cmdlet 無法查看。 要查看雲端郵箱的屬性,你需要使用雲端服務中的 Exchange 管理中心,或連接到你的雲端組織並執行 Get-Mailbox cmdlet。
您必須已獲指派權限,才能執行此指令程式。 雖然這篇文章列出了 cmdlet 的所有參數,但如果某些參數未包含在你分配的權限中,你可能無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限,請參閱 Find the permissions required to run any Exchange cmdlet。
範例
範例 1
Get-RemoteMailbox
此範例回傳組織中所有遠端信箱的摘要清單。
範例 2
Get-RemoteMailbox -Identity laura@contoso.com | Format-List
此範例會回傳使用者遠端信箱 laura@contoso.com的詳細資訊。
範例 3
$Credentials = Get-Credential
Get-RemoteMailbox -Credential $Credentials
此範例使用替代憑證來取得一個或多個郵件啟用且服務中有郵箱的使用者清單。 如果你平常用的帳號沒有管理員權限,這很有用。 憑證用於存取內部部署的 Active Directory 網域控制器。
首先,執行以下指令提示你輸入憑證,然後將它們儲存在變數中。 然後用你提供的憑證,用第二個指令取得遠端信箱清單。
參數
-Anr
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Anr 參數會指定用來執行模糊名稱解析 (ANR) 搜尋的字串。 您可以指定部分字串,然後搜尋屬性符合該字串的物件。 搜尋的預設屬性如下:
- CommonName (CN)
- DisplayName
- FirstName
- LastName
- 別名
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
AnrSet
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Archive
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
在結果中返回使用者的歸檔信箱時,必須使用封存交換器。 您不需要使用此參數指定值。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Credential
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Credential 參數指定執行此指令所使用的使用者名稱和密碼。 通常您會在指令碼中使用此參數,或在您必須提供具有必要權限的其他認證時使用此參數。
此參數的值需要使用 Get-Credential Cmdlet。 若要暫停此命令並收到輸入認證的提示,請使用值 (Get-Credential)。 或者,在您執行此命令之前,將認證儲存在變數中 (例如,$cred = Get-Credential),然後將變數名稱 ($cred) 用於此參數。 如需詳細資訊,請參閱 Get-Credential。
參數屬性
| 類型: | PSCredential |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-DomainController
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
DomainController 參數會指定此 Cmdlet 用來向 Active Directory 讀取或寫入資料的網域控制站。 您可以透過網域控制站的完整網域名稱 (FQDN) 來識別網域控制站。 例如,dc01.contoso.com。
參數屬性
| 類型: | Fqdn |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Filter
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Filter 參數使用 OPATH 語法,依照指定的屬性與值來篩選結果。 搜尋準則使用語法 "Property -ComparisonOperator 'Value'"。
- 將整個 OPATH 濾波器包在雙引號中 “”。 如果篩選條件包含系統值 (例如
$true、$false或$null),請改為使用單引號 ' '。 雖然此參數是字串 (不是系統區塊),您也可以使用大括弧 { },但只有在篩選條件不包含變數時。 - Property 是可篩選的屬性。 欲了解更多關於 Exchange Server 與 Exchange Online 中可篩選屬性的資訊,請參閱 Filterable 屬性中的篩選參數。
- 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 |
-Identity
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Identity 參數指定你想查看的遠端信箱。 你可以使用任何能唯一識別遠端信箱的值。 例如:
- 名稱
- 別名
- 辨別名稱 (DN)
- 辨別名稱 (DN)
- 網域\使用者名稱
- 電子郵件地址
- GUID
- LegacyExchangeDN
- SamAccountName
- 使用者識別碼或使用者主要名稱 (UPN)
注意:Identity 參數的值$null或不存在的值,會回傳 所有 物件,就像你執行 Get- 指令時沒有 Identity 參數一樣。 請確認 Identity 參數的值清單是否準確,且不包含不存在的 $null 值。
參數屬性
| 類型: | RemoteMailboxIdParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Identity
| Position: | 1 |
| 必要: | False |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-IgnoreDefaultScope
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
IgnoreDefaultScope 交換器告訴指令忽略 Exchange PowerShell 會話的預設接收者範圍設定,並使用整個森林作為範圍。 您不需要使用此參數指定值。
此切換使指令能存取目前未在預設範圍內可用的 Active Directory 物件,但同時引入以下限制:
- 您不能使用 DomainController 參數。 此命令會自動使用適當的通用類別目錄伺服器。
- 您不能使用 DomainController 參數。 此命令會自動使用適當的通用類別目錄伺服器。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-OnPremisesOrganizationalUnit
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
OnPremisesOrganizationalUnit 參數會依據物件在 Active Directory 中的位置來篩選結果。
此參數的有效輸入是由 Get-OrganizationalUnit 指令碼返回 (OU) 或領域中的組織單位。 您可以使用唯一識別 OU 或網域的任何值。 例如:
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
參數屬性
| 類型: | OrganizationalUnitIdParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ReadFromDomainController
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
ReadFromDomainController 參數會指定應從使用者網域的網域控制站讀取的資訊。 您不需要使用此參數指定值。
指令: Set-AdServerSettings -ViewEntireForest $true 要包含森林中的所有物件需要 ReadFromDomainController 交換器。 否則,指令可能會使用包含過時資訊的全域目錄。 另外,你可能需要用 ReadFromDomainController 交換器執行多次指令來取得資訊。
預設情況下,接收範圍設定為承載你 Exchange 伺服器的網域。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ResultSize
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
ResultSize 參數會指定傳回的結果筆數上限。 若要傳回符合查詢的所有要求,請使用 unlimited 作為此參數的值。 預設值為 1000。
注意:域控制器的限制可能會影響無限制值的回傳結果數量。 如需詳細資訊,請參閱這篇文章。
參數屬性
| 類型: | Unlimited |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-SortBy
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
SortBy 參數會指定排序結果依據的屬性。 您一次只能依據一個屬性進行排序。 結果會以遞增順序排序。
如果預設視圖沒有包含你排序的屬性,你可以在指令 | Format-Table -Auto Property1,Property2,...PropertyX上加上 。 建立一個包含你想看到的所有屬性的新檢視。 支援在屬性名稱中使用萬用字元 (*)。
您可以依下列內容排序:
- 名稱
- DisplayName
- 別名
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 cmdlet 支援常見參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。
輸入
Input types
若要查看此指令程式可接受的輸入類型,請參閱指令程式輸入和輸出類型。 如果指令程式的 [輸入類型] 欄位是空的,表示指令程式不接受輸入資料。
輸出
Output types
若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型),請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的,表示指令程式不會傳回資料。