VpnManagementAgent Class

Definition

Allows the creation, deletion, edit, connect, and disconnect flows for VPN. These can be used to manage the lifecycle of a VPN profile, and to create a custom VPN connection manager.

public ref class VpnManagementAgent sealed
/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class VpnManagementAgent final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
/// [Windows.Foundation.Metadata.WebHostHidden]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class VpnManagementAgent final
[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
[Windows.Foundation.Metadata.WebHostHidden]
public sealed class VpnManagementAgent
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
[Windows.Foundation.Metadata.WebHostHidden]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class VpnManagementAgent
Public NotInheritable Class VpnManagementAgent
Inheritance
VpnManagementAgent
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)
App capabilities
networkingVpnProvider

Constructors

VpnManagementAgent()

Constructor to allows VPN app to create this object.

Methods

AddProfileFromObjectAsync(IVpnProfile)

Creates a new VPN Profile based on the VpnProfile input object.

AddProfileFromXmlAsync(String)

Creates a new VPN connection based on a ProfileXML-encoded string (see ProfileXML XSD).

ConnectProfileAsync(IVpnProfile)

Connects to an existing VPN profile.

ConnectProfileWithPasswordCredentialAsync(IVpnProfile, PasswordCredential)

Connects to a VPN profile using a specified set of password credentials.

DeleteProfileAsync(IVpnProfile)

Deletes an existing VPN profile.

DisconnectProfileAsync(IVpnProfile)

Disconnects from a connected VPN profile.

GetProfilesAsync()

Gets the accessible list of present VPN profiles.

UpdateProfileFromObjectAsync(IVpnProfile)

Updates a virtual private network (VPN) profile based on an input object.

UpdateProfileFromXmlAsync(String)

Updates an existing VPN profile based on an input ProfileXML-encoded string (see ProfileXML XSD).

Applies to