Share via

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

  • Article

 

Applies To: Windows Azure Pack

Gets a VMNetwork [SPFSDK][VMMREF] entity or a set of entities by using the HTTP GET operation.

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

  • Example: Get a specific VMNetwork object

  • Example: Get all VMNetwork objects

Request

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/VMNetworks(ID=Guid'[value]',StampId=Guid'[value]')

HTTP/1.1

GET

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

HTTP/1.1

Request URI Parameters

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 the entity is associated with.

Request Headers

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.

Request Body

None

Response

Response Codes

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

Response Headers

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.

Response Body

The response body will contain either (depending on the request headers) an XML or JSON encoded VMNetwork [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#VMNetworks/@Element",
   "StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc",
   "ID":"c5e062ff-5172-4997-af1c-7044ac363579",
   "Name":"Tenant VM Network 1",
   "ExternalName":"",
   "Description":"",
   "IsolationType":"WindowsNetworkVirtualization",
   "PAIPAddressPoolType":"IPV4",
   "CAIPAddressPoolType":"IPV4",
   "Owner":{
      "UserName":"tenant@fabrikam.com",
      "RoleName":"tenant@fabrikam.com_86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06",
      "RoleID":"86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06"
   },
   "GrantedToList":[

   ],
   "LogicalNetworkId":"35353297-e499-4327-b5c6-25fe43694bcd",
   "LogicalNetworkName":"corp logical network",
   "AutoCreateSubnet":null,
   "IsAssigned":true,
   "Enabled":true,
   "AddedTime":"2014-05-05T13:52:33.8416602-07:00",
   "ModifiedTime":"2014-05-05T13:52:33.8416602-07:00",
   "PROTipID":null,
   "RoutingDomainId":"00000000-0000-0000-0000-000000000000"
}

Example: Get all VMNetwork objects

This example reads all the VM networks 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 networks = vmmService.VMNetworks.ToList();

HTTP Request

GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/VMNetworks 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 STRING}
x-ms-principal-id: tenant@fabrikam.com
Host: contoso.com:30005

HTTP Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 2420
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-b85e-be5fe663cf01
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, 05 May 2014 20:50:31 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#VMNetworks","value":[{"StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"c5e062ff-5172-4997-af1c-7044ac363579","Name":"Tenant VM Network 1","ExternalName":"","Description":"","IsolationType":"WindowsNetworkVirtualization","PAIPAddressPoolType":"IPV4","CAIPAddressPoolType":"IPV4","Owner":{"UserName":"tenant@fabrikam.com","RoleName":"tenant@fabrikam.com_86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06","RoleID":"86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06"},"GrantedToList":[],"LogicalNetworkId":"35353297-e499-4327-b5c6-25fe43694bcd","LogicalNetworkName":"corp logical network","AutoCreateSubnet":null,"IsAssigned":true,"Enabled":true,"AddedTime":"2014-05-05T13:49:23.9257175-07:00","ModifiedTime":"2014-05-05T13:49:23.9257175-07:00","PROTipID":null,"RoutingDomainId":"00000000-0000-0000-0000-000000000000"},{"StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"af6a7248-9d48-4149-917c-a6239e502a39","Name":"corp vmnetwork","ExternalName":"","Description":"","IsolationType":"NoIsolation","PAIPAddressPoolType":null,"CAIPAddressPoolType":null,"Owner":{"UserName":null,"RoleName":null,"RoleID":null},"GrantedToList":[{"UserName":null,"RoleName":"tenant@fabrikam.com_86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06","RoleID":"86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06"}],"LogicalNetworkId":"35353297-e499-4327-b5c6-25fe43694bcd","LogicalNetworkName":"corp logical network","AutoCreateSubnet":null,"IsAssigned":true,"Enabled":true,"AddedTime":"2014-05-05T13:49:23.9257175-07:00","ModifiedTime":"2014-05-05T13:49:23.9257175-07:00","PROTipID":null,"RoutingDomainId":"00000000-0000-0000-0000-000000000000"},{"StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"6b987265-153e-4545-8e9e-f53d1048dd49","Name":"Tenant VM Network 2","ExternalName":"","Description":"","IsolationType":"NoIsolation","PAIPAddressPoolType":null,"CAIPAddressPoolType":null,"Owner":{"UserName":null,"RoleName":null,"RoleID":null},"GrantedToList":[{"UserName":null,"RoleName":"tenant@fabrikam.com_86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06","RoleID":"86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06"}],"LogicalNetworkId":null,"LogicalNetworkName":null,"AutoCreateSubnet":null,"IsAssigned":true,"Enabled":true,"AddedTime":"2014-05-05T13:49:23.9257175-07:00","ModifiedTime":"2014-05-05T13:49:23.9257175-07:00","PROTipID":null,"RoutingDomainId":"00000000-0000-0000-0000-000000000000"}]}

Example: Get a specific VMNetwork object

This example reads a specific VM network 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 networkId = new Guid("c5e062ff-5172-4997-af1c-7044ac363579");

var network = vmmService.VMNetworks.Where(v => v.StampId == stampId && v.ID == networkId).FirstOrDefault();

HTTP Request

GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/VMNetworks(StampId=guid'56ebc6dc-f63c-46e2-8438-2967e0ad83bc',ID=guid'c5e062ff-5172-4997-af1c-7044ac363579') 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 STRING}
x-ms-principal-id: tenant@fabrikam.com
Host: contoso.com:30005

HTTP Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 912
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-d75e-be5fe663cf01
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, 05 May 2014 20:52:33 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#VMNetworks/@Element","StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"c5e062ff-5172-4997-af1c-7044ac363579","Name":"Tenant VM Network 1","ExternalName":"","Description":"","IsolationType":"WindowsNetworkVirtualization","PAIPAddressPoolType":"IPV4","CAIPAddressPoolType":"IPV4","Owner":{"UserName":"tenant@fabrikam.com","RoleName":"tenant@fabrikam.com_86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06","RoleID":"86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06"},"GrantedToList":[],"LogicalNetworkId":"35353297-e499-4327-b5c6-25fe43694bcd","LogicalNetworkName":"corp logical network","AutoCreateSubnet":null,"IsAssigned":true,"Enabled":true,"AddedTime":"2014-05-05T13:52:33.8416602-07:00","ModifiedTime":"2014-05-05T13:52:33.8416602-07:00","PROTipID":null,"RoutingDomainId":"00000000-0000-0000-0000-000000000000"}

See Also

VMNetworks Collection [SPFSDK][VMMREF]
VMNetwork [SPFSDK][VMMREF]
Create (POST) a VMNetwork [SPFSDK][VMMREF]
Update (PUT) a VMNetwork [SPFSDK][VMMREF]
Delete (DELETE) a VMNetwork [SPFSDK][VMMREF]