共用方式為


Exchange Online 管理員 API 概述

注意事項

本文所述的功能目前處於預覽階段,並非所有組織都能提供,且可能會有所變動。

Exchange Online 管理員 API 是一個基於 REST 的管理表面,能將一組聚焦的 Exchange 指令小程式與參數作為僅限 POST 的端點。 該 API 允許存取先前透過 Exchange Web Services (EWS) 提供的幾個關鍵任務,該 EWS 預計於 2026 年 10 月淘汰。 API 是為這些特定情境設計的,並不會取代 Exchange Online PowerShell 中完整的 Exchange 管理介面。

Exchange Online 管理員 API 支援以下 Exchange 管理子集功能:

  • 查看組織 Exchange 設定:取得組織設定,例如接受的網域、MailTips 設定及信箱限制, (例如 MaxSendSize) 。
  • 查看分發群組與動態分發群組成員資料
  • 檢視與管理信箱資料夾權限:閱讀及修改信箱資料夾權限 (檢視、新增、設定及移除權限) 。
  • 查看並更新「代表發送」 (信箱)

遷移出 EWS 的組織可利用管理員 API 透過 HTTP 實現類似 cmdlet 式的管理,同時整合現代自動化與治理模式。

Exchange Online 管理員 API 具備以下功能:

  • 基於 REST 的 cmdlet 風格表面:管理員 API 將一組聚焦的 Exchange 管理任務作為 HTTP 端點揭露。 對於使用 PowerShell 指令程式的 Exchange 管理員來說,應該會覺得熟悉,但你是透過 HTTP 來呼叫它。
  • 僅 POST 操作:每個操作皆使用 HTTP POST 方法。 每個請求都指定一個 cmdlet 以及該 cmdlet 在所選端點中所支援的參數。
  • 有範圍的指令匣和參數集合:API 不會顯示每個 Exchange 指令檔或參數。 每個端點只暴露一部分 cmdlet,且每個 cmdlet 支援部分參數。
  • 重點範圍:API 涵蓋有限的情境組合——組織設定、群組成員資格、信箱資料夾權限及信箱委派。 它並不是 Exchange Online PowerShell 的完整替代品。 相反地,它是一個輔助且以 REST 為優先的表面,專門用於這些特定任務。
  • 分頁與屬性選擇:大型結果集以頁面形式回傳。 在客戶端,你只能請求需要的屬性來減少有效載荷大小。
  • 路由提示:對於所有操作,API 會使用 X-AnchorMailbox 標頭將你的請求路由到正確的後端伺服器。 欲了解更多資訊,請參閱「開始使用 Exchange Online API」。
  • 安全存取:通話需使用OAuth代幣及適當的交易所RBAC角色。 欲了解更多資訊,請參閱 Exchange Online 管理員 API 的認證與授權

管理員 API 與 Exchange Online PowerShell 的比較

管理員 API 提供針對性的 Exchange 管理功能子集,作為 REST 端點,以涵蓋受 EWS 棄用影響的情境。 Exchange Online PowerShell 持續提供完整的 Exchange 管理介面。

  • 管理員 API:當您需要一個 REST 優先、相當於 cmdlet 的 surface 時,僅用於上述 (描述的組織設定、群組成員、資料夾權限及委派) 情境。
  • Exchange Online PowerShell:當你需要完整的 Exchange 指令集、進階操作,或現有的 PowerShell 腳本和執行手冊時,可以使用。

Exchange Online 管理員 API 並不是 PowerShell Exchange Online替代品。 API 是一個互補的基於 REST 的表面,用於針對已棄用 EWS 情境所產生的一組專注管理任務。 對於所有其他 Exchange 管理任務,請繼續使用 Exchange Online PowerShell。

Exchange Online 管理員 API 端點

每個管理員 API 端點都會提供一個或多個 cmdlet,以取代 EWS 先前可用的功能。 下表提供各端點及相應EWS替代方案的詳細資訊。

端點 描述 EWS 作業
OrganizationConfig 取得與 MailTips 設定相關的組織層級 Exchange 設定。 GetServiceConfiguration
AcceptedDomain 查看接受的網域及其組織的配置。 GetServiceConfiguration
信箱 查看信箱物業。 例如:顯示名稱、主要 SMTP 位址、大小限制,以及 (檢視與更新) 的委派資訊。 新增代表與移除代表
MailboxFolderPermission 查看和管理信箱資料夾的權限 (新增、設定及移除權限) 。 GetFolder、UpdateFolder 和 CreateFolder
DistributionGroup成員 取得分發群組的會員資料。 擴展DL
動態分布群組成員 取得動態分配群組的會員資料。 擴展DL

後續步驟