Share via

Microsoft.Sql servers/administrators

  • Article

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

resource symbolicname 'Microsoft.Sql/servers/administrators@2024-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    administratorType: 'string'
    login: 'string'
    sid: 'string'
    tenantId: 'string'
  }
}

Property values

AdministratorProperties

Name Description Value
administratorType Type of the sever administrator. 'ActiveDirectory'
login Login name of the server administrator. string (required)
sid SID (object ID) of the server administrator. string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (required)
tenantId Tenant ID of the administrator. string

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

Microsoft.Sql/servers/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: servers
properties Resource properties. AdministratorProperties

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

{
  "type": "Microsoft.Sql/servers/administrators",
  "apiVersion": "2024-05-01-preview",
  "name": "string",
  "properties": {
    "administratorType": "string",
    "login": "string",
    "sid": "string",
    "tenantId": "string"
  }
}

Property values

AdministratorProperties

Name Description Value
administratorType Type of the sever administrator. 'ActiveDirectory'
login Login name of the server administrator. string (required)
sid SID (object ID) of the server administrator. string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (required)
tenantId Tenant ID of the administrator. string

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

Microsoft.Sql/servers/administrators

Name Description Value
apiVersion The api version '2024-05-01-preview'
name The resource name 'ActiveDirectory' (required)
properties Resource properties. AdministratorProperties
type The resource type 'Microsoft.Sql/servers/administrators'

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/administrators@2024-05-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      administratorType = "string"
      login = "string"
      sid = "string"
      tenantId = "string"
    }
  })
}

Property values

AdministratorProperties

Name Description Value
administratorType Type of the sever administrator. 'ActiveDirectory'
login Login name of the server administrator. string (required)
sid SID (object ID) of the server administrator. string

Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (required)
tenantId Tenant ID of the administrator. string

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

Microsoft.Sql/servers/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: servers
properties Resource properties. AdministratorProperties
type The resource type "Microsoft.Sql/servers/administrators@2024-05-01-preview"