Bewerken

Delen via

remoteDesktopSecurityConfiguration resource type

  • Artikel

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents the configuration for the remoteDesktopSecurityConfiguration object on the servicePrincipal.

Use this configuration to enable the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol, for Microsoft Entra ID to authenticate users to joined or hybrid joined devices. The configuration also enables single sign-on (SSO) when RDP clients connect to a Microsoft Entra joined or Microsoft Entra hybrid joined device that is part of the targetDeviceGroups object.

Inherits from entity.

Methods

Method Return type Description
Create remoteDesktopSecurityConfiguration Create a new remoteDesktopSecurityConfiguration object on the servicePrincipal object.
Get remoteDesktopSecurityConfiguration Read the properties and relationships of a remoteDesktopSecurityConfiguration object on the servicePrincipal object.
Update remoteDesktopSecurityConfiguration Update the properties of a remoteDesktopSecurityConfiguration object on the servicePrincipal object.
Delete None Delete a remoteDesktopSecurityConfiguration object on a servicePrincipal object.

Properties

Property Type Description
id String Unique identifier for the RDS security configuration. Inherited from entity.
isRemoteDesktopProtocolEnabled Boolean Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled.

Relationships

Relationship Type Description
targetDeviceGroups targetDeviceGroup collection The collection of target device groups that are associated with the RDS security configuration that will be enabled for SSO when a client connects to the target device over RDP using the new Microsoft Entra ID RDS authentication protocol.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.remoteDesktopSecurityConfiguration",
  "id": "String (identifier)",
  "isRemoteDesktopProtocolEnabled": "Boolean"
}