Create and manage Private Link for Azure Database for MySQL - Flexible Server using Azure CLI

APPLIES TO: Azure Database for MySQL - Flexible Server

In this article, you learn how to use Azure CLI to create a private endpoint for accessing Azure Database for MySQL flexible server from a VM in a VNet.

This quickstart requires Azure CLI version 2.0 or later. Run az --version to find the version. See Install Azure CLI if you need to install or upgrade.

Prerequisites

You must log in to your account using the az login command. Note the id property, which refers to Subscription ID for your Azure account.

az login

Select the specific subscription under your account using az account set command. In the command, note the id value from the az login output to use as the value for subscription argument. If you have multiple subscriptions, choose the appropriate subscription in which the resource should be billed. Use az account list to get all your subscriptions.

az account set --subscription <subscription id>

Create a resource group

Before creating any resource, you must create a resource group to host the Virtual Network. Create a resource group with az group create. This example creates a resource group named myResourceGroup in the chinanorth3 location:

az group create --name myResourceGroup --location chinanorth3

Create a Virtual Network

Create a Virtual Network with az network vnet create. This example creates a default Virtual Network named myVirtualNetwork with one subnet named mySubnet:

az network vnet create \
 --name myVirtualNetwork \
 --resource-group myResourceGroup \
 --subnet-name mySubnet

Disable subnet private endpoint policies

Azure deploys resources to a subnet within a virtual network, so you need to create or update the subnet to disable private endpoint network policies. Update a subnet configuration named mySubnet with az network vnet subnet update:

az network vnet subnet update \
 --name mySubnet \
 --resource-group myResourceGroup \
 --vnet-name myVirtualNetwork \
 --disable-private-endpoint-network-policies true

Create the VM

Create a VM with az vm create. When prompted, provide a password to be used as the sign-in credentials for the VM. This example creates a VM named myVm:

az vm create \
  --resource-group myResourceGroup \
  --name myVm \
  --image Win2019Datacenter

Create the Azure Database for MySQL flexible server instance with public access in the resource group

Create an Azure Database for MySQL flexible server instance with public access and add the client IP address to access it.

az mysql flexible-server create \
  --name mydemoserver \
  --resource-group myResourcegroup \
  --location chinanorth3 \
  --admin-user mylogin \
  --admin-password <server_admin_password> \
  --public-access <my_client_ip>

Create the Private Endpoint

Create a private endpoint for Azure Database for MySQL flexible server in your Virtual Network:

az network private-endpoint create \
    --name myPrivateEndpoint \
    --resource-group myResourceGroup \
    --vnet-name myVirtualNetwork  \
    --subnet mySubnet \
    --private-connection-resource-id $(az resource show -g myResourcegroup -n mydemoserver --resource-type "Microsoft.DBforMySQL/flexibleServers" --query "id" -o tsv) \
    --group-id mysqlServer \
    --connection-name myConnection \
    --location location

Configure the Private DNS Zone

Create a Private DNS Zone for the Azure Database for MySQL flexible server domain and create an association link with the Virtual Network.

az network private-dns zone create --resource-group myResourceGroup \
   --name  "privatelink.mysql.database.chinacloudapi.cn"
az network private-dns link vnet create --resource-group myResourceGroup \
   --zone-name  "privatelink.mysql.database.chinacloudapi.cn"\
   --name MyDNSLink \
   --virtual-network myVirtualNetwork \
   --registration-enabled false

# Query for the network interface ID
$networkInterfaceId=$(az network private-endpoint show --name myPrivateEndpoint --resource-group myResourceGroup --query 'networkInterfaces[0].id' -o tsv)

az resource show --ids $networkInterfaceId --api-version 2019-04-01 -o json
# Copy the content for privateIPAddress and FQDN matching the MySQL flexible server name

# Create DNS records
az network private-dns record-set a create --name myserver --zone-name privatelink.mysql.database.chinacloudapi.cn --resource-group myResourceGroup
az network private-dns record-set a add-record --record-set-name myserver --zone-name privatelink.mysql.database.chinacloudapi.cn --resource-group myResourceGroup -a <Private IP Address>

Connect to a VM from the internet

Connect to the VM myVm from the internet as follows:

1. In the portal's search bar, enter myVm.

2. Select the Connect button. After selecting the Connect button, Connect to virtual machine opens.

3. Select Download RDP File. Azure creates a Remote Desktop Protocol (.rdp) file and downloads it to your computer.

4. Open the downloaded.rdp file.

   1. If prompted, select Connect.

. Enter the username and password you specified when creating the VM. > [!NOTE] > You may need to select More choices Use a different account, to specify the credentials you entered when you created the VM.

1. Select OK.

2. You may receive a certificate warning during the sign-in process. Select Yes or Continue if you receive a certificate warning.

3. Once the VM desktop appears, minimize it to return to your local desktop.

Access the Azure Database for MySQL flexible server instance privately from the VM

1. In the Remote Desktop of myVM, open PowerShell.

2. Enter nslookup mydemomysqlserver.privatelink.mysql.database.chinacloudapi.cn.

   You'll receive a message similar to this:

   Server:  UnKnown
   Address:  168.63.129.16
   Non-authoritative answer:
   Name:    mydemomysqlserver.privatelink.mysql.database.chinacloudapi.cn
   Address:  10.1.3.4
   

3. Test the private link connection for the Azure Database for MySQL flexible server instance using any available client. The following example uses MySQL Workbench to do the operation.

4. In New connection, enter or select this information:

   Setting	Value
   Connection Name	Select the connection name of your choice.
   Hostname	Select mydemoserver.privatelink.mysql.database.chinacloudapi.cn
   Username	Enter username as username@servername provided during the Azure Database for MySQL flexible server instance creation.
   Password	Enter a password provided during the Azure Database for MySQL flexible server instance creation.

5. Select Connect.

6. Browse databases from left menu.

7. (Optionally) Create or query information from the Azure Database for MySQL flexible server database.

8. Close the remote desktop connection to myVm.

Clean up resources

When no longer needed, you can use az group delete to remove the resource group and all the resources it has:

az group delete --name myResourceGroup --yes

Additional Private Link CLI commands

List private linkable sub-resources (groupIds)

az network private-link-resource list --id {PrivateLinkResourceID}  // or -g MyResourceGroup -n MySA --type Microsoft.Storage/storageAccounts

List private endpoint connections on a given resource

az network private-endpoint-connection list --id {PrivateLinkResourceID}

Approve private endpoint connections on a given resource

az network private-endpoint-connection approve --id {PrivateEndpointConnectionID}  --description "Approved!"

Reject private endpoint connections on a given resource

az network private-endpoint-connection reject --id {PrivateEndpointConnectionID}  --description "Rejected!"

Delete private endpoint connections on a given resource

az network private-endpoint-connection delete --id {PrivateEndpointConnectionID}

Next steps

• Learn how to [configure private link for Azure Database for MySQL flexible server from the Azure portal.
• Learn how to manage connectivity to Azure Database for MySQL flexible server.
• Learn how to add another layer of encryption to Azure Database for MySQL flexible server using Customer Managed Keys.
• Learn how to configure and use Microsoft Entra authentication on your Azure Database for MySQL flexible server instance.