remote_desktop_security_configuration

Creates, updates, deletes, gets or lists a remote_desktop_security_configuration resource.

Overview

Name	remote_desktop_security_configuration
Type	Resource
Id	entra_id.service_principals.remote_desktop_security_configuration

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
approvedClientApps	array	The collection of approved client apps that are associated with the RDS configuration. Supports $expand.
isRemoteDesktopProtocolEnabled	boolean	Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled.
targetDeviceGroups	array	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_principal_id		Read the properties and relationships of a remoteDesktopSecurityConfiguration object on a servicePrincipal. Use this configuration to view the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to authenticate a user to Microsoft Entra joined or Microsoft Entra hybrid joined devices. Additionally you can view any targetDeviceGroups that have been configured for SSO.
update	update	service_principal_id		Update the properties of a remoteDesktopSecurityConfiguration object on the servicePrincipal. Use this configuration to enable or disable the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to authenticate a user to Microsoft Entra joined or Microsoft Entra hybrid joined devices.
delete	delete	service_principal_id	If-Match	Delete a remoteDesktopSecurityConfiguration object on a servicePrincipal. Removing remoteDesktopSecurityConfiguration object on the servicePrincipal disables the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to authenticate a user to Microsoft Entra joined or Microsoft Entra hybrid joined devices, and removes any target device groups that you configured for SSO.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
service_principal_id	string	The unique identifier of servicePrincipal
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of a remoteDesktopSecurityConfiguration object on a servicePrincipal. Use this configuration to view the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to authenticate a user to Microsoft Entra joined or Microsoft Entra hybrid joined devices. Additionally you can view any targetDeviceGroups that have been configured for SSO.

SELECT
id,
approvedClientApps,
isRemoteDesktopProtocolEnabled,
targetDeviceGroups
FROM entra_id.service_principals.remote_desktop_security_configuration
WHERE service_principal_id = '{{ service_principal_id }}' -- required
;

UPDATE examples

update

Update the properties of a remoteDesktopSecurityConfiguration object on the servicePrincipal. Use this configuration to enable or disable the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to authenticate a user to Microsoft Entra joined or Microsoft Entra hybrid joined devices.

UPDATE entra_id.service_principals.remote_desktop_security_configuration
SET 
id = '{{ id }}',
isRemoteDesktopProtocolEnabled = {{ isRemoteDesktopProtocolEnabled }},
approvedClientApps = '{{ approvedClientApps }}',
targetDeviceGroups = '{{ targetDeviceGroups }}'
WHERE 
service_principal_id = '{{ service_principal_id }}' --required
RETURNING
id,
approvedClientApps,
isRemoteDesktopProtocolEnabled,
targetDeviceGroups;

DELETE examples

delete

Delete a remoteDesktopSecurityConfiguration object on a servicePrincipal. Removing remoteDesktopSecurityConfiguration object on the servicePrincipal disables the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to authenticate a user to Microsoft Entra joined or Microsoft Entra hybrid joined devices, and removes any target device groups that you configured for SSO.

DELETE FROM entra_id.service_principals.remote_desktop_security_configuration
WHERE service_principal_id = '{{ service_principal_id }}' --required
AND If-Match = '{{ If-Match }}'
;