Returns detailed information about the specified VPN connection.
A VPN connection defines a secure, encrypted VPN tunnel between a tenant's on-premise SQL Server instances and that tenant's Data Bridge cluster. The tenant can use this connection to send a receive data between on-premise SQL Server instances and databases on managed server instances.
VPN status
This operation can be used to poll the vpnStatus of a VPN connection.
The vpnStatus of a VPN connection identifies the current status of the VPN connection and its availability to transmit traffic between the tenant and a Data Bridge cluster.
At any one time the VPN connection is defined by one of the following VPN statuses: on,off, creating, deleting, failed_create, or failed_delete.
| VPN Status | Description |
|---|---|
on | VPN connection is available. |
off | VPN connection is not available. |
creating | A VPN_CREATE or VPN_UPDATE job is running. |
deleting | A VPN_DELETE job is running. |
failed_create | A VPN_CREATE or VPN_UPDATE job has failed. |
failed_delete | A VPN_DELETE job has failed. |
To perform this operation, the client must belong to a group that has been assigned the Admin or Data Bridge Admin role.
Entitlements
IC-VPN
/platform/tenantdata/v1/vpn-connections/{connectionId}, DATA_BRIDGE, bgpRouting, connectionId, customerBgpAsn, customerGatewayIps, customerSubnetIps, dnsResolverIps, enabledApps, encryptionKeyResourceId, encryptionType, irpBgpAsn, irpSubnetIps, irpTargetIps, tunnelSettings, vpnConnectionId, vpnStatus