VpnPlugInProfile
VpnPlugInProfile
VpnPlugInProfile
VpnPlugInProfile
Class
Definition
Represents a VPN plug-in profile.
public : sealed class VpnPlugInProfile : IVpnPlugInProfile, IVpnPlugInProfile2, IVpnProfilepublic sealed class VpnPlugInProfile : IVpnPlugInProfile, IVpnPlugInProfile2, IVpnProfilePublic NotInheritable Class VpnPlugInProfile Implements IVpnPlugInProfile, IVpnPlugInProfile2, IVpnProfile// This API is not available in Javascript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
networkingVpnProvider
|
Constructors
VpnPlugInProfile() VpnPlugInProfile() VpnPlugInProfile() VpnPlugInProfile()
Allows VPN management apps to create, edit, and manage, VPN profiles for VPN plug-ins.
public : VpnPlugInProfile()public VpnPlugInProfile()Public Sub New()// This API is not available in Javascript.
| 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.
| 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 will trigger the VPN connection to connect.
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 will trigger the VPN connection to connect.
| 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.
- Value
- VpnManagementConnectionStatus VpnManagementConnectionStatus VpnManagementConnectionStatus VpnManagementConnectionStatus
An enumeration value giving current connection status.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
| Capabilities |
networkingVpnProvider
|
CustomConfiguration CustomConfiguration CustomConfiguration CustomConfiguration
Gets or sets an XML string to configure the VPN plug-in. Refer to the documentation from the VPN plug-in for format and support.
public : PlatForm::String CustomConfiguration { get; set; }public string CustomConfiguration { get; set; }Public ReadWrite Property CustomConfiguration As string// This API is not available in Javascript.
- Value
- PlatForm::String string string string
A string representing the XML to configure the VPN plug-in.
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
networkingVpnProvider
|
DomainNameInfoList DomainNameInfoList DomainNameInfoList DomainNameInfoList
Gets a list of Name Resolution Policy Table (NRPT) rules for the VPN plug-in 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 Name Resolution Policy Table (NRPT) rules for the VPN plug-in profile.
| 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 name of the 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 name of the VPN profile.
| 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.
| 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.
| 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 must 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 must go over the VPN interface in the case of a Split Tunneled VPN.
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
networkingVpnProvider
|
ServerUris ServerUris ServerUris ServerUris
Gets a list of server URIs to connect to for the VPN profile.
public : IVector<Uri> ServerUris { get; }public IList<Uri> ServerUris { get; }Public ReadOnly Property ServerUris As IList<Uri>// This API is not available in Javascript.
- Value
- IVector<Uri> IList<Uri> IList<Uri> IList<Uri>
A list of server URIs to connect to for the VPN profile.
| 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.
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
networkingVpnProvider
|
VpnPluginPackageFamilyName VpnPluginPackageFamilyName VpnPluginPackageFamilyName VpnPluginPackageFamilyName
Gets or sets the package family name of the VPN plug-in to be used for this VPN plug-in profile.
public : PlatForm::String VpnPluginPackageFamilyName { get; set; }public string VpnPluginPackageFamilyName { get; set; }Public ReadWrite Property VpnPluginPackageFamilyName As string// This API is not available in Javascript.
- Value
- PlatForm::String string string string
The package family name of the VPN plug-in to be used for this VPN plug-in profile.
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
| Capabilities |
networkingVpnProvider
|