Microsoft.DBforMySQL servers/administrators 2017-12-01-preview

Bicep resource definition

The servers/administrators resource type can be deployed with operations that target:

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

Resource format

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

resource symbolicname 'Microsoft.DBforMySQL/servers/administrators@2017-12-01-preview' = {
  name: 'activeDirectory'
  parent: resourceSymbolicName
  properties: {
    administratorType: 'ActiveDirectory'
    login: 'string'
    sid: 'string'
    tenantId: 'string'
  }
}

Property values

servers/administrators

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
'activeDirectory'
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: servers
properties Properties of the server AAD administrator. ServerAdministratorProperties

ServerAdministratorProperties

Name Description Value
administratorType The type of administrator. 'ActiveDirectory' (required)
login The server administrator login account name. string (required)
sid The server administrator Sid (Secure ID). string (required)

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tenantId The server Active Directory Administrator tenant id. string (required)

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ARM template resource definition

The servers/administrators resource type can be deployed with operations that target:

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

Resource format

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

{
  "type": "Microsoft.DBforMySQL/servers/administrators",
  "apiVersion": "2017-12-01-preview",
  "name": "activeDirectory",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "string",
    "sid": "string",
    "tenantId": "string"
  }
}

Property values

servers/administrators

Name Description Value
type The resource type 'Microsoft.DBforMySQL/servers/administrators'
apiVersion The resource api version '2017-12-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
'activeDirectory'
properties Properties of the server AAD administrator. ServerAdministratorProperties

ServerAdministratorProperties

Name Description Value
administratorType The type of administrator. 'ActiveDirectory' (required)
login The server administrator login account name. string (required)
sid The server administrator Sid (Secure ID). string (required)

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tenantId The server Active Directory Administrator tenant id. string (required)

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

Terraform (AzAPI provider) resource definition

The servers/administrators 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/servers/administrators resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforMySQL/servers/administrators@2017-12-01-preview"
  name = "activeDirectory"
  parent_id = "string"
  body = jsonencode({
    properties = {
      administratorType = "ActiveDirectory"
      login = "string"
      sid = "string"
      tenantId = "string"
    }
  })
}

Property values

servers/administrators

Name Description Value
type The resource type "Microsoft.DBforMySQL/servers/administrators@2017-12-01-preview"
name The resource name "activeDirectory"
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: servers
properties Properties of the server AAD administrator. ServerAdministratorProperties

ServerAdministratorProperties

Name Description Value
administratorType The type of administrator. "ActiveDirectory" (required)
login The server administrator login account name. string (required)
sid The server administrator Sid (Secure ID). string (required)

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tenantId The server Active Directory Administrator tenant id. string (required)

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$