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

 

Applies To: Windows Azure Pack

Reads a Virtual Machine Subnet 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.

For more information about the placeholders used in the URI, see URL placeholders.

Method

Request URI

HTTP Version

GET

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

HTTP/1.1

GET

https://{server}:{auth-port}/{subscription-id}/services/systemcenter/vmm/VMSubnets

HTTP/1.1

This table only applies when reading a specific entity.

URI Parameter

Description

ID

[Edm.Guid] The identifier of the entity.

StampId

[Edm.Guid] The identifier of the stamp that restricts the query.

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 VMSubnet [SPFSDK][VMMREF] entity or entities. Here is the response body of a single entity.


{
   "odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#VMSubnets/@Element",
   "Name":"Default Subnet",
   "Subnet":"192.168.10.0/24",
   "VMNetworkName":"My Network 1 - User1",
   "StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc",
   "ID":"8d81fdda-471a-4a0b-8bb4-7a3a9bad00a5",
   "VMNetworkId":"6ebb7369-e007-4975-9094-06dc84453dfa"
}

This example reads all the VM subnets available to the authenticated tenant.

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].

var subnets = vmmService.VMSubnets.Where(s => s.StampId == new Guid("56ebc6dc-f63c-46e2-8438-2967e0ad83bc")).ToList();

GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/VMSubnets()?$filter=StampId%20eq%20guid'56ebc6dc-f63c-46e2-8438-2967e0ad83bc' 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: 651
Content-Type: application/json; odata=minimalmetadata; streaming=true; charset=utf-8
Server: Microsoft-IIS/8.5
X-Content-Type-Options: nosniff
request-id: 5fbd8ef2-63e6-0000-9033-bf5fe663cf01
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: Mon, 12 May 2014 15:06:33 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#VMSubnets","value":[{"Name":"Default Subnet","Subnet":"192.168.10.0/24","VMNetworkName":"My Network 1 - User1","StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"8d81fdda-471a-4a0b-8bb4-7a3a9bad00a5","VMNetworkId":"6ebb7369-e007-4975-9094-06dc84453dfa"},{"Name":"Tenant VM Network 1-53b9fb689dd14733a86a5626a0dc5fb4","Subnet":"10.0.0.0/24","VMNetworkName":"Tenant VM Network 1","StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"175cf7d0-4a63-49ea-a0d8-8325f20273b2","VMNetworkId":"c5e062ff-5172-4997-af1c-7044ac363579"}]}


This example reads a specific VM subnet by identifier.

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("56ebc6dc-f63c-46e2-8438-2967e0ad83bc");
Guid subnetId = new Guid("8d81fdda-471a-4a0b-8bb4-7a3a9bad00a5");

var subnet = vmmService.VMSubnets.Where(s => s.StampId == stampId && s.ID == subnetId).FirstOrDefault();


GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/VMSubnets(StampId=guid'56ebc6dc-f63c-46e2-8438-2967e0ad83bc',ID=guid'8d81fdda-471a-4a0b-8bb4-7a3a9bad00a5') 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
Connection: Keep-Alive



HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 381
Content-Type: application/json; odata=minimalmetadata; streaming=true; charset=utf-8
Server: Microsoft-IIS/8.5
X-Content-Type-Options: nosniff
request-id: 5fbd8ef2-63e6-0000-df33-bf5fe663cf01
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: Mon, 12 May 2014 15:11:59 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#VMSubnets/@Element","Name":"Default Subnet","Subnet":"192.168.10.0/24","VMNetworkName":"My Network 1 - User1","StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"8d81fdda-471a-4a0b-8bb4-7a3a9bad00a5","VMNetworkId":"6ebb7369-e007-4975-9094-06dc84453dfa"}

Show: