remote_desktop_security_configuration_approved_client_apps

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

Overview

Name	remote_desktop_security_configuration_approved_client_apps
Type	Resource
Id	entra_id.service_principals.remote_desktop_security_configuration_approved_client_apps

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	The display name of the approved client application.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
displayName	string	The display name of the approved client application.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_principal_id, approved_client_app_id		Read the properties and relationships of a approvedClientApp object for the remoteDesktopSecurityConfiguration object on a servicePrincipal.
list	select	service_principal_id		The collection of approved client apps that are associated with the RDS configuration. Supports $expand.
insert	insert	service_principal_id		Create a new approvedClientApp object for the remoteDesktopSecurityConfiguration object on a service principal. You can configure a maximum of 20 approved client apps.
update	update	service_principal_id, approved_client_app_id		Update the properties of an approvedClientApp object for a remotedesktopsecurityconfiguration.
delete	delete	service_principal_id, approved_client_app_id	If-Match

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
approved_client_app_id	string	The unique identifier of approvedClientApp
service_principal_id	string	The unique identifier of servicePrincipal
If-Match	string	ETag

SELECT examples

get

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

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

list

The collection of approved client apps that are associated with the RDS configuration. Supports $expand.

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

INSERT examples

insert

Create a new approvedClientApp object for the remoteDesktopSecurityConfiguration object on a service principal. You can configure a maximum of 20 approved client apps.

INSERT INTO entra_id.service_principals.remote_desktop_security_configuration_approved_client_apps (
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_approved_client_apps
props:
  - name: service_principal_id
    value: "{{ service_principal_id }}"
    description: Required parameter for the remote_desktop_security_configuration_approved_client_apps resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name of the approved client application.

UPDATE examples

update

Update the properties of an approvedClientApp object for a remotedesktopsecurityconfiguration.

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

DELETE examples

delete

No description available.

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