# Functions
Connect connects to a tunnel and returns a connected client.
Creates a new Manager used for interacting with the Tunnels APIs.
No description provided by the author
# Constants
Internal error.
Operation cannot be performed because the service is not available.
Operation timed out.
No description provided by the author
GitHub identity provider.
IPv4 addresses.
IPv6 addresses.
Microsoft (AAD) identity provider.
Service tags.
SSH public keys.
The access control entry refers to all anonymous users.
The access control entry is a list of groups IDs that are allowed (or denied) access.
The access control entry is a list of IP address ranges that are allowed (or denied) access to the tunnel.
Uninitialized access control entry type.
The access control entry is a list of organization IDs that are allowed (or denied) access.
The access control entry is a list of public keys.
The access control entry is a list of repositories.
The access control entry is a list of user IDs that are allowed (or denied) access.
Allows connecting to tunnels or ports as a client.
Allows creating tunnels.
Allows accepting connections on tunnels as a host.
Allows inspecting tunnel connection activity and data.
Allows management operations on tunnels and tunnel ports.
Allows management operations on all ports of a tunnel, but does not allow updating any other tunnel properties or deleting the tunnel.
Authentication scheme for AAD (or Microsoft account) access tokens.
Authentication scheme for GitHub access tokens.
Authentication scheme for tunnel access tokens.
Authentication scheme for tunnelPlan access tokens.
Connect directly to the host over the local network.
Use the tunnel service's integrated relay function.
Maximum number of access control entries (ACEs) in a tunnel or tunnel port access control list (ACL).
Maximum number of scopes in an access control entry.
Maximum number of subjects (such as user IDs) in a tunnel or tunnel port access control entry (ACE).
Max length of an access control subject or organization ID.
Max length of an access control subject name, when resolving names to IDs.
Regular expression that can match or validate an access control subject name, when resolving subject names to IDs.
Regular expression that can match or validate an access control subject or organization ID.
Max length of tunnel cluster ID.
Min length of tunnel cluster ID.
Regular expression that can match or validate tunnel cluster ID strings.
Max length of tunnel or port description.
Max length of a single tunnel or port tag.
Min length of a single tunnel or port tag.
Regular expression that can match or validate tunnel or port labels.
Maximum number of labels that can be applied to a tunnel or port.
Characters that are valid in tunnel IDs.
Max length of V2 tunnelId.
Min length of V2 tunnelId.
Regular expression that can match or validate tunnel ID strings.
Characters that are valid in tunnel IDs.
Length of V1 tunnel id.
Regular expression that can match or validate tunnel ID strings.
Characters that are valid in tunnel IDs.
Length of a tunnel alias.
Regular expression that can match or validate tunnel alias strings.
Max length of a tunnel domain.
Min length of a tunnel domain.
Regular expression that can match or validate tunnel domains.
Maximum number of items allowed in the tunnel ports array.
Max length of tunnel name.
Min length of tunnel name.
Regular expression that can match or validate tunnel names.
Github Ssh public key which can be used to validate if it belongs to tunnel's owner.
Request ID header that nginx ingress controller adds to all requests if it's not there.
Additional authorization header that can be passed to tunnel web forwarding to authenticate and authorize the client.
Header that will skip the antiphishing page when connection to a tunnel through web forwarding.
Completed create tunnel port.
Completed get tunnel port.
Completed refresh ports.
Completed sending a tunnel service request.
Starting create tunnel port.
Starting get tunnel port.
Starting refresh ports.
Starting request configuration for a tunnel service request.
Starting request uri for a tunnel service request.
Starting to send tunnel service request.
The protocol is automatically detected.
HTTP protocol.
HTTPS protocol.
Remote desktop protocol.
SSH protocol.
Unknown TCP protocol.
Unknown UDP protocol.
# Variables
No description provided by the author
ErrMultipleHosts is returned when multiple tunnel endpoints for different hosts are provided.
ErrNoConnections is returned when no tunnel endpoints are provided for the given host ID.
ErrNoRelayConnections is returned when no relay connections are available.
ErrNoTunnel is returned when no tunnel is provided.
ErrNoTunnelEndpoints is returned when no tunnel endpoints are provided.
ErrPortNotForwarded is returned when the specified port is not forwarded.
ErrSSHConnectionClosed is returned when the ssh connection is closed.
Token included in `TunnelEndpoint.PortUriFormat` and `TunnelEndpoint.PortSshCommandFormat` that is to be replaced by a specified port number.
No description provided by the author
No description provided by the author
Regular expression that can match or validate an access control subject name, when resolving subject names to IDs.
Regular expression that can match or validate an access control subject or organization ID.
Regular expression that can match or validate tunnel cluster ID strings.
Regular expression that can match or validate tunnel or port labels.
Regular expression that can match or validate tunnel ID strings.
Regular expression that can match or validate tunnel ID strings.
Regular expression that can match or validate tunnel alias strings.
Regular expression that can match or validate tunnel domains.
Regular expression that can match or validate tunnel names.
# Structs
Client is a client for a tunnel.
Details of a tunneling service cluster.
The top-level error object whose code matches the x-ms-error-code response header.
An object containing more specific information than the current object about the error.
Parameters for connecting to a tunnel via a local network connection.
Manager is used to interact with the Visual Studio Tunnel Service APIs.
A named `RateStatus`.
Structure of error details returned by the tunnel service, including validation errors.
Current value and limit information for a rate-limited operation related to a tunnel or port.
Current value and limit for a limited resource related to a tunnel or tunnel port.
Data contract for service version details.
Data contract for tunnel objects managed through the tunnel service REST API.
Data contract for access control on a `Tunnel` or `TunnelPort`.
Data contract for an access control entry on a `Tunnel` or `TunnelPort`.
Properties about a subject of a tunnel access control entry (ACE), used when resolving subject names to IDs when creating new ACEs, or formatting subject IDs to names when displaying existing ACEs.
Base class for tunnel connection parameters.
Tunnel list by region.
Data contract for response of a list tunnel by region call.
Data contract for response of a list tunnel call.
Data contract for `Tunnel` or `TunnelPort` options.
Data contract for tunnel port objects managed through the tunnel service REST API.
Data contract for response of a list tunnel ports call.
Data contract for `TunnelPort` status.
Parameters for connecting to a tunnel via the tunnel service's built-in relay function.
Event args for the tunnel report progress event.
Options that are sent in requests to the tunnels service.
Provides environment-dependent properties about the service.
Data contract for `Tunnel` status.
UserAgent contains the name and version of the client.
# Type aliases
No description provided by the author
Error codes for ErrorDetail.Code and `x-ms-error-code` header.
No description provided by the author
Constants for well-known identity providers.
Specifies the type of `TunnelAccessControlEntry`.
No description provided by the author
Defines scopes for tunnel access tokens.
No description provided by the author
Defines string constants for authentication schemes supported by tunnel service APIs.
Specifies the connection protocol / implementation for a tunnel.
No description provided by the author
Header names for http requests that Tunnel Service can handle.
No description provided by the author
Specifies the tunnel progress events that are reported.
Defines possible values for the protocol of a `TunnelPort`.