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

Request body to create a VPN connection (CREATE_VPN job).

customerGatewayIps
array of strings
length ≥ 0

List of customer on-premise gateway public IP addresses.

customerGatewayIps
string
length between 0 and 50

Optional free-text comment.

boolean
string
customerSubnetIps
array of strings
customerSubnetIps
string
int64

ID of encryption key to use.

enabledApps
array of strings
enabledApps
string
enum

Initial status of VPN connection. One of on or off.

Allowed:
string
Responses
202

CREATE_VPN job submitted.

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