|
| 1 | +# Azure Database for MySQL Deployment |
| 2 | + |
| 3 | + |
| 4 | +### Overview: |
| 5 | + |
| 6 | +The task is used to deploy for deploying to Azure Database for MySQL – Azure’s MySQL DB as a service. There are two ways to deploy, either using a script file or writing the script in our inline editor. |
| 7 | + |
| 8 | + |
| 9 | +### Contact Information |
| 10 | + |
| 11 | +Please report a problem at [Developer Community Forum](https://developercommunity.visualstudio.com/spaces/21/index.html) if you are facing problems in making this task work. You can also share feedback about the task like, what more functionality should be added to the task, what other tasks you would like to have, at the same place. |
| 12 | + |
| 13 | + |
| 14 | +### Pre-requisites for the task |
| 15 | +The following pre-requisites need to be setup for the task to work properly. |
| 16 | + |
| 17 | + |
| 18 | +##### Azure Subscription |
| 19 | + |
| 20 | +To deploy to Azure Database for MySQL, an Azure subscription has to be linked to Team Foundation Server or to Azure DevOps using the Service connections tab in the settings section. Add the Azure subscription to use in the Build or Release Management definition by opening the Account Administration screen (gear icon on the top-right of the screen) and then click on the Services Tab. |
| 21 | +Use 'Azure Resource Manager'([ARM](https://azure.microsoft.com/en-in/documentation/articles/resource-group-overview/)) endpoint type; for more details follow the steps listed in the link [here](https://go.microsoft.com/fwlink/?LinkID=623000&clcid=0x409). |
| 22 | + |
| 23 | + |
| 24 | + |
| 25 | +##### Azure Database for MySQL resource |
| 26 | +This tasks expects that the Azure resource for [Azure Database for MySQL](https://docs.microsoft.com/en-us/azure/mysql/overview) is already available in the [Azure portal](https://ms.portal.azure.com/?r=1#create/Microsoft.SQLDatabase.0.5.7-preview). The task can create a new database along with other MySQL commands but doesn't create the server. |
| 27 | + |
| 28 | +##### MySQL Client in agent box |
| 29 | +This task expects MySQL client must be in agent box |
| 30 | +- **Window Agent:** Use this [script file](https://aka.ms/window-mysqlcli-installer) to install MySQL client. |
| 31 | +- **Linux Agent:** Run command 'apt-get install mysql-client' to install MySQL client. |
| 32 | + |
| 33 | +### Parameters of the task: |
| 34 | +The parameters of the task are described in details, including examples, to show how to input the parameters. The parameters listed with a \* are required parameters for the task: |
| 35 | + |
| 36 | + |
| 37 | +- **Display name\*:** Provide a name to identify the task among others in your pipeline. |
| 38 | + |
| 39 | + |
| 40 | +- **Azure subscription\*:** Select the Azure Subscription to connect to the portal where the Azure resource is present. |
| 41 | + |
| 42 | + |
| 43 | +**DB Details** |
| 44 | + |
| 45 | + |
| 46 | +- **Host name\*:** Server name of “Azure DB for Mysql”.Example: fabrikam.mysql.database.azure.com. When you connect using MySQL Workbench, this is the same value that is used for "Hostname" in "Parameters". |
| 47 | + |
| 48 | +- **Database name:** The name of database, if you already have one, on which the below script is needed to be run, else the script itself can be used to create the database. |
| 49 | + |
| 50 | +- **Server admin login\*:** Azure Database for MySQL server supports native MySQL authentication. You can connect and authenticate to a server with the server's admin login. Example: bbo1@fabrikam. |
| 51 | +When you connect using MySQL Workbench, this is the same value that is used for "Username" in "Parameters". |
| 52 | + |
| 53 | + |
| 54 | +- **Password\*:** Administrator password for Azure DB for MySQL. In case you don’t recall the password you can change the password from [Azure portal](https://docs.microsoft.com/en-us/azure/mysql/howto-create-manage-server-portal). |
| 55 | + |
| 56 | + |
| 57 | + |
| 58 | +**Deployment Package** |
| 59 | + |
| 60 | + |
| 61 | +- **Type\*:** Select one of the options between Script File & Inline Script. |
| 62 | + |
| 63 | + |
| 64 | +**Script file:** Use this option if you have a text file that has the necessary SQL statements to be executed on server. |
| 65 | + |
| 66 | + |
| 67 | +- **Script path\*:** Full path of the script file on the automation agent or on a UNC path accessible to the automation agent like, \\BudgetIT\DeployBuilds\script.sql. Also, predefined [system variables](https://msdn.microsoft.com/Library/vs/alm/Build/scripts/variables) like, $(agent.releaseDirectory) can also be used here. |
| 68 | + |
| 69 | + |
| 70 | +- **Additional MySQL options:** Additional options supported by MySQL simple SQL shell. These options will be applied when executing the given file on the Azure DB for MySQL. |
| 71 | +Example: You can change to default tab separated output format to HTML or even XML format. Or if you have problems due to insufficient memory for large result sets, use the --quick option. |
| 72 | + |
| 73 | + |
| 74 | +**Inline script:** Use this option for running the Inline Script against the server. |
| 75 | + |
| 76 | + |
| 77 | +- **Inline script\*:** Enter the actuall Script to be run. |
| 78 | + |
| 79 | + |
| 80 | +- **Additional MySQL options:** Additional options supported by MySQL simple SQL shell. These options will be applied when executing the given file on the Azure DB for MySQL. |
| 81 | +Example: You can change to default tab separated output format to HTML or even XML format. Or if you have problems due to insufficient memory for large result sets, use the --quick option. |
| 82 | + |
| 83 | + |
| 84 | + |
| 85 | +**Firewall** |
| 86 | + |
| 87 | + |
| 88 | +- **Specify firewall rules using\*** : For successful execution of the task, we need to enable administrators to access the Azure Database for MySQL Server from the IP Address of the automation agent. |
| 89 | +By selecting auto-detect you can automatically add firewall exception for range of possible IP Address of automation agent |
| 90 | +or else you can specify the range explicitly. |
| 91 | + |
| 92 | + |
| 93 | +- **Start IP address\*:** The starting IP Address of the automation agent machine pool like 196.21.30.50. |
| 94 | + |
| 95 | + |
| 96 | +- **End IP address\*:** The ending IP Address of the automation agent machine pool like 196.21.30.65. |
| 97 | + |
| 98 | + |
| 99 | +- **Delete rule after task ends\*:** If selected, the added exception for IP addresses of the automation agent will be removed for corresponding Azure Database for MySQL. |
0 commit comments