Virtual Machines - Get Rdp File Contents

Service:

Dev Test Labs

API Version:

2018-09-15

Mendapatkan string yang mewakili konten file RDP untuk komputer virtual

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/getRdpFileContents?api-version=2018-09-15

Parameter URI

Name	In	Required	Type	Description
labName	path	True	string	Nama lab.
name	path	True	string	Nama mesin virtual.
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	ID langganan.
api-version	query	True	string	Versi API klien.

Respons

Name	Type	Description
200 OK	RdpConnection	OK
Other Status Codes	CloudError	BadRequest

Keamanan

azure_auth

Pemberian Implisit OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Akses Microsoft Azure

Contoh

VirtualMachines_GetRdpFileContents

Sample Request

HTTP

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{vmName}/getRdpFileContents?api-version=2018-09-15

Go

package armdevtestlabs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_GetRdpFileContents.json
func ExampleVirtualMachinesClient_GetRdpFileContents() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armdevtestlabs.NewVirtualMachinesClient("{subscriptionId}", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.GetRdpFileContents(ctx,
		"resourceGroupName",
		"{labName}",
		"{vmName}",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { DevTestLabsClient } = require("@azure/arm-devtestlabs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a string that represents the contents of the RDP file for the virtual machine
 *
 * @summary Gets a string that represents the contents of the RDP file for the virtual machine
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_GetRdpFileContents.json
 */
async function virtualMachinesGetRdpFileContents() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const name = "{vmName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.virtualMachines.getRdpFileContents(resourceGroupName, labName, name);
  console.log(result);
}

virtualMachinesGetRdpFileContents().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

200

{
  "contents": "full address:s:10.0.0.4\r\nprompt for credentials:i:1\r\nusername:s:{vmName}\\{userName}\r\n"
}

Definisi

CloudError	Kesalahan dari permintaan REST.
CloudErrorBody	Isi kesalahan dari permintaan REST.
RdpConnection	Mewakili file .rdp

CloudError

Kesalahan dari permintaan REST.

Name	Type	Description
error	CloudErrorBody	Kesalahan cloud yang terjadi

CloudErrorBody

Isi kesalahan dari permintaan REST.

Name	Type	Description
code	string	Kode kesalahan.
details	CloudErrorBody[]	Kesalahan dalam.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

RdpConnection

Mewakili file .rdp

Name	Type	Description
contents	string	Konten file .rdp