Microsoft Entra ID (formerly Azure AD) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Applications Service Principals.remote Desktop Security…

16 actions 16 updates phrasing extends openapi/azure-ad-serviceprincipals-remotedesktopsecurityconfiguration-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Entra ID (formerly Azure AD)'s API. It is a proposal applied on top of the contract, not a document Microsoft Entra ID (formerly Azure AD) publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 16

$.info
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration'].get
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration'].delete
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration'].patch
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps'].get
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps'].post
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps/{approvedClientApp-id}'].get
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps/{approvedClientApp-id}'].delete
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps/{approvedClientApp-id}'].patch
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps/$count'].get
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups'].get
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups'].post
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups/{targetDeviceGroup-id}'].get
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups/{targetDeviceGroup-id}'].delete
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups/{targetDeviceGroup-id}'].patch
$.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups/$count'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Applications Service Principals.remote Desktop Security…
  version: 1.0.0
extends: openapi/azure-ad-serviceprincipals-remotedesktopsecurityconfiguration-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 15
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration'].get
  update:
    x-apievangelist-phrasing:
      intent: View an app's Remote Desktop security configuration
      effect: read
      questions:
      - Is Entra ID authentication for Remote Desktop turned on for this service principal?
      - Where can I see the RDP security settings configured on an app?
      instructions:
      - text: Show the remote desktop security configuration for service principal {sp}.
        slots:
          sp: path.servicePrincipal-id
      - text: Check whether RDP authentication is enabled on app {sp}.
        slots:
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an app's Remote Desktop security configuration
      effect: destructive
      questions:
      - What happens to RDP sign-in if I delete the remote desktop security configuration?
      - How do I remove the whole Remote Desktop security setup from a service principal?
      instructions:
      - text: Delete the remote desktop security configuration from service principal {sp}.
        slots:
          sp: path.servicePrincipal-id
      - text: Remove all RDP security settings from app {sp}.
        slots:
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable Entra RDP auth on an app
      effect: write
      questions:
      - How do I turn on Microsoft Entra ID authentication for Remote Desktop Protocol?
      - Can I switch off RDP protocol support on a service principal?
      instructions:
      - text: Set RDP enabled to {enabled} on service principal {sp}.
        slots:
          enabled: requestBody.isRemoteDesktopProtocolEnabled
          sp: path.servicePrincipal-id
      - text: Enable Entra authentication for Remote Desktop on app {sp}.
        slots:
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps'].get
  update:
    x-apievangelist-phrasing:
      intent: List approved Remote Desktop client apps
      effect: read
      questions:
      - Which client apps are approved for Remote Desktop connections on this app?
      - Can I see every approved RDP client configured on a service principal?
      instructions:
      - text: List the approved client apps for RDP on service principal {sp}.
        slots:
          sp: path.servicePrincipal-id
      - text: Show approved remote desktop clients on app {sp} named like {search}.
        slots:
          sp: path.servicePrincipal-id
          search: query.$search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a client app for Remote Desktop
      effect: write
      questions:
      - How do I add a new approved client app to the RDP security configuration?
      - Is there a maximum number of approved client apps per service principal?
      instructions:
      - text: Approve client app {name} for remote desktop on service principal {sp}.
        slots:
          name: requestBody.displayName
          sp: path.servicePrincipal-id
      - text: Add {name} as an approved RDP client on app {sp}.
        slots:
          name: requestBody.displayName
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps/{approvedClientApp-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one approved Remote Desktop client app
      effect: read
      questions:
      - What are the details of a specific approved RDP client app?
      - Can I look up one approved client app by its ID?
      instructions:
      - text: Get approved client app {app} from the RDP configuration of service principal {sp}.
        slots:
          app: path.approvedClientApp-id
          sp: path.servicePrincipal-id
      - text: Show details of approved remote desktop client {app} on app {sp}.
        slots:
          app: path.approvedClientApp-id
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps/{approvedClientApp-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an approved Remote Desktop client app
      effect: destructive
      questions:
      - How do I stop a client app from being approved for RDP?
      - Can I remove one approved client from the remote desktop configuration?
      instructions:
      - text: Delete approved client app {app} from the RDP configuration of service principal {sp}.
        slots:
          app: path.approvedClientApp-id
          sp: path.servicePrincipal-id
      - text: Revoke remote desktop approval for client {app} on app {sp}.
        slots:
          app: path.approvedClientApp-id
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps/{approvedClientApp-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename an approved Remote Desktop client app
      effect: write
      questions:
      - Can I change the display name of an approved RDP client app?
      - Is an approved remote desktop client editable after I add it?
      instructions:
      - text: Rename approved client app {app} on service principal {sp} to {name}.
        slots:
          app: path.approvedClientApp-id
          sp: path.servicePrincipal-id
          name: requestBody.displayName
      - text: Update approved remote desktop client {app} on app {sp}.
        slots:
          app: path.approvedClientApp-id
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/approvedClientApps/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count approved Remote Desktop client apps
      effect: read
      questions:
      - How many approved RDP client apps are configured, and am I near the limit of 20?
      - Can I get just the number of approved remote desktop clients?
      instructions:
      - text: Count the approved RDP client apps on service principal {sp}.
        slots:
          sp: path.servicePrincipal-id
      - text: Tell me how many approved remote desktop clients app {sp} has.
        slots:
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List Remote Desktop target device groups
      effect: read
      questions:
      - Which device groups skip the RDP consent prompt for this app?
      - Can I see all target device groups on the remote desktop configuration?
      instructions:
      - text: List the target device groups for RDP on service principal {sp}.
        slots:
          sp: path.servicePrincipal-id
      - text: Show remote desktop target device groups on app {sp} matching {filter}.
        slots:
          sp: path.servicePrincipal-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a Remote Desktop target device group
      effect: write
      questions:
      - How do I add a device group so users connecting to it don't get the RDP consent prompt?
      - What is the limit on target device groups for remote desktop?
      instructions:
      - text: Add target device group {name} to the RDP configuration of service principal {sp}.
        slots:
          name: requestBody.displayName
          sp: path.servicePrincipal-id
      - text: Create remote desktop target device group {group} named {name} on app {sp}.
        slots:
          group: requestBody.id
          name: requestBody.displayName
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups/{targetDeviceGroup-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Remote Desktop target device group
      effect: read
      questions:
      - What are the details of a specific RDP target device group?
      - Can I fetch one target device group by ID?
      instructions:
      - text: Get target device group {group} from the RDP configuration of service principal {sp}.
        slots:
          group: path.targetDeviceGroup-id
          sp: path.servicePrincipal-id
      - text: Show remote desktop target device group {group} on app {sp}.
        slots:
          group: path.targetDeviceGroup-id
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups/{targetDeviceGroup-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a Remote Desktop target device group
      effect: destructive
      questions:
      - Will users see the RDP consent prompt again if I remove a target device group?
      - How do I delete a device group from the remote desktop configuration?
      instructions:
      - text: Delete target device group {group} from the RDP configuration of service principal {sp}.
        slots:
          group: path.targetDeviceGroup-id
          sp: path.servicePrincipal-id
      - text: Remove remote desktop target device group {group} from app {sp}.
        slots:
          group: path.targetDeviceGroup-id
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups/{targetDeviceGroup-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a Remote Desktop target device group
      effect: write
      questions:
      - Can I change the display name of an RDP target device group?
      - Is a remote desktop target device group editable once added?
      instructions:
      - text: Rename target device group {group} on service principal {sp} to {name}.
        slots:
          group: path.targetDeviceGroup-id
          sp: path.servicePrincipal-id
          name: requestBody.displayName
      - text: Update remote desktop target device group {group} on app {sp}.
        slots:
          group: path.targetDeviceGroup-id
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count Remote Desktop target device groups
      effect: read
      questions:
      - How many target device groups are configured, and am I near the limit of 10?
      - Can I get just the number of RDP target device groups?
      instructions:
      - text: Count the RDP target device groups on service principal {sp}.
        slots:
          sp: path.servicePrincipal-id
      - text: Tell me how many remote desktop target device groups app {sp} has.
        slots:
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'