Share via

Microsoft.DBforMySQL flexibleServers/administrators 2023-06-01-preview

Bicep resource definition

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

resource symbolicname 'Microsoft.DBforMySQL/flexibleServers/administrators@2023-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    administratorType: 'string'
    identityResourceId: 'string'
    login: 'string'
    sid: 'string'
    tenantId: 'string'
  }
}

Property Values

Microsoft.DBforMySQL/flexibleServers/administrators

Name Description Value
name The resource name 'ActiveDirectory' (required)
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: flexibleServers
properties The properties of an administrator. AdministratorProperties

AdministratorProperties

Name Description Value
administratorType Type of the sever administrator. 'ActiveDirectory'
identityResourceId The resource id of the identity used for AAD Authentication. string
login Login name of the server administrator. string
sid SID (object ID) of the server administrator. string
tenantId Tenant ID of the administrator. string

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Deploy MySQL Flexible Server with Entra Authentication This template provides a way to deploy a Azure database for MySQL Flexible Server with Entra Authentication.

ARM template resource definition

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

{
  "type": "Microsoft.DBforMySQL/flexibleServers/administrators",
  "apiVersion": "2023-06-01-preview",
  "name": "string",
  "properties": {
    "administratorType": "string",
    "identityResourceId": "string",
    "login": "string",
    "sid": "string",
    "tenantId": "string"
  }
}

Property Values

Microsoft.DBforMySQL/flexibleServers/administrators

Name Description Value
apiVersion The api version '2023-06-01-preview'
name The resource name 'ActiveDirectory' (required)
properties The properties of an administrator. AdministratorProperties
type The resource type 'Microsoft.DBforMySQL/flexibleServers/administrators'

AdministratorProperties

Name Description Value
administratorType Type of the sever administrator. 'ActiveDirectory'
identityResourceId The resource id of the identity used for AAD Authentication. string
login Login name of the server administrator. string
sid SID (object ID) of the server administrator. string
tenantId Tenant ID of the administrator. string

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Deploy MySQL Flexible Server with Entra Authentication

Deploy to Azure		 This template provides a way to deploy a Azure database for MySQL Flexible Server with Entra Authentication.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforMySQL/flexibleServers/administrators@2023-06-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      administratorType = "string"
      identityResourceId = "string"
      login = "string"
      sid = "string"
      tenantId = "string"
    }
  }
}

Property Values

Microsoft.DBforMySQL/flexibleServers/administrators

Name Description Value
name The resource name 'ActiveDirectory' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: flexibleServers
properties The properties of an administrator. AdministratorProperties
type The resource type "Microsoft.DBforMySQL/flexibleServers/administrators@2023-06-01-preview"

AdministratorProperties

Name Description Value
administratorType Type of the sever administrator. 'ActiveDirectory'
identityResourceId The resource id of the identity used for AAD Authentication. string
login Login name of the server administrator. string
sid SID (object ID) of the server administrator. string
tenantId Tenant ID of the administrator. string