Microsoft.DBforMySQL flexibleServers 2021-05-01-preview
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.
Use the maintenanceWindow
property only when updating an existing flexible server. When creating a new flexible servcer, don't specify values for this property.
To create a Microsoft.DBforMySQL/flexibleServers resource, add the following Bicep 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'
}
}
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 |
Name | Description | Value |
---|---|---|
type | The identity type. | 'SystemAssigned' |
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 |
backup | Backup related properties of a server. | Backup |
createMode | The mode to create a new MySQL server. | 'Default' 'GeoRestore' 'PointInTimeRestore' 'Replica' |
highAvailability | High availability 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 related properties of a server. | Storage |
version | Server version. | '5.7' '8.0.21' |
Name | Description | Value |
---|---|---|
backupRetentionDays | Backup retention days for the server. | int |
geoRedundantBackup | Whether or not geo redundant backup is enabled. | 'Disabled' 'Enabled' |
Name | Description | Value |
---|---|---|
mode | High availability mode for a server. | 'Disabled' 'Enabled' 'SameZone' 'ZoneRedundant' |
standbyAvailabilityZone | Availability zone of the standby server. | string |
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 |
Name | Description | Value |
---|---|---|
delegatedSubnetResourceId | Delegated subnet resource id used to setup vnet for a server. | string |
privateDnsZoneResourceId | Private DNS zone resource id. | string |
Name | Description | Value |
---|---|---|
autoGrow | Enable Storage Auto Grow or not. | 'Disabled' 'Enabled' |
iops | Storage IOPS for a server. | int |
storageSizeGB | Max storage size allowed for a server. | int |
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) |
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. |
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.
Use the maintenanceWindow
property only when updating an existing flexible server. When creating a new flexible servcer, don't specify values for this property.
To create a Microsoft.DBforMySQL/flexibleServers resource, add the following JSON to your template.
{
"type": "Microsoft.DBforMySQL/flexibleServers",
"apiVersion": "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"
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.DBforMySQL/flexibleServers' |
apiVersion | The resource api version | '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 | The SKU (pricing tier) of the server. | Sku |
identity | The Azure Active Directory identity of the server. | Identity |
properties | Properties of the server. | ServerProperties |
Name | Description | Value |
---|---|---|
type | The identity type. | 'SystemAssigned' |
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 |
backup | Backup related properties of a server. | Backup |
createMode | The mode to create a new MySQL server. | 'Default' 'GeoRestore' 'PointInTimeRestore' 'Replica' |
highAvailability | High availability 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 related properties of a server. | Storage |
version | Server version. | '5.7' '8.0.21' |
Name | Description | Value |
---|---|---|
backupRetentionDays | Backup retention days for the server. | int |
geoRedundantBackup | Whether or not geo redundant backup is enabled. | 'Disabled' 'Enabled' |
Name | Description | Value |
---|---|---|
mode | High availability mode for a server. | 'Disabled' 'Enabled' 'SameZone' 'ZoneRedundant' |
standbyAvailabilityZone | Availability zone of the standby server. | string |
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 |
Name | Description | Value |
---|---|---|
delegatedSubnetResourceId | Delegated subnet resource id used to setup vnet for a server. | string |
privateDnsZoneResourceId | Private DNS zone resource id. | string |
Name | Description | Value |
---|---|---|
autoGrow | Enable Storage Auto Grow or not. | 'Disabled' 'Enabled' |
iops | Storage IOPS for a server. | int |
storageSizeGB | Max storage size allowed for a server. | int |
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) |
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. |
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.
To create a Microsoft.DBforMySQL/flexibleServers resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DBforMySQL/flexibleServers@2021-05-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"
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"
}
sku = {
name = "string"
tier = "string"
}
})
}
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.DBforMySQL/flexibleServers@2021-05-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 |
Name | Description | Value |
---|---|---|
type | The identity type. | "SystemAssigned" |
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 |
backup | Backup related properties of a server. | Backup |
createMode | The mode to create a new MySQL server. | "Default" "GeoRestore" "PointInTimeRestore" "Replica" |
highAvailability | High availability 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 related properties of a server. | Storage |
version | Server version. | "5.7" "8.0.21" |
Name | Description | Value |
---|---|---|
backupRetentionDays | Backup retention days for the server. | int |
geoRedundantBackup | Whether or not geo redundant backup is enabled. | "Disabled" "Enabled" |
Name | Description | Value |
---|---|---|
mode | High availability mode for a server. | "Disabled" "Enabled" "SameZone" "ZoneRedundant" |
standbyAvailabilityZone | Availability zone of the standby server. | string |
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 |
Name | Description | Value |
---|---|---|
delegatedSubnetResourceId | Delegated subnet resource id used to setup vnet for a server. | string |
privateDnsZoneResourceId | Private DNS zone resource id. | string |
Name | Description | Value |
---|---|---|
autoGrow | Enable Storage Auto Grow or not. | "Disabled" "Enabled" |
iops | Storage IOPS for a server. | int |
storageSizeGB | Max storage size allowed for a server. | int |
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) |