Download RDP File
The Download RDP file operation retrieves the Remote Desktop Protocol configuration file from the specified Virtual Machine.
Request
The Download RDP file request may be specified as follows. Replace <subscription-id> with the subscription ID, <cloudservice-name> with the name of the cloud service, <deployment-name> with the name of the deployment, and <roleinstance-name> the name of the Virtual Machine.
Method |
Request URI |
|---|---|
GET |
https://management.core.windows.net/<subscription-id>/services/hostedservices/<cloudservice-name>/deployments/<deployment-name>/roleinstances/<roleinstance-name>/ModelFile?FileType=RDP |
URI Parameters
URI Parameter |
Description |
|---|---|
FileType=RDP |
Required. Specifies that the file to retrieve is an RDP file. |
Request Headers
The following table describes the request headers.
Request Header |
Description |
|---|---|
x-ms-version |
Required. Specifies the version of the operation to use for this request. This header should be set to 2012-03-01 or higher. |
Request Body
None.
Response
The response includes an HTTP status code, a set of response headers, and a response body.
Status Code
A successful operation returns status code 200 (OK).
Response Headers
The response for this operation includes the following headers. The response may also include additional standard HTTP headers.
Response Header |
Description |
|---|---|
x-ms-request-id |
A value that uniquely identifies a request made against the management service. |
Response Body
The response body returned by the Download RDP file operation is a Remote Desktop Protocol (.rdp) file that can be used to establish a remote desktop session to the Virtual Machine.