Read (GET) a VPNNetworkRoute [SPFSDK][VMMREF]
Applies To: Windows Azure Pack
Gets a VPNNetworkRoute [SPFSDK][VMMREF] entity by using the HTTP GET operation.
For an example on how to get a single VPNNetworkRoute [SPFSDK][VMMREF] instance by ID, see Example: Read a VPN connection network route.
For an example on how to get a VPNNetworkRoute [SPFSDK][VMMREF] instance attached to a specific VPNConnection [SPFSDK][VMMREF], see Example: Read all network routes of a specific VPN connection.
For more information about the placeholders used in the URI, see URL placeholders.
The VPNNetworkRoutes collection does not allow reading all instances. You may only either query for a VPN network route by its identifier or by the identifier of the VPN connection it is associated with.
Method | Request URI | HTTP Version |
|---|---|---|
GET | https://{server}:{auth-port}/{subscription-id}/services/systemcenter/vmm/VPNNetworkRoutes(ID=Guid'[value]',StampId=Guid'[value]') | HTTP/1.1 |
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.
None
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 VPNNetworkRoute [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#VPNNetworkRoutes/@Element",
"StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc",
"ID":"4b56c695-61f5-4a68-a976-8506efc25ef3",
"VPNConnectionId":null,
"IPSubnet":"10.0.0.0/24"
}
This example reads a single VPN connection network route 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 networkRouteId = new Guid("4b56c695-61f5-4a68-a976-8506efc25ef3"); var networkRoute = vmmService.VPNNetworkRoutes.Where(v => v.StampId == stampId && v.ID == networkRouteId).First();
GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/VPNNetworkRoutes(StampId=guid'56ebc6dc-f63c-46e2-8438-2967e0ad83bc',ID=guid'4b56c695-61f5-4a68-a976-8506efc25ef3') 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: 5fbd8ef2-63e6-0000-9fb3-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: Thu, 15 May 2014 20:27:07 GMT
{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#VPNNetworkRoutes/@Element","StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"4b56c695-61f5-4a68-a976-8506efc25ef3","VPNConnectionId":null,"IPSubnet":"10.0.0.0/24"}
This example queries the VPNNetworkRoutes collection for any network route of a specific VPN connection.
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 vpnConnectionId = new Guid("ac145da5-e8b8-4259-aeec-15ec40db9c23"); var networkRoutes = vmmService.VPNNetworkRoutes.Where(v => v.StampId == stampId && v.VPNConnectionId == vpnConnectionId).ToList();
GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/VPNNetworkRoutes()?$filter=StampId%20eq%20guid'56ebc6dc-f63c-46e2-8438-2967e0ad83bc'%20and%20VPNConnectionId%20eq%20guid'ac145da5-e8b8-4259-aeec-15ec40db9c23' 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: 295
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-9cb3-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: Thu, 15 May 2014 20:27:06 GMT
{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#VPNNetworkRoutes","value":[{"StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"4b56c695-61f5-4a68-a976-8506efc25ef3","VPNConnectionId":null,"IPSubnet":"10.0.0.0/24"}]}