Update (PUT) a VPNConnection [SPFSDK][VMMREF]

Article
08/24/2015

Applies To: Windows Azure Pack

Updates a VPNConnection [SPFSDK][VMMREF] entity by using the HTTP PUT operation.

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

Example: Reset VPN connection bandwidth

Request

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

Method	Request URI	HTTP Version
PUT	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	Required. [Edm.Guid] The identifier of the entity to update.
StampId	Required. [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

The request body should contain a single (depending on the request headers) XML or JSON encoded VPNConnection [SPFSDK][VMMREF] entity that is to be updated. Here is the request body of a single entity. This entity changes the EnableBGP property provided by the Create (POST) a VPNConnection [SPFSDK][VMMREF] operation example.

{
   "odata.type":"VMM.VPNConnection",
   "AuthenticationMethod":"PSKOnly",
   "CloudVPNIPAddresses@odata.type":"Collection(Edm.String)",
   "CloudVPNIPAddresses":[
      "157.54.160.148"
   ],
   "Description":"Unlimited bandwidth VPN connection.",
   "ID":"6aa45ca5-eb1b-481f-a32c-ec2bcc26eb5c",
   "LastConnectionError":null,
   "LastConnectionErrorCode":"0",
   "LastRead":"2014-05-15T16:27:41.8318936Z",
   "MaximumBandwidthInboundKbps":null,
   "MaximumBandwidthOutboundKbps":null,
   "Name":"VPN Connection to other internal network.",
   "RunAsAccountId":"0cefe54f-64e2-476d-a40a-dada82a55488",
   "StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc",
   "Status":"Enabled",
   "TargetVPNIPv4Address":"192.168.1.44",
   "TargetVPNIPv6Address":null,
   "VMNetworkGatewayId":null
}

Response

Response Codes

This operation does not return any non-standard OData response codes. If successful, it will return code 204 No Content.

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

None

Example: Reset VPN connection bandwidth

This example resets the bandwidth allowances on a VPN connection to unlimited.

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();

vpnConnection.MaximumBandwidthInboundKbps = null;
vpnConnection.MaximumBandwidthOutboundKbps = null;
vpnConnection.Description = "Unlimited bandwidth VPN connection.";

vmmService.UpdateObject(vpnConnection);
vmmService.SaveChanges();

HTTP Request

MERGE 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') 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: 699
Expect: 100-continue

{"odata.type":"VMM.VPNConnection","AuthenticationMethod":"PSKOnly","CloudVPNIPAddresses@odata.type":"Collection(Edm.String)","CloudVPNIPAddresses":["157.54.160.148"],"Description":"Unlimited bandwidth VPN connection.","ID":"6aa45ca5-eb1b-481f-a32c-ec2bcc26eb5c","LastConnectionError":null,"LastConnectionErrorCode":"0","LastRead":"2014-05-15T16:27:41.8318936Z","MaximumBandwidthInboundKbps":null,"MaximumBandwidthOutboundKbps":null,"Name":"VPN Connection to other internal network.","RunAsAccountId":"0cefe54f-64e2-476d-a40a-dada82a55488","StampId":"56ebc6dc-f63c-46e2-8438-2967e0ad83bc","Status":"Enabled","TargetVPNIPv4Address":"192.168.1.44","TargetVPNIPv6Address":null,"VMNetworkGatewayId":null}

HTTP Response

HTTP/1.1 204 No Content
Cache-Control: no-cache
Content-Length: 0
Server: Microsoft-IIS/8.5
x-ms-request-id: 82f2da6f-ac33-4035-b3a2-d0b7489c2d8b
X-Content-Type-Options: nosniff
request-id: 5fbd8ef2-63e6-0000-77ab-bf5fe663cf01
DataServiceVersion: 1.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:43 GMT

Share via