Microsoft.DBforMySQL flexibleServers

The flexibleServers resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.DBforMySQL/flexibleServers resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.DBforMySQL/flexibleServers@2021-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  identity: {
    type: 'SystemAssigned'
  }
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    availabilityZone: 'string'
    backup: {
      backupRetentionDays: int
      geoRedundantBackup: 'string'
    }
    createMode: 'string'
    highAvailability: {
      mode: 'string'
      standbyAvailabilityZone: 'string'
    }
    maintenanceWindow: {
      customWindow: 'string'
      dayOfWeek: int
      startHour: int
      startMinute: int
    }
    network: {
      delegatedSubnetResourceId: 'string'
      privateDnsZoneResourceId: 'string'
    }
    replicationRole: 'string'
    restorePointInTime: 'string'
    sourceServerResourceId: 'string'
    storage: {
      autoGrow: 'string'
      iops: int
      storageSizeGB: int
    }
    version: 'string'
  }
}

Property values

flexibleServers

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.DBforMySQL/flexibleServers'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-05-01-preview'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku Billing information related properties of a server. Sku
identity Identity for the resource. Identity
properties The properties of a server. ServerProperties

Identity

Name Description Value
type The identity type. 'SystemAssigned'

ServerProperties

Name Description Value
administratorLogin The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). string
administratorLoginPassword The password of the administrator login (required for server creation). string
availabilityZone availability Zone information of the server. string
backup Storage Profile properties of a server Backup
createMode The mode to create a new MySQL server. 'Default'
'GeoRestore'
'PointInTimeRestore'
'Replica'
highAvailability Network related properties of a server HighAvailability
maintenanceWindow Maintenance window of a server. MaintenanceWindow
network Network related properties of a server Network
replicationRole The replication role. 'None'
'Replica'
'Source'
restorePointInTime Restore point creation time (ISO8601 format), specifying the time to restore from. string
sourceServerResourceId The source MySQL server id. string
storage Storage Profile properties of a server Storage
version The version of a server. '5.7'
'8.0.21'

Backup

Name Description Value
backupRetentionDays Backup retention days for the server. int
geoRedundantBackup Enum to indicate whether value is 'Enabled' or 'Disabled' 'Disabled'
'Enabled'

HighAvailability

Name Description Value
mode High availability mode for a server. 'Disabled'
'Enabled'
'SameZone'
'ZoneRedundant'
standbyAvailabilityZone Availability zone of the standby server. string

MaintenanceWindow

Name Description Value
customWindow indicates whether custom window is enabled or disabled string
dayOfWeek day of week for maintenance window int
startHour start hour for maintenance window int
startMinute start minute for maintenance window int

Network

Name Description Value
delegatedSubnetResourceId Delegated subnet resource id used to setup vnet for a server. string
privateDnsZoneResourceId Private DNS zone resource id. string

Storage

Name Description Value
autoGrow Enum to indicate whether value is 'Enabled' or 'Disabled' 'Disabled'
'Enabled'
iops Storage IOPS for a server. int
storageSizeGB Max storage size allowed for a server. int

Sku

Name Description Value
name The name of the sku, e.g. Standard_D32s_v3. string (required)
tier The tier of the particular SKU, e.g. GeneralPurpose. 'Burstable'
'GeneralPurpose'
'MemoryOptimized'