Microsoft.Sql servers/administrators template reference

  • 2 minutes to read

Template format

To create a Microsoft.Sql/servers/administrators resource, add the following JSON to the resources section of your template.

{
  "name": "ActiveDirectory",
  "type": "Microsoft.Sql/servers/administrators",
  "apiVersion": "2019-06-01-preview",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "string",
    "sid": "string",
    "tenantId": "string",
    "azureADOnlyAuthentication": "boolean"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Sql/servers/administrators object

Name Type Required Value
name string Yes Name of the server administrator resource. - ActiveDirectory
type enum Yes administrators
-or-
Microsoft.Sql/servers/administrators

See Set name and type for child resources.
apiVersion enum Yes 2019-06-01-preview
properties object Yes Resource properties. - AdministratorProperties object

AdministratorProperties object

Name Type Required Value
administratorType enum Yes Type of the sever administrator. - ActiveDirectory
login string Yes Login name of the server administrator.
sid string Yes SID (object ID) of the server administrator. - globally unique identifier
tenantId string No Tenant ID of the administrator. - globally unique identifier
azureADOnlyAuthentication boolean No Azure Active Directory only Authentication enabled.