Create VPN connection

Creates a VPN connection.

A VPN connection is a set of configurations that defines an encrypted connection between the tenant's network and their Data Bridge cluster. The tenant can use this connection to send a receive data between on-premise SQL Server instances and managed server instances on Data Bridge.

The VPN connection can only be used if an encryption key (encryptionKeyResourceId) is assigned and vpnStatus is on.

📷

Note

Licensed Data Bridge tenants can enable access to Data Bridge cluster using either VPN connection or a Data Bridge access control list (ACL).

If the tenant's VPN connection is off, the address listed in the Data Bridge ACL can access Data Bridge. Once the VPN connection is on, the Data Bridge ACL is ignored. To learn more, see Administer Data Bridge ACLs.

To perform this operation, the client must belong to a group that has been assigned the Admin or Data Bride Admin role.

🪰

entitlements

ic-vpn

Body Params
customerGatewayIps
array of strings
length between 0 and 1

Customer gateway IPs (currently only one supported).

customerGatewayIps
string
length between 0 and 50

Comments for reference

boolean

If true, BGP routing is enabled.

string

Customer BGP ASN.

customerSubnetIps
array of strings

Customer subnet IPs in CIDR format.

customerSubnetIps
string

Type of encryption.

string

Resource URI of encryption key.

enabledApps
array of strings

List of Intelligent Risk Platform applications accessible via VPN connection.

enabledApps
string
enum

Status of VPN connection. Client can set on or off.

Allowed:
Responses
202

CREATE_VPN job submitted.

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json