Connect using Azure Private Link

This topic provides a step-by-step guide on connecting to an OceanBase Cloud database using Azure Private Link.

Prerequisites

• You have an active Azure account and an Azure subscription. You have completed the subscription to the OceanBase Cloud offering from Azure Marketplace, and ensure that a valid virtual network and subnet are available under your Azure subscription.
• You have an active OceanBase Cloud account, and have created an instance and a tenant. For more information, refer to Create an instance and Create a tenant. In this topic, a MySQL-compatible tenant is used.
• Make sure your client's IP address has been added to the allowlist of your tenant. For detailed instructions, refer to Set allowlist groups.

Procedure

Step 1: Create your endpoint service

1. Log in to the OceanBase Cloud console and click Networking in the left-side navigation pane.

2. On the Private Connectivity tab, click Create Private Connection.

3. In Step 1: Create your endpoint service, select Azure as the cloud service provider, and select the target instance and tenant.

4. Open Azure console and click Subsriptions under Navigate.

5. On the Subscriptions page, view the name of the target subscription.

6. Return to the OceanBase Cloud console and enter the name of the target subscription in the Azure Account ID field in Step 1.

Step 2: Create Endpoint on Azure and Connect

Create a private endpoint on the Azure console. This process takes about 10 minutes.

1. Log in to the Azure console.

2. Access Network foundation > Private Link > Private endpoints.

   

3. Click Create.

   

4. On the Create a private endpoint page, configure the following parameters:

   • Basic

     Parameter	Description
     Subscription	Select the subscription.
     Resource group	Select the resource group.
     Name	Enter the name of the private endpoint.
     Network Interface Name	Automatically generated based on the name.
     Region	Select the region.

     

   • Resource

     Parameter	Description
     Connection method	Select Connect to an Azure resource by resource ID or alias.
     Resource ID or alias	Enter the Service ID provided in Step 2 of the OceanBase Cloud console.

     

   • Virtual Network

     Parameter	Description
     Virtual network	Select the virtual network to connect with.
     Subnet	Select the subnet of the target virtual network.

     

   • DNS

     Azure private endpoint does not support DNS integration in the current mode.

     

   • Tags

     Configure tags as needed.

     

5. Click Create on the review page.

   

6. Wait on the private endpoint details page until the status turns to Ok. Click the resource name to go to the resource details page.

   

7. Obtain the endpoint configuration information.

   1. Click the JSON View button in the upper-right corner of the details page.

   2. Copy the Resource ID from the opened Resource JSON window.

      

   3. Click the network interface to go to the network card details page.

      

   4. Check the Private IPv4 address, which is used to access the OceanBase Cloud database instance.

      

8. In the OceanBase Cloud console, enter the endpoint ID and endpoint IP address.

   • Endpoint ID: the Resource ID obtained in step 7-2.
   • Endpoint IP Address: the Private IPv4 address obtained in step 7-4.

   

Step 3: Access Database

After the Private Link is configured, you can access the database on the Step 3: Access Database page by selecting the access information and generating a connection string.

Verify access to the database through the following command:

mysql -h<host> -P<port> -u<username>@<tenantId> -p

The parameters are specified as follows:

• host: The IP address of the private endpoint.
• port: The access port of the database, which is 3306 by default.
• username: The database user account for connection.
• tenantId: The tenant ID. You can check and copy it from the tenant list and the tenant details page.

For example:

mysql -h10.0.0.5 -P3306 -utest@t70zh******** -p