更新 remoteDesktopSecurityConfiguration

命名空间:microsoft.graph

更新 servicePrincipal 上 remoteDesktopSecurityConfiguration 对象的属性。 使用此配置可启用或禁用Microsoft Entra ID远程桌面服务 (RDS) 身份验证协议,以对用户进行身份验证,以Microsoft Entra加入或Microsoft Entra混合联接的设备。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ✅ ✅ ✅

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Application-RemoteDesktopConfig.ReadWrite.All Application.ReadWrite.All、Directory.ReadWrite.All
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 Application-RemoteDesktopConfig.ReadWrite.All Application.ReadWrite.All、Directory.ReadWrite.All

重要

对于使用工作或学校帐户的委派访问,登录用户必须是所有者或组的成员,或者分配有受支持的Microsoft Entra角色或授予此操作所需权限的自定义角色。 此操作支持以下内置角色,这些角色仅提供所需的最小特权:

  • 应用程序管理员
  • 云 应用程序管理员

HTTP 请求

PATCH /servicePrincipals/{servicePrincipalsId}/remoteDesktopSecurityConfiguration

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 必需。

请求正文

在请求正文中, 仅 提供要更新的属性的值。 请求正文中未包含的现有属性会保留其以前的值,或者根据对其他属性值的更改重新计算。

下表指定可更新的属性。

属性 类型 说明
isRemoteDesktopProtocolEnabled 布尔值 是否启用新Microsoft Entra ID远程桌面服务 (RDS) 身份验证协议来对用户进行身份验证,以Microsoft Entra加入或Microsoft Entra混合加入的设备。over RDP。 必填。

响应

如果成功,此方法在响应正文中返回响应 200 OK 代码和更新的 remoteDesktopSecurityConfiguration 对象。

示例

请求

以下示例显示了一个请求。

PATCH https://graph.microsoft.com/v1.0/servicePrincipals/00af5dfb-85da-4b41-a677-0c6b86dd34f8/remoteDesktopSecurityConfiguration
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.remoteDesktopSecurityConfiguration",
  "isRemoteDesktopProtocolEnabled": true
}

响应

以下示例显示了相应的响应。

注意:为了提高可读性,可能缩短了此处显示的响应对象。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.remoteDesktopSecurityConfiguration",
  "id": "ca738153-c98a-f822-a7d1-5a6e1058462b",
  "isRemoteDesktopProtocolEnabled": true
}