Share via

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

  • Article

 

Applies To: Windows Azure Pack

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

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

  • Example: Read the networking gateway assigned to a virtual network

  • Example: Read a networking gateway

Request

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

The VMNetworkGateways collection does not allow reading all instances. You may only either query for a gateway by its identifier or by the identifier of the associated VM network.

Method

Request URI

HTTP Version

GET

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

HTTP/1.1

Request URI Parameters

URI Parameter

Description

ID

[Edm.Guid] The identifier of the entity.

StampId

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

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 VMNetworkGateway [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#VMNetworkGateways/@Element",
   "StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc",
   "ID":"ca8f3799-6057-4dc0-80ad-7a2424be4bcb",
   "VMNetworkId":null,
   "Name":"Testing Gateway Entry 1",
   "Description":null,
   "IPSubnets":[
      "10.254.254.0/29"
   ],
   "RequiresVPN":null,
   "RequiresNAT":null,
   "EnableBGP":false,
   "AutonomousSystemNumber":null
}

Example: Read a networking gateway

This example reads a single networking gateway 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 gatewayId = new Guid("ca8f3799-6057-4dc0-80ad-7a2424be4bcb");

var gateway = vmmService.VMNetworkGateways.Where(vg => vg.ID == gatewayId && vg.StampId == stampId).First();

HTTP Request

GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/VMNetworkGateways(ID=guid'ca8f3799-6057-4dc0-80ad-7a2424be4bcb',StampId=guid'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 Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 434
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-f86e-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: Wed, 14 May 2014 22:50:44 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#VMNetworkGateways/@Element","StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"ca8f3799-6057-4dc0-80ad-7a2424be4bcb","VMNetworkId":null,"Name":"Testing Gateway Entry 1","Description":null,"IPSubnets":["10.254.254.0/29"],"RequiresVPN":null,"RequiresNAT":null,"EnableBGP":false,"AutonomousSystemNumber":null}

Example: Read the networking gateway assigned to a virtual network

This example queries the VMNetworkGateways collection for any gateway assigned to a specific virtual network.

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 virtualNetworkId = new Guid("c5e062ff-5172-4997-af1c-7044ac363579");

var gateways = vmmService.VMNetworkGateways.Where(vg => vg.VMNetworkId == virtualNetworkId && vg.StampId == stampId).ToList();

HTTP Request

GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/VMNetworkGateways()?$filter=VMNetworkId%20eq%20guid'c5e062ff-5172-4997-af1c-7044ac363579'%20and%20StampId%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 Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Length: 437
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-f56e-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: Wed, 14 May 2014 22:50:44 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#VMNetworkGateways","value":[{"StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"ca8f3799-6057-4dc0-80ad-7a2424be4bcb","VMNetworkId":null,"Name":"Testing Gateway Entry 1","Description":null,"IPSubnets":["10.254.254.0/29"],"RequiresVPN":null,"RequiresNAT":null,"EnableBGP":false,"AutonomousSystemNumber":null}]}

See Also

VMNetworkGateways Collection [SPFSDK][VMMREF]
VMNetworkGateway [SPFSDK][VMMREF]
Create (POST) a VMNetworkGateway [SPFSDK][VMMREF]
Update (PUT) a VMNetworkGateway [SPFSDK][VMMREF]
Delete (DELETE) a VMNetworkGateway [SPFSDK][VMMREF]