Create (POST) a VPNConnection [SPFSDK][VMMREF]

  • Article

 

Applies To: Windows Azure Pack

Creates a VPNConnection [SPFSDK][VMMREF] entity by using the HTTP POST operation.

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

  • Example: Create a new VPN connection

Request

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

Method

Request URI

HTTP Version

POST

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

HTTP/1.1

Request URI Parameters

This operation does not have any request URI parameters.

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

The request body should contain a single (depending on the request headers) XML or JSON encoded VPNConnection [SPFSDK][VMMREF] entity that you want to create. Here is the request body of a single entity.

{
   "odata.type":"VMM.VPNConnection",
   "AuthenticationMethod":"PSKOnly",
   "CloudVPNIPAddresses@odata.type":"Collection(Edm.String)",
   "CloudVPNIPAddresses":[

   ],
   "Description":null,
   "ID":"00000000-0000-0000-0000-000000000000",
   "LastConnectionError":null,
   "LastConnectionErrorCode":null,
   "LastRead":null,
   "MaximumBandwidthInboundKbps":"30000.0",
   "MaximumBandwidthOutboundKbps":"10000.0",
   "Name":"VPN Connection to other internal network.",
   "RunAsAccountId":"0cefe54f-64e2-476d-a40a-dada82a55488",
   "StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc",
   "Status":null,
   "TargetVPNIPv4Address":"192.168.1.44",
   "TargetVPNIPv6Address":null,
   "VMNetworkGatewayId":"6c5af99d-140b-4a6b-9329-059ef118bbbb"
}

Response

Response Codes

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

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 a single (depending on the request headers) XML or JSON encoded VPNConnection [SPFSDK][VMMREF] entity as it exists on the server.

{
   "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: Create a new VPN connection

This example demonstrates creating a new VPN connection on an existing 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");
Guid runAsAccountId = new Guid("0cefe54f-64e2-476d-a40a-dada82a55488");

var vpnConnection = new SpfVMM.VPNConnection();
vpnConnection.StampId = stampId;
vpnConnection.VMNetworkGatewayId = gatewayId;
vpnConnection.AuthenticationMethod = "PSKOnly";
vpnConnection.Name = "VPN Connection to other internal network.";
vpnConnection.MaximumBandwidthInboundKbps = 30000.0m;
vpnConnection.MaximumBandwidthOutboundKbps = 10000.0m;
vpnConnection.TargetVPNIPv4Address = "192.168.1.44";
vpnConnection.RunAsAccountId = runAsAccountId;

vmmService.AddToVPNConnections(vpnConnection);
vmmService.SaveChanges();

HTTP Request

POST https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/VPNConnections HTTP/1.1
DataServiceVersion: 3.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Content-Type: application/json;odata=minimalmetadata
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
Content-Length: 664
Expect: 100-continue

{"odata.type":"VMM.VPNConnection","AuthenticationMethod":"PSKOnly","CloudVPNIPAddresses@odata.type":"Collection(Edm.String)","CloudVPNIPAddresses":[],"Description":null,"ID":"00000000-0000-0000-0000-000000000000","LastConnectionError":null,"LastConnectionErrorCode":null,"LastRead":null,"MaximumBandwidthInboundKbps":"30000.0","MaximumBandwidthOutboundKbps":"10000.0","Name":"VPN Connection to other internal network.","RunAsAccountId":"0cefe54f-64e2-476d-a40a-dada82a55488","StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","Status":null,"TargetVPNIPv4Address":"192.168.1.44","TargetVPNIPv6Address":null,"VMNetworkGatewayId":"6c5af99d-140b-4a6b-9329-059ef118bbbb"}

HTTP Response

HTTP/1.1 201 Created
Cache-Control: no-cache
Content-Length: 729
Content-Type: application/json; odata=minimalmetadata; streaming=true; charset=utf-8
Location: https://contoso.com:30005/86e93b7f-25e3-4c44-8ca1-3ebdbd2dfc06/services/systemcenter/vmm/VPNConnections(ID=guid'6aa45ca5-eb1b-481f-a32c-ec2bcc26eb5c',StampId=guid'56ebc6dc-f63c-46e2-8438-2967e0ad83bc')
Server: Microsoft-IIS/8.5
x-ms-request-id: 1361e526-0fee-4619-a9eb-7b44b59ab297
X-Content-Type-Options: nosniff
request-id: 5fbd8ef2-63e6-0000-66ab-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:27:41 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.8318936Z"}

See Also

VPNConnections Collection [SPFSDK][VMMREF]
VPNConnection [SPFSDK][VMMREF]
Read (GET) a VPNConnection [SPFSDK][VMMREF]
Update (PUT) a VPNConnection [SPFSDK][VMMREF]
Delete (DELETE) a VPNConnection [SPFSDK][VMMREF]