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 is specified as follows. Replace <subscription-id> with your subscription ID, <cloudservice-name> with the name of your hosted service, <deployment-name> with the name of your deployment, and <roleinstance-name> the name of your virtual machine.
| Method | Request URI | HTTP Version |
|---|---|---|
|
GET |
|
HTTP/1.1 |
URI Parameters
| URI Parameter | Description |
|---|---|
|
FileType=RDP |
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. Currently this header should be set to 2012-03-01. |
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). For information about status codes, see Service Management Status and Error Codes.
Response Headers
The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
| Response Header | Description |
|---|---|
|
x-ms-request-id |
A value that uniquely identifies a request made against the Management service. For an asynchronous operation, you can call get operation status with the value of the header to determine whether the operation is complete, has failed, or is still in progress. See Tracking Asynchronous Service Management Requests for more information. |
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.
Authorization
Only the account owner may call this operation.
Remarks