Microsoft.DBforMySQL servers template reference

Template format

To create a Microsoft.DBforMySQL/servers resource, add the following JSON to the resources section of your template.

  "name": "string",
  "type": "Microsoft.DBforMySQL/servers",
  "apiVersion": "2017-12-01",
  "sku": {
    "name": "string",
    "tier": "string",
    "capacity": "integer",
    "size": "string",
    "family": "string"
  "properties": {
    "version": "string",
    "sslEnforcement": "string",
    "storageProfile": {
      "backupRetentionDays": "integer",
      "geoRedundantBackup": "string",
      "storageMB": "integer"
    "createMode": "string"
  "location": "string",
  "tags": {},
  "resources": []

Property values

The following tables describe the values you need to set in the schema.

Microsoft.DBforMySQL/servers object

Name Type Required Value
name string Yes The name of the server.
type enum Yes Microsoft.DBforMySQL/servers
apiVersion enum Yes 2017-12-01
sku object No The SKU (pricing tier) of the server. - Sku object
properties object Yes Properties of the server. - ServerPropertiesForCreate object
location string Yes The location the resource resides in.
tags object No Application-specific metadata in the form of key-value pairs.
resources array No securityAlertPolicies configurations databases virtualNetworkRules firewallRules

Sku object

Name Type Required Value
name string No The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.
tier enum No The tier of the particular SKU, e.g. Basic. - Basic, GeneralPurpose, MemoryOptimized
capacity integer No The scale up/out capacity, representing server's compute units.
size string No The size code, to be interpreted by resource as appropriate.
family string No The family of hardware.

ServerPropertiesForCreate object

Name Type Required Value
version enum No Server version. - 5.6 or 5.7
sslEnforcement enum No Enable ssl enforcement or not when connect to server. - Enabled or Disabled
storageProfile object No Storage profile of a server. - StorageProfile object
createMode string Yes

StorageProfile object

Name Type Required Value
backupRetentionDays integer No Backup retention days for the server.
geoRedundantBackup enum No Enable Geo-redundant or not for server backup. - Enabled or Disabled
storageMB integer No Max storage allowed for a server.

Quickstart templates

See all Microsoft.Dbformysql templates in Azure Quickstart templates.