remote_desktop_security_configuration_target_device_groups

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

Overview

Name	remote_desktop_security_configuration_target_device_groups
Type	Resource
Id	entra_id.service_principals.remote_desktop_security_configuration_target_device_groups

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.
displayName	string	Display name for the target device group.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
displayName	string	Display name for the target device group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_principal_id, target_device_group_id		Read the properties and relationships of a targetDeviceGroup object for the remoteDesktopSecurityConfiguration object on the servicePrincipal.
list	select	service_principal_id		Get a list of the targetDeviceGroup objects and their properties on the remoteDesktopSecurityConfiguration resource on the servicePrincipal. Any user authenticating using the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to a Microsoft Entra joined or Microsoft Entra hybrid joined device that belongs to the targetDeviceGroup will get SSO.
insert	insert	service_principal_id		Create a new targetDeviceGroup object for the remoteDesktopSecurityConfiguration object on the servicePrincipal. You can configure a maximum of 10 target device groups for the remoteDesktopSecurityConfiguration object on the servicePrincipal.
update	update	service_principal_id, target_device_group_id		Update the properties of a targetDeviceGroup object for remoteDesktopSecurityConfiguration object on the servicePrincipal. You can configure a maximum of 10 target device groups for the remoteDesktopSecurityConfiguraiton object on the servicePrincipal.
delete	delete	service_principal_id, target_device_group_id	If-Match	Delete a targetDeviceGroup object for the remoteDesktopSecurityConfiguration object on the servicePrincipal. Any user authenticating using the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to a Microsoft Entra joined or Microsoft Entra hybrid joined device that's in the removed targetDeviceGroup doesn't get SSO prompts.

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
target_device_group_id	string	The unique identifier of targetDeviceGroup
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of a targetDeviceGroup object for the remoteDesktopSecurityConfiguration object on the servicePrincipal.

SELECT
id,
displayName
FROM entra_id.service_principals.remote_desktop_security_configuration_target_device_groups
WHERE service_principal_id = '{{ service_principal_id }}' -- required
AND target_device_group_id = '{{ target_device_group_id }}' -- required
;

list

Get a list of the targetDeviceGroup objects and their properties on the remoteDesktopSecurityConfiguration resource on the servicePrincipal. Any user authenticating using the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to a Microsoft Entra joined or Microsoft Entra hybrid joined device that belongs to the targetDeviceGroup will get SSO.

SELECT
id,
displayName
FROM entra_id.service_principals.remote_desktop_security_configuration_target_device_groups
WHERE service_principal_id = '{{ service_principal_id }}' -- required
;

INSERT examples

insert

Create a new targetDeviceGroup object for the remoteDesktopSecurityConfiguration object on the servicePrincipal. You can configure a maximum of 10 target device groups for the remoteDesktopSecurityConfiguration object on the servicePrincipal.

INSERT INTO entra_id.service_principals.remote_desktop_security_configuration_target_device_groups (
id,
displayName,
service_principal_id
)
SELECT 
'{{ id }}',
'{{ displayName }}',
'{{ service_principal_id }}'
RETURNING
id,
displayName
;

Manifest

# Description fields are for documentation purposes
- name: remote_desktop_security_configuration_target_device_groups
props:
  - name: service_principal_id
    value: "{{ service_principal_id }}"
    description: Required parameter for the remote_desktop_security_configuration_target_device_groups resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Display name for the target device group.

UPDATE examples

update

Update the properties of a targetDeviceGroup object for remoteDesktopSecurityConfiguration object on the servicePrincipal. You can configure a maximum of 10 target device groups for the remoteDesktopSecurityConfiguraiton object on the servicePrincipal.

UPDATE entra_id.service_principals.remote_desktop_security_configuration_target_device_groups
SET 
id = '{{ id }}',
displayName = '{{ displayName }}'
WHERE 
service_principal_id = '{{ service_principal_id }}' --required
AND target_device_group_id = '{{ target_device_group_id }}' --required
RETURNING
id,
displayName;

DELETE examples

delete

Delete a targetDeviceGroup object for the remoteDesktopSecurityConfiguration object on the servicePrincipal. Any user authenticating using the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to a Microsoft Entra joined or Microsoft Entra hybrid joined device that's in the removed targetDeviceGroup doesn't get SSO prompts.

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