Microsoft.DBforMariaDB servers

Bicep resource definition

The servers resource type can be deployed to:

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

Resource format

To create a Microsoft.DBforMariaDB/servers resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DBforMariaDB/servers@2018-06-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  properties: {
    minimalTlsVersion: 'string'
    publicNetworkAccess: 'string'
    sslEnforcement: 'string'
    storageProfile: {
      backupRetentionDays: int
      geoRedundantBackup: 'string'
      storageAutogrow: 'string'
      storageMB: int
    }
    version: 'string'
    createMode: 'string'
    // For remaining properties, see ServerPropertiesForCreateOrServerProperties objects
  }
}

ServerPropertiesForCreateOrServerProperties objects

Set the createMode property to specify the type of object.

For Default, use:

  createMode: 'Default'
  administratorLogin: 'string'
  administratorLoginPassword: 'string'

For GeoRestore, use:

  createMode: 'GeoRestore'
  sourceServerId: 'string'

For PointInTimeRestore, use:

  createMode: 'PointInTimeRestore'
  restorePointInTime: 'string'
  sourceServerId: 'string'

For Replica, use:

  createMode: 'Replica'
  sourceServerId: 'string'

Property values

servers

Name Description Value
name The resource name string (required)

Character limit: 3-63

Valid characters:
Lowercase letters, hyphens and numbers.

Can't start or end with hyphen.

Resource name must be unique across Azure.
location The location the resource resides in. string (required)
tags Application-specific metadata in the form of key-value pairs. Dictionary of tag names and values. See Tags in templates
sku The SKU (pricing tier) of the server. Sku
properties Properties of the server. ServerPropertiesForCreateOrServerProperties (required)

ServerPropertiesForCreateOrServerProperties

Name Description Value
minimalTlsVersion Enforce a minimal Tls version for the server. 'TLS1_0'
'TLS1_1'
'TLS1_2'
'TLSEnforcementDisabled'
publicNetworkAccess Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' 'Disabled'
'Enabled'
sslEnforcement Enable ssl enforcement or not when connect to server. 'Disabled'
'Enabled'
storageProfile Storage profile of a server. StorageProfile
version Server version. '10.2'
'10.3'
createMode Set the object type Default
GeoRestore
PointInTimeRestore
Replica (required)

StorageProfile

Name Description Value
backupRetentionDays Backup retention days for the server. int
geoRedundantBackup Enable Geo-redundant or not for server backup. 'Disabled'
'Enabled'
storageAutogrow Enable Storage Auto Grow. 'Disabled'
'Enabled'
storageMB Max storage allowed for a server. int

ServerPropertiesForDefaultCreate

Name Description Value
createMode The mode to create a new server. 'Default' (required)
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 (required)
administratorLoginPassword The password of the administrator login. string (required)

ServerPropertiesForGeoRestore

Name Description Value
createMode The mode to create a new server. 'GeoRestore' (required)
sourceServerId The source server id to restore from. string (required)

ServerPropertiesForRestore

Name Description Value
createMode The mode to create a new server. 'PointInTimeRestore' (required)
restorePointInTime Restore point creation time (ISO8601 format), specifying the time to restore from. string (required)
sourceServerId The source server id to restore from. string (required)

ServerPropertiesForReplica

Name Description Value
createMode The mode to create a new server. 'Replica' (required)
sourceServerId The primary server id to create replica from. string (required)

Sku

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Deploy Azure Database for MariaDB with VNet

Deploy to Azure
This template provides a way to deploy an Azure database for MariaDB with VNet integration.

ARM template resource definition

The servers resource type can be deployed to:

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

Resource format

To create a Microsoft.DBforMariaDB/servers resource, add the following JSON to your template.

{
  "type": "Microsoft.DBforMariaDB/servers",
  "apiVersion": "2018-06-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "properties": {
    "minimalTlsVersion": "string",
    "publicNetworkAccess": "string",
    "sslEnforcement": "string",
    "storageProfile": {
      "backupRetentionDays": "int",
      "geoRedundantBackup": "string",
      "storageAutogrow": "string",
      "storageMB": "int"
    },
    "version": "string",
    "createMode": "string"
    // For remaining properties, see ServerPropertiesForCreateOrServerProperties objects
  }
}

ServerPropertiesForCreateOrServerProperties objects

Set the createMode property to specify the type of object.

For Default, use:

  "createMode": "Default",
  "administratorLogin": "string",
  "administratorLoginPassword": "string"

For GeoRestore, use:

  "createMode": "GeoRestore",
  "sourceServerId": "string"

For PointInTimeRestore, use:

  "createMode": "PointInTimeRestore",
  "restorePointInTime": "string",
  "sourceServerId": "string"

For Replica, use:

  "createMode": "Replica",
  "sourceServerId": "string"

Property values

servers

Name Description Value
type The resource type 'Microsoft.DBforMariaDB/servers'
apiVersion The resource api version '2018-06-01'
name The resource name string (required)

Character limit: 3-63

Valid characters:
Lowercase letters, hyphens and numbers.

Can't start or end with hyphen.

Resource name must be unique across Azure.
location The location the resource resides in. string (required)
tags Application-specific metadata in the form of key-value pairs. Dictionary of tag names and values. See Tags in templates
sku The SKU (pricing tier) of the server. Sku
properties Properties of the server. ServerPropertiesForCreateOrServerProperties (required)

ServerPropertiesForCreateOrServerProperties

Name Description Value
minimalTlsVersion Enforce a minimal Tls version for the server. 'TLS1_0'
'TLS1_1'
'TLS1_2'
'TLSEnforcementDisabled'
publicNetworkAccess Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' 'Disabled'
'Enabled'
sslEnforcement Enable ssl enforcement or not when connect to server. 'Disabled'
'Enabled'
storageProfile Storage profile of a server. StorageProfile
version Server version. '10.2'
'10.3'
createMode Set the object type Default
GeoRestore
PointInTimeRestore
Replica (required)

StorageProfile

Name Description Value
backupRetentionDays Backup retention days for the server. int
geoRedundantBackup Enable Geo-redundant or not for server backup. 'Disabled'
'Enabled'
storageAutogrow Enable Storage Auto Grow. 'Disabled'
'Enabled'
storageMB Max storage allowed for a server. int

ServerPropertiesForDefaultCreate

Name Description Value
createMode The mode to create a new server. 'Default' (required)
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 (required)
administratorLoginPassword The password of the administrator login. string (required)

ServerPropertiesForGeoRestore

Name Description Value
createMode The mode to create a new server. 'GeoRestore' (required)
sourceServerId The source server id to restore from. string (required)

ServerPropertiesForRestore

Name Description Value
createMode The mode to create a new server. 'PointInTimeRestore' (required)
restorePointInTime Restore point creation time (ISO8601 format), specifying the time to restore from. string (required)
sourceServerId The source server id to restore from. string (required)

ServerPropertiesForReplica

Name Description Value
createMode The mode to create a new server. 'Replica' (required)
sourceServerId The primary server id to create replica from. string (required)

Sku

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Deploy Azure Database for MariaDB with VNet

Deploy to Azure
This template provides a way to deploy an Azure database for MariaDB with VNet integration.

Terraform (AzAPI provider) resource definition

The servers resource type can be deployed to:

  • Resource groups

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

Resource format

To create a Microsoft.DBforMariaDB/servers resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforMariaDB/servers@2018-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      minimalTlsVersion = "string"
      publicNetworkAccess = "string"
      sslEnforcement = "string"
      storageProfile = {
        backupRetentionDays = int
        geoRedundantBackup = "string"
        storageAutogrow = "string"
        storageMB = int
      }
      version = "string"
      createMode = "string"
      // For remaining properties, see ServerPropertiesForCreateOrServerProperties objects
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  })
}

ServerPropertiesForCreateOrServerProperties objects

Set the createMode property to specify the type of object.

For Default, use:

  createMode = "Default"
  administratorLogin = "string"
  administratorLoginPassword = "string"

For GeoRestore, use:

  createMode = "GeoRestore"
  sourceServerId = "string"

For PointInTimeRestore, use:

  createMode = "PointInTimeRestore"
  restorePointInTime = "string"
  sourceServerId = "string"

For Replica, use:

  createMode = "Replica"
  sourceServerId = "string"

Property values

servers

Name Description Value
type The resource type "Microsoft.DBforMariaDB/servers@2018-06-01"
name The resource name string (required)

Character limit: 3-63

Valid characters:
Lowercase letters, hyphens and numbers.

Can't start or end with hyphen.

Resource name must be unique across Azure.
location The location the resource resides in. string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Application-specific metadata in the form of key-value pairs. Dictionary of tag names and values.
sku The SKU (pricing tier) of the server. Sku
properties Properties of the server. ServerPropertiesForCreateOrServerProperties (required)

ServerPropertiesForCreateOrServerProperties

Name Description Value
minimalTlsVersion Enforce a minimal Tls version for the server. "TLS1_0"
"TLS1_1"
"TLS1_2"
"TLSEnforcementDisabled"
publicNetworkAccess Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' "Disabled"
"Enabled"
sslEnforcement Enable ssl enforcement or not when connect to server. "Disabled"
"Enabled"
storageProfile Storage profile of a server. StorageProfile
version Server version. "10.2"
"10.3"
createMode Set the object type Default
GeoRestore
PointInTimeRestore
Replica (required)

StorageProfile

Name Description Value
backupRetentionDays Backup retention days for the server. int
geoRedundantBackup Enable Geo-redundant or not for server backup. "Disabled"
"Enabled"
storageAutogrow Enable Storage Auto Grow. "Disabled"
"Enabled"
storageMB Max storage allowed for a server. int

ServerPropertiesForDefaultCreate

Name Description Value
createMode The mode to create a new server. "Default" (required)
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 (required)
administratorLoginPassword The password of the administrator login. string (required)

ServerPropertiesForGeoRestore

Name Description Value
createMode The mode to create a new server. "GeoRestore" (required)
sourceServerId The source server id to restore from. string (required)

ServerPropertiesForRestore

Name Description Value
createMode The mode to create a new server. "PointInTimeRestore" (required)
restorePointInTime Restore point creation time (ISO8601 format), specifying the time to restore from. string (required)
sourceServerId The source server id to restore from. string (required)

ServerPropertiesForReplica

Name Description Value
createMode The mode to create a new server. "Replica" (required)
sourceServerId The primary server id to create replica from. string (required)

Sku

Name Description Value
capacity The scale up/out capacity, representing server's compute units. int
family The family of hardware. string
name The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. string (required)
size The size code, to be interpreted by resource as appropriate. string
tier The tier of the particular SKU, e.g. Basic. "Basic"
"GeneralPurpose"
"MemoryOptimized"