Microsoft.Sql servers/administrators 2019-06-01-preview

  • Article
  • 2 minutes to read

The servers/administrators resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

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

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

Property values

servers/administrators

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.		 'Microsoft.Sql/servers/administrators'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.		 '2019-06-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.		 '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 a active directory administrator. AdministratorProperties

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 (required)
tenantId Tenant ID of the administrator. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
App Service Environment with Azure SQL backend

Deploy to Azure		 This template creates an App Service Environment with an Azure SQL backend along with private endpoints along with associated resources typically used in an private/isolated environment.