Share via

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

  • Article

 

Applies To: Windows Azure Pack

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

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

  • Example: Read a VPN connection

  • Example: Read the VPN connections assigned to VM network gateway

Request

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

The VPNConnections collection does not allow reading all instances. You may only either query for a VPN connection by its identifier or by the identifier of the VM network gateway it is associated with.

Method

Request URI

HTTP Version

GET

https://{server}:{auth-port}/{subscription-id}/services/systemcenter/vmm/VPNConnections(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 VPNConnection [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#VPNConnections/@Element",
   "StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc",
   "ID":"6aa45ca5-eb1b-481f-a32c-ec2bcc26eb5c",
   "VMNetworkGatewayId":null,
   "Name":"VPN Connection to other internal network.",
   "Description":null,
   "TargetVPNIPv4Address":"192.168.1.44",
   "TargetVPNIPv6Address":null,
   "CloudVPNIPAddresses":[
      "157.54.160.148"
   ],
   "AuthenticationMethod":"PSKOnly",
   "RunAsAccountId":"0cefe54f-64e2-476d-a40a-dada82a55488",
   "Status":"Enabled",
   "LastConnectionError":null,
   "LastConnectionErrorCode":"0",
   "MaximumBandwidthInboundKbps":"30000",
   "MaximumBandwidthOutboundKbps":"10000",
   "LastRead":"2014-05-15T16:27:41.8318936Z"
}

Example: Read a VPN connection

This example reads a single VPN connection 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 vpnConnectionId = new Guid("6aa45ca5-eb1b-481f-a32c-ec2bcc26eb5c");

var vpnConnection = vmmService.VPNConnections.Where(b => b.StampId == stampId && b.ID == vpnConnectionId).First();

HTTP Request

GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/VPNConnections(StampId=guid'56ebc6dc-f63c-46e2-8438-2967e0ad83bc',ID=guid'6aa45ca5-eb1b-481f-a32c-ec2bcc26eb5c') 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: 724
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-73ab-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 16:30:03 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#VPNConnections/@Element","StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"6aa45ca5-eb1b-481f-a32c-ec2bcc26eb5c","VMNetworkGatewayId":null,"Name":"VPN Connection to other internal network.","Description":null,"TargetVPNIPv4Address":"192.168.1.44","TargetVPNIPv6Address":null,"CloudVPNIPAddresses":["157.54.160.148"],"AuthenticationMethod":"PSKOnly","RunAsAccountId":"0cefe54f-64e2-476d-a40a-dada82a55488","Status":"Enabled","LastConnectionError":null,"LastConnectionErrorCode":"0","MaximumBandwidthInboundKbps":"30000","MaximumBandwidthOutboundKbps":"10000","LastRead":"2014-05-15T16:27:41.833"}

Example: Read the VPN connections assigned to VM network gateway

This example queries the VPNConnections collection for any VPN connection associated with a specific VM network gateway.

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("6c5af99d-140b-4a6b-9329-059ef118bbbb");

var vpnConnections = vmmService.VPNConnections.Where(b => b.StampId == stampId && b.VMNetworkGatewayId == gatewayId).ToList();

HTTP Request

GET https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/VPNConnections()?$filter=StampId%20eq%20guid'56ebc6dc-f63c-46e2-8438-2967e0ad83bc'%20and%20VMNetworkGatewayId%20eq%20guid'6c5af99d-140b-4a6b-9329-059ef118bbbb' 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: 732
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-70ab-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 16:30:03 GMT

{"odata.metadata":"https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/$metadata#VPNConnections","value":[{"StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","ID":"6aa45ca5-eb1b-481f-a32c-ec2bcc26eb5c","VMNetworkGatewayId":null,"Name":"VPN Connection to other internal network.","Description":null,"TargetVPNIPv4Address":"192.168.1.44","TargetVPNIPv6Address":null,"CloudVPNIPAddresses":["157.54.160.148"],"AuthenticationMethod":"PSKOnly","RunAsAccountId":"0cefe54f-64e2-476d-a40a-dada82a55488","Status":"Enabled","LastConnectionError":null,"LastConnectionErrorCode":"0","MaximumBandwidthInboundKbps":"30000","MaximumBandwidthOutboundKbps":"10000","LastRead":"2014-05-15T16:27:41.8318936Z"}]}

See Also

VPNConnections Collection [SPFSDK][VMMREF]
VPNConnection [SPFSDK][VMMREF]
Create (POST) a VPNConnection [SPFSDK][VMMREF]
Update (PUT) a VPNConnection [SPFSDK][VMMREF]
Delete (DELETE) a VPNConnection [SPFSDK][VMMREF]