VpnNativeProfile Class

Definition

Represents a profile for an OS Native/Inbox VPN protocol.

public ref class VpnNativeProfile 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)]
class VpnNativeProfile 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.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class VpnNativeProfile 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)]
public sealed class VpnNativeProfile
[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.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class VpnNativeProfile
Public NotInheritable Class VpnNativeProfile
Inheritance
VpnNativeProfile
Attributes
Implements

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

Remarks

Using VpnNativeProfile is approximately equivalent to using the Add a VPN connection dialog, in that you can specify a server, sign-in information, and other info, and then Windows takes care of the VPN connection from there. Consequently, you can't use VpnNativeProfile to capture received packets, nor to trigger a background task.

Version history

Windows version SDK version Value added
1607 14393 ConnectionStatus
1607 14393 RequireVpnClientAppUI

Constructors

VpnNativeProfile()

Allows a VPN management app to create a native VPN profile.

Properties

AlwaysOn

Gets or sets a value that indicates whether the VPN profile is for Always-On VPN; that is, whether the profile is capable of being always connected.

AppTriggers

Gets a list of apps that can trigger the Inbox VPN profile.

ConnectionStatus

Gets the current connection status.

DomainNameInfoList

Gets a list of domain name policies to be used for the profile.

EapConfiguration

Gets or sets the EAP Authentication configuration for an Inbox/Native VPN profile.

NativeProtocolType

Gets or sets the tunnel protocol type for the Inbox VPN connection.

ProfileName

Gets or sets the profile name for the Inbox/Native VPN profile.

RememberCredentials

Gets or sets whether the credentials for the VPN profile will be cached. If TRUE, the credentials for the VPN profile will be cached where applicable.

RequireVpnClientAppUI

Gets or sets a value that determines whether this VPN profile appears in the system's VPN connection UI.

Routes

Gets a list of routes that should go over the VPN interface in the case of a Split Tunneled VPN.

RoutingPolicyType

Gets or sets whether the apps allowed by this traffic filter are force tunneled through the VPN interface, or whether they are split tunneled and allowed to talk through other interfaces.

Servers

Gets a list of VPN servers for the Inbox VPN profile.

TrafficFilters

Gets a list of Traffic Filters (including per App) included in the VPN profile.

TunnelAuthenticationMethod

Gets or sets the authentication method to be used in the tunnel layer of the native VPN protocol.

UserAuthenticationMethod

Gets or sets the authentication method to be used to authenticate the user.

Applies to

See also