Read (GET) a GuestInfo [SPFSDK][VMMREF]

 

Applies To: Windows Azure Pack

Gets a GuestInfo [SPFSDK][VMMREF] entity by using the HTTP GET operation.

Here is a list of examples related to this collection operation.

For more information about returning multiple entities, see Common GET HTTP Info.

Method

Request URI

HTTP Version

GET

https://{server-name}:{auth-port}/{subscription-id}/services/systemcenter/vmm/GuestInfos(StampId=Guid'[value]',VMId=Guid'[value]')

HTTP/1.1

URI Parameter

Description

StampId

Required. [Edm.Guid] The type identifier of the stamp that restricts the query. You require a value for this parameter to read a specific entity.

VMId

Required. [Edm.Guid] The type identifier of the virtual machine. You require a value for this parameter to read a specific entity.

This operation does not use any non-standard request headers.

For more information about the common request headers used by this operation, see Common HTTP request information.

This operation does not return any non-standard OData response codes. If successful, it will return code 200 OK.

This operation does not use any non-standard response headers.

For more information about the common response headers used by this operation, see Common HTTP response information.

The response body will contain either (depending on the request headers) an XML or JSON encoded GuestInfo [SPFSDK][VMMREF] entity or entities. Here is the response body of a single entity.

{
  "odata.metadata": "https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/$metadata#GuestInfos/@Element",
  "IPv4Addresses": "127.0.0.1;",
  "IPv6Addresses": "::1;",
  "VMId": "c6cd770c-ae05-46bc-868a-c83af9363cd9",
  "StampId": "d70c1a9b-c241-48f5-880a-b6c36071e653"
}

This example reads guest information from a virtual machine. This requires that the virtual machine is started and has had the virtualization guest services installed.

For more information about how to get started with using the code examples provided in this programming guide, see Program in Visual Studio with the Windows Azure Pack IaaS Resource Provider [SPFSDK].

Guid stampId = new Guid("d70c1a9b-c241-48f5-880a-b6c36071e653");
Guid vmId = new Guid("c6cd770c-ae05-46bc-868a-c83af9363cd9");

var vmGuestInfo = vmmService.GuestInfos.Where(c => c.StampId == stampId && c.VMId == vmId).ToList();

GET https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/GuestInfos(StampId=guid'd70c1a9b-c241-48f5-880a-b6c36071e653',VMId=guid'c6cd770c-ae05-46bc-868a-c83af9363cd9') HTTP/1.1
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/json;odata=minimalmetadata
Accept-Charset: UTF-8
DataServiceUrlConventions: KeyAsSegment
User-Agent: Microsoft ADO.NET Data Services
Authorization: Bearer {ENCODED AUTHENTICATION TOKEN}
x-ms-principal-id: tenant@fabrikam.com
Host: contoso.com:30005

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 292
Content-Type: application/json; odata=minimalmetadata; streaming=true; charset=utf-8
Server: Microsoft-IIS/8.5
X-Content-Type-Options: nosniff
request-id: d3df681c-b278-0000-9e7d-e2d378b2cf01
DataServiceVersion: 3.0;
Server: Microsoft-IIS/8.5
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
X-Powered-By: ASP.NET
Date: Fri, 19 Sep 2014 21:07:33 GMT

{"odata.metadata":"https://contoso.com:30005/ae122d5f-3aab-4d75-ad48-d6593246a49e/services/systemcenter/vmm/$metadata#GuestInfos/@Element","IPv4Addresses":"127.0.0.1;","IPv6Addresses":"::1;","VMId":"c6cd770c-ae05-46bc-868a-c83af9363cd9","StampId":"d70c1a9b-c241-48f5-880a-b6c36071e653"}
Show: