VPNConnection
Applies To: System Center 2016 - Service Provider Foundation, System Center Technical Preview
VPNConnection
Creates, reads, updates, and deletes virtual private network (VPN) connections associated with virtual machines.
HTTP Verbs
GET | POST | PUT | DELETE |
---|---|---|---|
Yes | Yes | Yes | Yes |
GET
Gets the specified VPN connections.
Entity Properties
Name | Type | Mandatory | Description |
---|---|---|---|
StampId | Edm.Guid | Yes | The identifier of the stamp that restricts the query. |
ID | Edm.Guid | Yes | The identifier of the VPN connection. |
VMMNetworkGatewayID | Edm.Guid | Yes | Specifies a VM network gateway object. |
POST
Creates a new VPN connection.
Entity Properties
Name | Type | Mandatory | Description |
---|---|---|---|
StampId | Edm.Guid | Yes | The identifier of the stamp that restricts the query. |
ID | Edm.Guid | Yes | The identifier of the VPN connection. |
Name | Edm.String | Yes | The name of the VMM object. |
VMMNetworkGatewayID | Edm.Guid | Yes | A VM network gateway object. |
PUT
Updates a VPN connection.
Entity Properties
Name | Type | Mandatory | Description |
---|---|---|---|
StampId | Edm.Guid | Yes | The identifier of the stamp that restricts the query. |
ID | Edm.Guid | Yes | The identifier of the VPN connection. |
AuthenticationMethod | Edm.String | No | Specifies the numerical identifier (as a globally unique identifier, or GUID) for a specific object. |
Description | Edm.String | No | States a description for the specified object. |
Name | Edm.String | No | Specifies the name of the VMM object. |
RunAsAccountId | Edm.Guid | No | Specifies the ID of a Run As account. |
TargetIPv4VPNAddress | Edm.String | No | Specifies a target virtual private network (VPN) address in IPv4 format. |
TargetIPv6VPNAddress | Edm.String | No | Specifies a target virtual private network (VPN) address in IPv6 format. |
VMMNetworkGatewayID | Edm.Guid | Yes | Specifies a VM network gateway object. |
DELETE
Deletes a VPN connection.
Entity Properties
Name | Type | Mandatory | Description |
---|---|---|---|
StampId | Edm.Guid | Yes | The identifier of the stamp that restricts the query. |
ID | Edm.Guid | Yes | The identifier of the VPN connection. |
Name | Edm.String | Yes | The name of the VMM object. |
VMMNetworkGatewayID | Edm.Guid | Yes | Specifies a VM network gateway object. |