API Reference

List Remote Desktop Instances

Retrieve all remote desktop instances associated with a specific subscription.

This endpoint provides comprehensive information about remote desktop instances including their deployment status, resource associations, and operational metadata. Essential for monitoring remote desktop infrastructure and troubleshooting issues.

Use Cases:

  • Infrastructure Monitoring: Track all instances within a subscription
  • Status Dashboard: Display instance health and deployment status
  • Resource Management: Monitor instance-to-server resource mappings
  • Troubleshooting: Identify failed or problematic instance deployments
  • Capacity Planning: Assess instance distribution and resource utilization

Instance Information:

  • Instance identifiers, names, and current status
  • Creation and modification timestamps
  • Associated server subscription and instance mappings
  • Deployment status tracking (creating, deployed, error)

Monitoring Benefits:

  • Real-time visibility into remote desktop infrastructure
  • Early detection of deployment issues and failures
  • Resource correlation between remote desktop and server instances
  • Historical tracking of instance lifecycle and changes

Status Interpretation:

  • creating: Instance provisioning in progress
  • deployed: Instance ready for user access
  • error: Deployment failed, requires attention
Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!