Windows Dev Center

Windows.Networking.Vpn namespace

The functionality described in this topic is not available to all Windows and Windows Phone apps. For your code to call these APIs, Microsoft must approve your use of them and provision your developer account. Otherwise the calls will fail at runtime.

For more information about the Windows.Networking.Vpn namespace, please work with your Microsoft Account Team representative.

Members

The Windows.Networking.Vpn namespace has these types of members:

Classes

ClassDescription
VpnAppId Represents an application identifier, which can be a file path, a package family name, or a fully qualified binary name (FQBN) string.
VpnChannel Provides methods to create and destroy a VPN channel, and methods to perform buffer management. A VPN channel is the object in the system that links the network traffic data flow between the VPN plug-in's VPN server socket and the client machine network stack.
VpnChannelActivityEventArgs VpnChannelActivityEventArgs is not supported and may be altered or unavailable in the future. Instead, use VpnChannelActivityStateChangedArgs.
VpnChannelActivityStateChangedArgs Represents the ActivityStateChanged event specifying the new VPN channel state (idle or active).
VpnChannelConfiguration The configuration of the VpnChannel, which dictates how to establish the communication with the VPN server.
VpnCredential Represents the credentials requested and provided by the platform. This class holds username, password, PIN, OTP, and any additional PIN or certificate to which access has been granted.
VpnCustomCheckBox VpnCustomCheckBox is not supported and may be altered or unavailable in the future. Instead, use VpnCustomPromptBooleanInput.
VpnCustomComboBox VpnCustomComboBox is not supported and may be altered or unavailable in the future. Instead, use VpnCustomPromptOptionSelector.
VpnCustomEditBox VpnCustomEditBox is not supported and may be altered or unavailable in the future. Instead, use VpnCustomPromptTextInput.
VpnCustomErrorBox VpnCustomErrorBox is not supported and may be altered or unavailable in the future. Instead, use VpnCustomPromptText.
VpnCustomPromptBooleanInput Represents a Boolean type of UI control prompt required from the user. This is typically a checkbox. This is used in the construction of custom prompts used in the VpnChannel.RequestCustomPromptAsync method.
VpnCustomPromptOptionSelector Represents a multiple choice UI control prompt required from the user. This is typically a combo box. This is used in the construction of custom prompts used in the VpnChannel.RequestCustomPromptAsync method.
VpnCustomPromptText Represents a text UI element used in the VpnChannel.RequestCustomPromptAsync method.
VpnCustomPromptTextInput Represents a text input UI element used in the RequestCustomPromptAsync method.
VpnCustomTextBox VpnCustomTextBox is not supported and may be altered or unavailable in the future. Instead, use VpnCustomPromptText.
VpnDomainNameAssignment Contains VPN domain name policies, like name resolution, namespace configuration, and web proxies.
VpnDomainNameInfo Specifies the name policy for a specific namespace. It can specify the DNS servers to use for name resolution of the namespace, the web proxies to use when connecting to the namespace, or whether it should be exempted from the policy itself.
VpnInterfaceId Represents an interface ID used in the construction and assignment of an IPv6 address to the VPN interface. The ID contained in this class fills the interface ID portion of the IPv6 address.
VpnManagementAgent 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.
VpnNamespaceAssignment VpnNamespaceAssignment is not supported and may be altered or unavailable in the future. Instead, use VpnDomainNameAssignment.
VpnNamespaceInfo VpnNamespaceInfo is not supported and may be altered or unavailable in the future. Instead, use VpnDomainNameInfo.
VpnNativeProfile Represents a profile for an OS Native/Inbox VPN protocol.
VpnPacketBuffer Used by the platform to manage a memory buffer. VpnPacketBuffer allows buffers to be chained together in a IVpnPacketBufferList object list to be sent or received in a specific order.
VpnPacketBufferList Used to manage VpnPacketBuffer objects.
VpnPickedCredential VpnPickedCredential is not supported and may be altered or unavailable in the future. Instead, use VpnCredential.
VpnPlugInProfile Represents a VPN plug-in profile.
VpnRoute Represents a route relative to the VPN channel. It is composed of an address and a prefix size to identify the subnet being routed. The route can then be either included or excluded from the VPN channel scope.
VpnRouteAssignment Represents the list of routes assigned to the VPN channel for the correct flow and redirection of traffic.
VpnSystemHealth Allows access to the security health of the system device.
VpnTrafficFilter Defines the traffic filtering properties (including per app VPN). A description of the type of network traffic that will be allowed over the VPN connection, such as a specific application and protocol allowed for the connection.
VpnTrafficFilterAssignment Allows the specification of a set of traffic filters as policy to a VPN channel.

 

Enumerations

The Windows.Networking.Vpn namespace has these enumerations.

EnumerationDescription
VpnAppIdType Specifies the type of AppId understood by the VPN platform.
VpnAuthenticationMethod Specifies the type of authentication methods allowed by the operating system native VPN protocols.
VpnChannelActivityEventType Specifies the type of activity events.
VpnChannelRequestCredentialsOptions Specifies the values defining whether a requested credential is a retry case, or should be used for single sign on.
VpnCredentialType Specifies the types of credentials that can be requested by the VPN platform.
VpnDataPathType VpnDataPathType is not supported and may be altered or unavailable in the future.
VpnDomainNameType Describes whether a name is a domain name suffix or a fully qualified domain name.
VpnIPProtocol Specifies the IP protocols (numeric values).
VpnManagementErrorStatus Describes the known VPN management errors.
VpnNativeProtocolType Specifies the native protocol types.
VpnPacketBufferStatus Describes the possible states of the VPN packet buffer.
VpnRoutingPolicyType Specifies the routing policy type.

 

Interfaces

The Windows.Networking.Vpn namespace defines these interfaces.

InterfaceDescription
IVpnChannelStatics Provides static functions for VPN plug-ins.
IVpnCredential Provides an interface for the VPN platform to support requested credentials.
IVpnCustomPrompt Not supported.
IVpnCustomPromptElement Provides a common interface for all UI element objects used in the VpnChannel.RequestCustomPromptAsync method.
IVpnDomainNameInfoFactory Factory to create VpnDomainNameInfo objects.
IVpnInterfaceIdFactory Factory to create VpnInterfaceId objects.
IVpnNamespaceInfoFactory IVpnNamespaceInfoFactory is not supported and may be altered or unavailable in the future. Instead, use IVpnDomainNameInfoFactory.
IVpnPacketBufferFactory This interface is reserved for system use.
IVpnPlugIn Provides an interface to implement specific third party VPN client operations.
IVpnProfile Exposes the VpnProfile base object.
IVpnRouteFactory Factory to create VpnRoute objects.

 

Requirements

Minimum supported client

Windows 8.1

Minimum supported server

Windows Server 2012 R2

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.Networking.Vpn
Windows::Networking::Vpn [C++]

Metadata

Windows.winmd

Capabilities

networkingVpnProvider

 

 

Show:
© 2015 Microsoft