通过


Exchange Online 管理员 API 概述

注意

本文中所述的功能目前为预览版,并非在所有组织中都可用,并且可能会发生更改。

Exchange Online 管理员 API 是基于 REST 的管理图面,可将一组重点 Exchange cmdlet 和参数用作仅 POST 终结点。 该 API 允许访问以前通过 Exchange Web Services (EWS) 提供的一些关键任务,计划 于 2026 年 10 月弃用。 API 是针对这些特定方案构建的,不会取代 Exchange Online PowerShell 中的完整 Exchange 管理图面。

Exchange Online 管理员 API 支持以下 Exchange 管理功能子集:

  • 查看组织 Exchange 配置:检索组织设置,例如接受的域、邮件提示配置和邮箱限制 (,例如 MaxSendSize) 。
  • 查看通讯组和动态通讯组成员身份
  • 查看和管理邮箱文件夹权限:读取和修改邮箱的文件夹权限 (查看、添加、设置和删除权限) 。
  • 查看和更新邮箱的“代表发送” (委派)

从 EWS 迁移的组织可以使用 管理员 API 通过 HTTP 实现类似的 cmdlet 样式管理,同时与现代自动化和治理模式集成。

Exchange Online 管理员 API 具有以下功能:

  • 基于 REST 的 cmdlet 样式图面:管理员 API 将一组重点 Exchange 管理任务公开为 HTTP 终结点。 使用 PowerShell cmdlet 的 Exchange 管理员应该感到很熟悉,但你通过 HTTP 调用它。
  • 仅限 POST 的作:每个作都使用 HTTP POST 方法。 每个请求指定所选终结点中该 cmdlet 支持的 cmdlet 和参数。
  • 作用域内 cmdlet 和参数集:API 不会显示每个 Exchange cmdlet 或参数。 每个终结点仅公开一部分 cmdlet,并且每个 cmdlet 支持参数子集。
  • 重点范围:API 涵盖一组有限的方案组织设置、组成员身份、邮箱文件夹权限和邮箱委派。 它不能完全替代 Exchange Online PowerShell。 相反,它是这些特定任务的补充 REST 优先图面。
  • 分页和属性选择:在页面中返回大型结果集。 在客户端,可以仅请求减小有效负载大小所需的属性。
  • 路由提示:对于所有作,API 使用 X-AnchorMailbox 标头将请求路由到正确的后端服务器。 有关详细信息,请参阅 Exchange Online API 入门
  • 安全访问:调用需要 OAuth 令牌和适当的 Exchange RBAC 角色。 有关详细信息,请参阅 Exchange Online 管理员 API 的身份验证和授权

管理员 API 与 Exchange Online PowerShell

管理员 API 提供 Exchange 管理功能的目标子集作为 REST 终结点,以涵盖受 EWS 弃用影响的方案。 Exchange Online PowerShell 继续提供完整的 Exchange 管理图面。

  • 管理员 API:需要 REST 优先、cmdlet 等效的图面时,请仅在) (组织配置、组成员身份、文件夹权限和委派的情况下使用。
  • Exchange Online PowerShell:在需要 Exchange cmdlet、高级作或现有 PowerShell 脚本和 Runbook 的完整范围时使用。

Exchange Online 管理员 API 不能替代 Exchange Online PowerShell。 API 是一个基于 REST 的补充图面,用于由已弃用的 EWS 方案引起的一组重点管理任务。 对于所有其他 Exchange 管理任务,请继续使用 Exchange Online PowerShell。

Exchange Online 管理员 API 终结点

每个管理员 API 终结点都提供一个或多个 cmdlet 来替换以前通过 EWS 提供的功能。 下表提供了有关每个终结点和相应 EWS 替代项的详细信息。

Endpoint 说明 EWS 操作
OrganizationConfig 检索与邮件提示设置相关的组织级 Exchange 配置。 GetServiceConfiguration
AcceptedDomain 查看组织的接受域及其配置。 GetServiceConfiguration
邮箱 查看邮箱属性。 例如:显示名称、主 SMTP 地址、大小限制和委托信息 (查看和更新) 。 AddDelegate 和 RemoveDelegate
MailboxFolderPermission 查看和管理邮箱文件夹的权限, () 添加、设置和删除权限。 GetFolder、UpdateFolder 和 CreateFolder
DistributionGroupMember 检索通讯组的成员身份详细信息。 ExpandDL
DynamicDistributionGroupMember 检索动态通讯组的成员身份详细信息。 ExpandDL

后续步骤