Microsoft.DBForMySql flexibleServers 2020-07-01-preview

Article
12/09/2024

Remarks

Use the maintenanceWindow property only when updating an existing flexible server. When creating a new flexible servcer, don't specify values for this property.

Bicep resource definition

The flexibleServers resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.DBForMySql/flexibleServers@2020-07-01-preview' = {
  identity: {
    type: 'SystemAssigned'
  }
  location: 'string'
  name: 'string'
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    availabilityZone: 'string'
    createMode: 'string'
    delegatedSubnetArguments: {
      subnetArmResourceId: 'string'
    }
    haEnabled: 'string'
    infrastructureEncryption: 'string'
    maintenanceWindow: {
      customWindow: 'string'
      dayOfWeek: int
      startHour: int
      startMinute: int
    }
    privateDnsZoneArguments: {
      privateDnsZoneArmResourceId: 'string'
    }
    replicationRole: 'string'
    restorePointInTime: 'string'
    sourceServerId: 'string'
    sslEnforcement: 'string'
    storageProfile: {
      backupRetentionDays: int
      storageAutogrow: 'string'
      storageIops: int
      storageMB: int
    }
    tags: {
      {customized property}: 'string'
    }
    version: 'string'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

DelegatedSubnetArguments

Name	Description	Value
subnetArmResourceId	delegated subnet arm resource id.	string

Identity

Name	Description	Value
type	The identity type.	'SystemAssigned'

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

Microsoft.DBForMySql/flexibleServers

Name	Description	Value
identity	The Azure Active Directory identity of the server.	Identity
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Properties of the server.	ServerProperties
sku	The SKU (pricing tier) of the server.	Sku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

PrivateDnsZoneArguments

Name	Description	Value
privateDnsZoneArmResourceId	private dns zone arm resource id.	string

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 Constraints: Sensitive value. Pass in as a secure parameter.
availabilityZone	availability Zone information of the server.	string
createMode	The mode to create a new MySQL server.	'Default' 'PointInTimeRestore' 'Replica'
delegatedSubnetArguments	Delegated subnet arguments.	DelegatedSubnetArguments
haEnabled	Enable HA or not for a server.	'Disabled' 'Enabled'
infrastructureEncryption	Status showing whether the server enabled infrastructure encryption.	'Disabled' 'Enabled'
maintenanceWindow	Maintenance window of a server.	MaintenanceWindow
privateDnsZoneArguments	private dns zone arguments.	PrivateDnsZoneArguments
replicationRole	The replication role.	string
restorePointInTime	Restore point creation time (ISO8601 format), specifying the time to restore from.	string
sourceServerId	The source MySQL server id.	string
sslEnforcement	Enable ssl enforcement or not when connect to server.	'Disabled' 'Enabled'
storageProfile	Storage profile of a server.	StorageProfile
tags	Application-specific metadata in the form of key-value pairs.	ServerPropertiesTags
version	Server version.	'5.7'

ServerPropertiesTags

Name	Description	Value

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' (required)

StorageProfile

Name	Description	Value
backupRetentionDays	Backup retention days for the server.	int
storageAutogrow	Enable Storage Auto Grow.	'Disabled' 'Enabled'
storageIops	Storage IOPS for a server.	int
storageMB	Max storage allowed for a server.	int

TrackedResourceTags

Name	Description	Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Create MySqlFlex server & enable protection via Backup Vault	Template that creates a MySQL Flexible Server and enables protection via Backup Vault
Deploy MySQL Flexible Server with Private Endpoint	This template provides a way to deploy a Azure Database for MySQL Flexible Server with Private Endpoint.
Deploy MySQL Flexible Server with Vnet Integration	This template provides a way to deploy a Azure database for MySQL Flexible Server with VNet Integration.

ARM template resource definition

The flexibleServers resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.DBForMySql/flexibleServers",
  "apiVersion": "2020-07-01-preview",
  "name": "string",
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "string",
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "availabilityZone": "string",
    "createMode": "string",
    "delegatedSubnetArguments": {
      "subnetArmResourceId": "string"
    },
    "haEnabled": "string",
    "infrastructureEncryption": "string",
    "maintenanceWindow": {
      "customWindow": "string",
      "dayOfWeek": "int",
      "startHour": "int",
      "startMinute": "int"
    },
    "privateDnsZoneArguments": {
      "privateDnsZoneArmResourceId": "string"
    },
    "replicationRole": "string",
    "restorePointInTime": "string",
    "sourceServerId": "string",
    "sslEnforcement": "string",
    "storageProfile": {
      "backupRetentionDays": "int",
      "storageAutogrow": "string",
      "storageIops": "int",
      "storageMB": "int"
    },
    "tags": {
      "{customized property}": "string"
    },
    "version": "string"
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

DelegatedSubnetArguments

Name	Description	Value
subnetArmResourceId	delegated subnet arm resource id.	string

Identity

Name	Description	Value
type	The identity type.	'SystemAssigned'

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

Microsoft.DBForMySql/flexibleServers

Name	Description	Value
apiVersion	The api version	'2020-07-01-preview'
identity	The Azure Active Directory identity of the server.	Identity
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Properties of the server.	ServerProperties
sku	The SKU (pricing tier) of the server.	Sku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.DBForMySql/flexibleServers'

PrivateDnsZoneArguments

Name	Description	Value
privateDnsZoneArmResourceId	private dns zone arm resource id.	string

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 Constraints: Sensitive value. Pass in as a secure parameter.
availabilityZone	availability Zone information of the server.	string
createMode	The mode to create a new MySQL server.	'Default' 'PointInTimeRestore' 'Replica'
delegatedSubnetArguments	Delegated subnet arguments.	DelegatedSubnetArguments
haEnabled	Enable HA or not for a server.	'Disabled' 'Enabled'
infrastructureEncryption	Status showing whether the server enabled infrastructure encryption.	'Disabled' 'Enabled'
maintenanceWindow	Maintenance window of a server.	MaintenanceWindow
privateDnsZoneArguments	private dns zone arguments.	PrivateDnsZoneArguments
replicationRole	The replication role.	string
restorePointInTime	Restore point creation time (ISO8601 format), specifying the time to restore from.	string
sourceServerId	The source MySQL server id.	string
sslEnforcement	Enable ssl enforcement or not when connect to server.	'Disabled' 'Enabled'
storageProfile	Storage profile of a server.	StorageProfile
tags	Application-specific metadata in the form of key-value pairs.	ServerPropertiesTags
version	Server version.	'5.7'

ServerPropertiesTags

Name	Description	Value

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' (required)

StorageProfile

Name	Description	Value
backupRetentionDays	Backup retention days for the server.	int
storageAutogrow	Enable Storage Auto Grow.	'Disabled' 'Enabled'
storageIops	Storage IOPS for a server.	int
storageMB	Max storage allowed for a server.	int

TrackedResourceTags

Name	Description	Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create MySqlFlex server & enable protection via Backup Vault	Template that creates a MySQL Flexible Server and enables protection via Backup Vault
Deploy MySQL Flexible Server with Private Endpoint	This template provides a way to deploy a Azure Database for MySQL Flexible Server with Private Endpoint.
Deploy MySQL Flexible Server with Vnet Integration	This template provides a way to deploy a Azure database for MySQL Flexible Server with VNet Integration.

Terraform (AzAPI provider) resource definition

The flexibleServers resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DBForMySql/flexibleServers resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBForMySql/flexibleServers@2020-07-01-preview"
  name = "string"
  identity = {
    type = "SystemAssigned"
  }
  location = "string"
  sku = {
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      availabilityZone = "string"
      createMode = "string"
      delegatedSubnetArguments = {
        subnetArmResourceId = "string"
      }
      haEnabled = "string"
      infrastructureEncryption = "string"
      maintenanceWindow = {
        customWindow = "string"
        dayOfWeek = int
        startHour = int
        startMinute = int
      }
      privateDnsZoneArguments = {
        privateDnsZoneArmResourceId = "string"
      }
      replicationRole = "string"
      restorePointInTime = "string"
      sourceServerId = "string"
      sslEnforcement = "string"
      storageProfile = {
        backupRetentionDays = int
        storageAutogrow = "string"
        storageIops = int
        storageMB = int
      }
      tags = {
        {customized property} = "string"
      }
      version = "string"
    }
  })
}

Property values

DelegatedSubnetArguments

Name	Description	Value
subnetArmResourceId	delegated subnet arm resource id.	string

Identity

Name	Description	Value
type	The identity type.	'SystemAssigned'

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

Microsoft.DBForMySql/flexibleServers

Name	Description	Value
identity	The Azure Active Directory identity of the server.	Identity
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Properties of the server.	ServerProperties
sku	The SKU (pricing tier) of the server.	Sku
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.DBForMySql/flexibleServers@2020-07-01-preview"

PrivateDnsZoneArguments

Name	Description	Value
privateDnsZoneArmResourceId	private dns zone arm resource id.	string

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 Constraints: Sensitive value. Pass in as a secure parameter.
availabilityZone	availability Zone information of the server.	string
createMode	The mode to create a new MySQL server.	'Default' 'PointInTimeRestore' 'Replica'
delegatedSubnetArguments	Delegated subnet arguments.	DelegatedSubnetArguments
haEnabled	Enable HA or not for a server.	'Disabled' 'Enabled'
infrastructureEncryption	Status showing whether the server enabled infrastructure encryption.	'Disabled' 'Enabled'
maintenanceWindow	Maintenance window of a server.	MaintenanceWindow
privateDnsZoneArguments	private dns zone arguments.	PrivateDnsZoneArguments
replicationRole	The replication role.	string
restorePointInTime	Restore point creation time (ISO8601 format), specifying the time to restore from.	string
sourceServerId	The source MySQL server id.	string
sslEnforcement	Enable ssl enforcement or not when connect to server.	'Disabled' 'Enabled'
storageProfile	Storage profile of a server.	StorageProfile
tags	Application-specific metadata in the form of key-value pairs.	ServerPropertiesTags
version	Server version.	'5.7'

ServerPropertiesTags

Name	Description	Value

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' (required)

StorageProfile

Name	Description	Value
backupRetentionDays	Backup retention days for the server.	int
storageAutogrow	Enable Storage Auto Grow.	'Disabled' 'Enabled'
storageIops	Storage IOPS for a server.	int
storageMB	Max storage allowed for a server.	int

TrackedResourceTags

Name	Description	Value

Share via

Microsoft.DBForMySql flexibleServers 2020-07-01-preview

Remarks

Bicep resource definition

Resource format

Property values

DelegatedSubnetArguments

Identity

MaintenanceWindow

Microsoft.DBForMySql/flexibleServers

PrivateDnsZoneArguments

ServerProperties

ServerPropertiesTags

Sku

StorageProfile

TrackedResourceTags

Quickstart samples

ARM template resource definition

Resource format

Property values

DelegatedSubnetArguments

Identity

MaintenanceWindow

Microsoft.DBForMySql/flexibleServers

PrivateDnsZoneArguments

ServerProperties

ServerPropertiesTags

Sku

StorageProfile

TrackedResourceTags

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

DelegatedSubnetArguments

Identity

MaintenanceWindow

Microsoft.DBForMySql/flexibleServers

PrivateDnsZoneArguments

ServerProperties

ServerPropertiesTags

Sku

StorageProfile

TrackedResourceTags

Feedback

Additional resources