Microsoft.DBForMySql flexibleServers 2020-07-01-preview
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' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
tier: 'string'
}
identity: {
type: 'SystemAssigned'
}
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: '5.7'
}
}
Property values
flexibleServers
| Name | Description | Value |
|---|---|---|
| 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 | The SKU (pricing tier) of the server. | Sku |
| identity | The Azure Active Directory identity of the server. | Identity |
| properties | Properties of the 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 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. | object |
| version | Server version. | '5.7' |
DelegatedSubnetArguments
| Name | Description | Value |
|---|---|---|
| subnetArmResourceId | delegated subnet arm resource id. | 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 |
PrivateDnsZoneArguments
| Name | Description | Value |
|---|---|---|
| privateDnsZoneArmResourceId | private dns zone arm resource id. | string |
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 |
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) |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Deploy Azure Database for MySQL (flexible) with VNet |
This template provides a way to deploy a Flexible server Azure database for MySQL 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",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string",
"tier": "string"
},
"identity": {
"type": "SystemAssigned"
},
"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": "5.7"
}
}
Property values
flexibleServers
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.DBForMySql/flexibleServers' |
| apiVersion | The resource api version | '2020-07-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 | The SKU (pricing tier) of the server. | Sku |
| identity | The Azure Active Directory identity of the server. | Identity |
| properties | Properties of the 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 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. | object |
| version | Server version. | '5.7' |
DelegatedSubnetArguments
| Name | Description | Value |
|---|---|---|
| subnetArmResourceId | delegated subnet arm resource id. | 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 |
PrivateDnsZoneArguments
| Name | Description | Value |
|---|---|---|
| privateDnsZoneArmResourceId | private dns zone arm resource id. | string |
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 |
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) |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Deploy Azure Database for MySQL (flexible) with VNet |
This template provides a way to deploy a Flexible server Azure database for MySQL 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"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "SystemAssigned"
}
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 = "5.7"
}
sku = {
name = "string"
tier = "string"
}
})
}
Property values
flexibleServers
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.DBForMySql/flexibleServers@2020-07-01-preview" |
| name | The resource name | string (required) |
| location | The geo-location where the resource lives | string (required) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. |
| sku | The SKU (pricing tier) of the server. | Sku |
| identity | The Azure Active Directory identity of the server. | Identity |
| properties | Properties of the 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 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. | object |
| version | Server version. | "5.7" |
DelegatedSubnetArguments
| Name | Description | Value |
|---|---|---|
| subnetArmResourceId | delegated subnet arm resource id. | 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 |
PrivateDnsZoneArguments
| Name | Description | Value |
|---|---|---|
| privateDnsZoneArmResourceId | private dns zone arm resource id. | string |
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 |
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) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for