VpnNativeProfile VpnNativeProfile VpnNativeProfile VpnNativeProfile Class

Definition

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

public : sealed class VpnNativeProfile : IVpnNativeProfile, IVpnNativeProfile2, IVpnProfilepublic sealed class VpnNativeProfile : IVpnNativeProfile, IVpnNativeProfile2, IVpnProfilePublic NotInheritable Class VpnNativeProfile Implements IVpnNativeProfile, IVpnNativeProfile2, IVpnProfile// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Constructors

VpnNativeProfile() VpnNativeProfile() VpnNativeProfile() VpnNativeProfile()

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

public : VpnNativeProfile()public VpnNativeProfile()Public Sub New()// This API is not available in Javascript.
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Properties

AlwaysOn AlwaysOn AlwaysOn AlwaysOn

Gets or sets the AlwayOn property. If true, indicates that the VPN profile is always connected.

public : PlatForm::Boolean AlwaysOn { get; set; }public bool AlwaysOn { get; set; }Public ReadWrite Property AlwaysOn As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

If the VPN profile is an AlwaysOn profile, it is TRUE; otherwise , it is FALSE.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

AppTriggers AppTriggers AppTriggers AppTriggers

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

public : IVector<VpnAppId> AppTriggers { get; }public IList<VpnAppId> AppTriggers { get; }Public ReadOnly Property AppTriggers As IList<VpnAppId>// This API is not available in Javascript.
Value
IVector<VpnAppId> IList<VpnAppId> IList<VpnAppId> IList<VpnAppId>

A list of apps that can trigger the Inbox VPN profile.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

ConnectionStatus ConnectionStatus ConnectionStatus ConnectionStatus

Gets the current connection status.

public : VpnManagementConnectionStatus ConnectionStatus { get; }public VpnManagementConnectionStatus ConnectionStatus { get; }Public ReadOnly Property ConnectionStatus As VpnManagementConnectionStatus// This API is not available in Javascript.
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)
Capabilities
networkingVpnProvider

DomainNameInfoList DomainNameInfoList DomainNameInfoList DomainNameInfoList

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

public : IVector<VpnDomainNameInfo> DomainNameInfoList { get; }public IList<VpnDomainNameInfo> DomainNameInfoList { get; }Public ReadOnly Property DomainNameInfoList As IList<VpnDomainNameInfo>// This API is not available in Javascript.
Value
IVector<VpnDomainNameInfo> IList<VpnDomainNameInfo> IList<VpnDomainNameInfo> IList<VpnDomainNameInfo>

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

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

EapConfiguration EapConfiguration EapConfiguration EapConfiguration

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

public : PlatForm::String EapConfiguration { get; set; }public string EapConfiguration { get; set; }Public ReadWrite Property EapConfiguration As string// This API is not available in Javascript.
Value
PlatForm::String string string string

The EAP Authentication configuration for an Inbox/Native VPN profile.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

NativeProtocolType NativeProtocolType NativeProtocolType NativeProtocolType

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

public : VpnNativeProtocolType NativeProtocolType { get; set; }public VpnNativeProtocolType NativeProtocolType { get; set; }Public ReadWrite Property NativeProtocolType As VpnNativeProtocolType// This API is not available in Javascript.
Value
VpnNativeProtocolType VpnNativeProtocolType VpnNativeProtocolType VpnNativeProtocolType

An enum value indicating tunnel protocol type for the Inbox VPN connection.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

ProfileName ProfileName ProfileName ProfileName

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

public : PlatForm::String ProfileName { get; set; }public string ProfileName { get; set; }Public ReadWrite Property ProfileName As string// This API is not available in Javascript.
Value
PlatForm::String string string string

The profile name for the Inbox/Native VPN profile.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

RememberCredentials RememberCredentials RememberCredentials 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.

public : PlatForm::Boolean RememberCredentials { get; set; }public bool RememberCredentials { get; set; }Public ReadWrite Property RememberCredentials As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

If the credentials for the VPN profile will be cached, it is TRUE; otherwise , it is FALSE.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

RequireVpnClientAppUI RequireVpnClientAppUI RequireVpnClientAppUI RequireVpnClientAppUI

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

public : PlatForm::Boolean RequireVpnClientAppUI { get; set; }public bool RequireVpnClientAppUI { get; set; }Public ReadWrite Property RequireVpnClientAppUI As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

When true, this profile should appear in the system VPN connection user interface. By default, this value is false.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)
Capabilities
networkingVpnProvider

Remarks

When a profile is not visible in the VPN connection UI, it can still be used by VPN apps that know the profile's name.

Routes Routes Routes Routes

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

public : IVector<VpnRoute> Routes { get; }public IList<VpnRoute> Routes { get; }Public ReadOnly Property Routes As IList<VpnRoute>// This API is not available in Javascript.
Value
IVector<VpnRoute> IList<VpnRoute> IList<VpnRoute> IList<VpnRoute>

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

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

RoutingPolicyType RoutingPolicyType RoutingPolicyType 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.

public : VpnRoutingPolicyType RoutingPolicyType { get; set; }public VpnRoutingPolicyType RoutingPolicyType { get; set; }Public ReadWrite Property RoutingPolicyType As VpnRoutingPolicyType// This API is not available in Javascript.
Value
VpnRoutingPolicyType VpnRoutingPolicyType VpnRoutingPolicyType VpnRoutingPolicyType

An enum value indicating whether a VPN profile is Split Tunneled or Force Tunneled.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Servers Servers Servers Servers

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

public : IVector<string> Servers { get; }public IList<string> Servers { get; }Public ReadOnly Property Servers As IList<string>// This API is not available in Javascript.
Value
IVector<PlatForm::String> IList<string> IList<string> IList<string>

A list of VPN servers for the Inbox VPN profile.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

TrafficFilters TrafficFilters TrafficFilters TrafficFilters

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

public : IVector<VpnTrafficFilter> TrafficFilters { get; }public IList<VpnTrafficFilter> TrafficFilters { get; }Public ReadOnly Property TrafficFilters As IList<VpnTrafficFilter>// This API is not available in Javascript.
Value
IVector<VpnTrafficFilter> IList<VpnTrafficFilter> IList<VpnTrafficFilter> IList<VpnTrafficFilter>

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

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

TunnelAuthenticationMethod TunnelAuthenticationMethod TunnelAuthenticationMethod TunnelAuthenticationMethod

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

public : VpnAuthenticationMethod TunnelAuthenticationMethod { get; set; }public VpnAuthenticationMethod TunnelAuthenticationMethod { get; set; }Public ReadWrite Property TunnelAuthenticationMethod As VpnAuthenticationMethod// This API is not available in Javascript.
Value
VpnAuthenticationMethod VpnAuthenticationMethod VpnAuthenticationMethod VpnAuthenticationMethod

An enum value indicating authentication method to be used in the tunnel layer of the native VPN protocol.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

UserAuthenticationMethod UserAuthenticationMethod UserAuthenticationMethod UserAuthenticationMethod

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

public : VpnAuthenticationMethod UserAuthenticationMethod { get; set; }public VpnAuthenticationMethod UserAuthenticationMethod { get; set; }Public ReadWrite Property UserAuthenticationMethod As VpnAuthenticationMethod// This API is not available in Javascript.
Value
VpnAuthenticationMethod VpnAuthenticationMethod VpnAuthenticationMethod VpnAuthenticationMethod

An enum value indicating authentication method to be used to authenticate the user.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider