VPNConnection [SPFSDK][VMMREF]
Applies To: Windows Azure Pack
The VPNConnection entity represents a virtual private network (VPN) connection associated with a VM network.
Inheritance Hierarchy
VMM
VPNConnection
Entity Properties
For more information about how the properties of an entity interact with HTTP operations, see Entity Basics.
When querying the VPNConnections Collection [SPFSDK][VMMREF] using the HTTP GET operation, you must pass the StampId property along with either the ID or VMNetworkGatewayId property. See Read (GET) a VPNConnection [SPFSDK][VMMREF] for more information.
Name |
Create (POST) |
Read (GET) |
Update (PUT) |
Delete (DELETE) |
Type |
Nullable |
Description |
|---|---|---|---|---|---|---|---|
ID |
- |
Required |
Required |
Required |
Edm.Guid |
False |
Key Property The identifier of the entity. |
StampId |
Required |
Required |
Required |
Required |
Edm.Guid |
False |
Key Property The identifier of the stamp that contains the entity. |
AuthenticationMethod |
Optional |
- |
Optional |
- |
Edm.String |
True |
The VPN authentication method.
|
CloudVPNIPAddresses |
- |
- |
- |
- |
Collection(Edm.String) |
False |
IP Addresses of the VPN connection at the service provider (cloud). |
Description |
Optional |
- |
Optional |
- |
Edm.String |
True |
The description of the connection entity. |
LastConnectionError |
- |
- |
- |
- |
Edm.String |
True |
Error, if any, reported when the VPN connection state was last refreshed in VMM. |
LastConnectionErrorCode |
- |
- |
- |
- |
Edm.Int64 |
True |
Error code, if any, reported when the VPN connection state was last refreshed in VMM. |
LastRead |
- |
- |
- |
- |
Edm.DateTime |
True |
When the VPN connection state was last refreshed in VMM. |
MaximumBandwidthInboundKbps |
Optional |
- |
Optional |
- |
Edm.Decimal |
True |
Maximum provisioned bandwidth for inbound connections. |
MaximumBandwidthOutboundKbps |
Optional |
- |
Optional |
- |
Edm.Decimal |
True |
Maximum provisioned bandwidth for outbound connections. |
Name |
Optional |
- |
Optional |
- |
Edm.String |
True |
The name of the VPN connection. |
RunAsAccountId |
Required |
- |
Optional |
- |
Edm.Guid |
True |
The identifier of a run as account. |
Status |
- |
- |
Optional |
- |
Edm.String |
True |
Indicates if the connection is enabled, disabled, or in an error state. |
TargetVPNIPv4Address |
Required |
- |
Optional |
- |
Edm.String |
True |
A target VPN address in IPv4 format. |
TargetVPNIPv6Address |
Optional |
- |
Optional |
- |
Edm.String |
True |
A target VPN address in Ipv6 format. |
VMNetworkGatewayId |
Required |
Required |
Required |
- |
Edm.Guid |
True |
The identifier of the VPN gateway. |
Relationships
For more information about how the relationships of an entity are used, see Entity Basics.
Name |
Relationship Type |
From Property |
To Entity |
To Property |
|---|---|---|---|---|
NetworkRoutes |
Many |
Not specified |
Not specified |
OData Operations
This entity supports the following OData operations. See OData Operations for more information.
Name |
Has Parameters |
Return Type |
HTTP Method |
|---|---|---|---|
False |
VMM.VPNConnection |
POST |