Microsoft.Sql servers 2023-05-01-preview

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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

Resource format

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

resource symbolicname 'Microsoft.Sql/servers@2023-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    administrators: {
      administratorType: 'ActiveDirectory'
      azureADOnlyAuthentication: bool
      login: 'string'
      principalType: 'string'
      sid: 'string'
      tenantId: 'string'
    }
    federatedClientId: 'string'
    isIPv6Enabled: 'string'
    keyId: 'string'
    minimalTlsVersion: 'string'
    primaryUserAssignedIdentityId: 'string'
    publicNetworkAccess: 'string'
    restrictOutboundNetworkAccess: 'string'
    version: 'string'
  }
}

Property values

servers

ResourceIdentity

ResourceIdentityUserAssignedIdentities

UserIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ServerProperties

ServerExternalAdministrator

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Django App with SQL Databases	This template uses the Azure Linux CustomScript extension to deploy an application. This example creates an Ubuntu VM, does a silent install of Python, Django and Apache, then creates a simple Django app. The template also creates a SQL Database, with a sample table with some sample data which displayed in the web browser using a query
EPiserverCMS in Azure	This template allows you to create resources required for EpiServerCMS deployment in Azure
Kentico Xperience	This template facilitates the deployment of resources required to host Kentico Xperience environments in Microsoft Azure.
Autoscale LANSA Windows VM ScaleSet with Azure SQL Database	The template deploys a Windows VMSS with a desired count of VMs in the scale set and a LANSA MSI to install into each VM. Once the VM Scale Set is deployed a custom script extension is used to install the LANSA MSI)
Deploy Octopus Deploy 3.0 with a trial license	This template allows you to deploy a single Octopus Deploy 3.0 server with a trial license. This will deploy on a single Windows Server 2012R2 VM (Standard D2) and SQL DB (S1 tier) into the location specified for the Resource Group.
Orchard CMS Video Portal Web App	This template provides a easy way to deploy Orchard CMS on Azure App Service Web Apps with the Azure Media Services module enabled and configured.
Create an Azure SQL Server, with data encryption protector	This template creates an Azure SQL server, activates the data encryption protector using a given key stored in a given Key Vault
Scalable Umbraco CMS Web App	This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
Simple Umbraco CMS Web App	This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
Enterprise Governance-AppService, SQL DB, AD, OMS, Runbooks	Cloud adoption for an Enterprise, small or large, require responsible and efficient governance models to derive value from their cloud deployments. CloudWise (a code-name for the solution), is a composite solution available from Azure Partner QuickStarts, is an adoption enabler for Customers, System Integrators and Partners alike, that delivers a self-serviceable, automated governance and operations solution, focused on Optimizing Your Costs, Improve Your Application(s) Reliability, Reducing Business Risk. The solution highlights the core governance pillars of Visibility and Control.
eShop Website with ILB ASE	An App Service Environment is a Premium service plan option of Azure App Service that provides a fully isolated and dedicated environment for securely running Azure App Service apps at high scale, including Web Apps, Mobile Apps, and API Apps.
WebApp consuming a Azure SQL Private Endpoint	This template shows how to create a Web app that consumes a private endpoint pointing to Azure SQL Server
Remote Desktop Services with High Availability	This ARM Template sample code will deploy a Remote Desktop Services 2019 Session Collection lab with high availability. The goal is to deploy a fully redundant, highly available solution for Remote Desktop Services, using Windows Server 2019.
Deploy the Sports Analytics on Azure Architecture	Creates an Azure storage account with ADLS Gen 2 enabled, an Azure Data Factory instance with linked services for the storage account (an the Azure SQL Database if deployed), and an Azure Databricks instance. The AAD identity for the user deploying the template and the managed identity for the ADF instance will be granted the Storage Blob Data Contributor role on the storage account. There are also options to deploy an Azure Key Vault instance, an Azure SQL Database, and an Azure Event Hub (for streaming use cases). When an Azure Key Vault is deployed, the data factory managed identity and the AAD identity for the user deploying the template will be granted the Key Vault Secrets User role.
Web App with a SQL Database, Azure Cosmos DB, Azure Search	This template provisions a Web App, a SQL Database, Azure Cosmos DB, Azure Search and Application Insights.
Migrate to Azure SQL database using Azure DMS	The Azure Database Migration Service (DMS) is designed to streamline the process of migrating on-premises databases to Azure. DMS will simplify the migration of existing on-premises SQL Server and Oracle databases to Azure SQL Database, Azure SQL Managed Instance or Microsoft SQL Server in an Azure Virtual Machine. This template would deploy an instance of Azure Database Migration service, an Azure VM with SQL server installed on it which will act as a Source server with pre created database on it and a Target Azure SQL DB server which will have a pre-created schema of the database to be migrated from Source to Target server. The template will also deploy the required resources like NIC, vnet etc for supporting the Source VM, DMS service and Target server.
Deploy a HDInsight cluster and a SQL database	This template allows you to create a HDInsight cluster and a SQL Database for testing Sqoop.
Private Endpoint example	This template shows how to create a private endpoint pointing to Azure SQL Server
Azure SQL Server with Auditing written to a blob storage	This template allows you to deploy an Azure SQL server with Auditing enabled to write audit logs to a blob storage
Azure SQL Server with Auditing written to Event Hub	This template allows you to deploy an Azure SQL server with Auditing enabled to write audit logs to Event Hub
Azure SQL Server with Auditing written to Log Analytics	This template allows you to deploy an Azure SQL server with Auditing enabled to write audit logs to Log Analytics (OMS workspace)
Dedicated SQL pool with Transparent Encryption	Creates a SQL Server and a Dedicated SQL pool (formerly SQL DW) with Transparent Data Encryption.
Create a SQL Server and Database	This template allows you to create SQL Database and Server.
Provision a SQL Database with TDE	This template provisions a SQL Server with firewall opened for Azure traffic and a SQL database with Transparent Data Encryption (TDE).
Deploy a new SQL Elastic Pool	This template allows you to deploy a new SQL Elastic Pool with its new associated SQL Server and new SQL Databases to assign to it.
SQL logical server	This template allows you to create SQL logical server.
SQL server with Azure AD-only authentication	This template allows you to create SQL server in Azure with the Azure AD admin set and Azure AD-only authentication feature enabled.
Create Azure SQL Servers and Database with Failover Group	Creates two Azure SQL servers, a database, and a failover group.
App Service Environment with Azure SQL backend	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.
Provision a Mobile App with a SQL Database	This template provisions a Mobile App, SQL Database, and Notification Hub. It configures a connection string in the mobile app for the database and notification hub.
Web App with Managed Identity, SQL Server and ΑΙ	Simple example to deploy Azure infrastructure for app + data + managed identity + monitoring
Create a Web App + Redis Cache + SQL DB with a template	This template creates an Azure Web App with Redis cache and a SQL Database.
Provision a Web App with a SQL Database	This template provisions a Web App, a SQL Database, AutoScale settings, Alert rules, and App Insights. It configures a connection string in the web app for the database.
Create, configure and deploy Web Application to an Azure VM	Create and configure a Windows VM with SQL Azure database, and deploy web application to the environment using PowerShell DSC
Sonarqube Docker Web App on Linux with Azure SQL	This template deploys Sonarqube in an Azure App Service web app Linux container using the official Sonarqube image and backed by an Azure SQL Server.

ARM template resource definition

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

• Resource groups - See resource group deployment commands

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

Resource format

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

{
  "type": "Microsoft.Sql/servers",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "administrators": {
      "administratorType": "ActiveDirectory",
      "azureADOnlyAuthentication": "bool",
      "login": "string",
      "principalType": "string",
      "sid": "string",
      "tenantId": "string"
    },
    "federatedClientId": "string",
    "isIPv6Enabled": "string",
    "keyId": "string",
    "minimalTlsVersion": "string",
    "primaryUserAssignedIdentityId": "string",
    "publicNetworkAccess": "string",
    "restrictOutboundNetworkAccess": "string",
    "version": "string"
  }
}

Property values

servers

ResourceIdentity

ResourceIdentityUserAssignedIdentities

UserIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ServerProperties

ServerExternalAdministrator

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Django App with SQL Databases	This template uses the Azure Linux CustomScript extension to deploy an application. This example creates an Ubuntu VM, does a silent install of Python, Django and Apache, then creates a simple Django app. The template also creates a SQL Database, with a sample table with some sample data which displayed in the web browser using a query
EPiserverCMS in Azure	This template allows you to create resources required for EpiServerCMS deployment in Azure
Kentico Xperience	This template facilitates the deployment of resources required to host Kentico Xperience environments in Microsoft Azure.
Autoscale LANSA Windows VM ScaleSet with Azure SQL Database	The template deploys a Windows VMSS with a desired count of VMs in the scale set and a LANSA MSI to install into each VM. Once the VM Scale Set is deployed a custom script extension is used to install the LANSA MSI)
Deploy Octopus Deploy 3.0 with a trial license	This template allows you to deploy a single Octopus Deploy 3.0 server with a trial license. This will deploy on a single Windows Server 2012R2 VM (Standard D2) and SQL DB (S1 tier) into the location specified for the Resource Group.
Orchard CMS Video Portal Web App	This template provides a easy way to deploy Orchard CMS on Azure App Service Web Apps with the Azure Media Services module enabled and configured.
Create an Azure SQL Server, with data encryption protector	This template creates an Azure SQL server, activates the data encryption protector using a given key stored in a given Key Vault
Scalable Umbraco CMS Web App	This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
Simple Umbraco CMS Web App	This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
Enterprise Governance-AppService, SQL DB, AD, OMS, Runbooks	Cloud adoption for an Enterprise, small or large, require responsible and efficient governance models to derive value from their cloud deployments. CloudWise (a code-name for the solution), is a composite solution available from Azure Partner QuickStarts, is an adoption enabler for Customers, System Integrators and Partners alike, that delivers a self-serviceable, automated governance and operations solution, focused on Optimizing Your Costs, Improve Your Application(s) Reliability, Reducing Business Risk. The solution highlights the core governance pillars of Visibility and Control.
eShop Website with ILB ASE	An App Service Environment is a Premium service plan option of Azure App Service that provides a fully isolated and dedicated environment for securely running Azure App Service apps at high scale, including Web Apps, Mobile Apps, and API Apps.
WebApp consuming a Azure SQL Private Endpoint	This template shows how to create a Web app that consumes a private endpoint pointing to Azure SQL Server
Remote Desktop Services with High Availability	This ARM Template sample code will deploy a Remote Desktop Services 2019 Session Collection lab with high availability. The goal is to deploy a fully redundant, highly available solution for Remote Desktop Services, using Windows Server 2019.
Deploy the Sports Analytics on Azure Architecture	Creates an Azure storage account with ADLS Gen 2 enabled, an Azure Data Factory instance with linked services for the storage account (an the Azure SQL Database if deployed), and an Azure Databricks instance. The AAD identity for the user deploying the template and the managed identity for the ADF instance will be granted the Storage Blob Data Contributor role on the storage account. There are also options to deploy an Azure Key Vault instance, an Azure SQL Database, and an Azure Event Hub (for streaming use cases). When an Azure Key Vault is deployed, the data factory managed identity and the AAD identity for the user deploying the template will be granted the Key Vault Secrets User role.
Web App with a SQL Database, Azure Cosmos DB, Azure Search	This template provisions a Web App, a SQL Database, Azure Cosmos DB, Azure Search and Application Insights.
Migrate to Azure SQL database using Azure DMS	The Azure Database Migration Service (DMS) is designed to streamline the process of migrating on-premises databases to Azure. DMS will simplify the migration of existing on-premises SQL Server and Oracle databases to Azure SQL Database, Azure SQL Managed Instance or Microsoft SQL Server in an Azure Virtual Machine. This template would deploy an instance of Azure Database Migration service, an Azure VM with SQL server installed on it which will act as a Source server with pre created database on it and a Target Azure SQL DB server which will have a pre-created schema of the database to be migrated from Source to Target server. The template will also deploy the required resources like NIC, vnet etc for supporting the Source VM, DMS service and Target server.
Deploy a HDInsight cluster and a SQL database	This template allows you to create a HDInsight cluster and a SQL Database for testing Sqoop.
Private Endpoint example	This template shows how to create a private endpoint pointing to Azure SQL Server
Azure SQL Server with Auditing written to a blob storage	This template allows you to deploy an Azure SQL server with Auditing enabled to write audit logs to a blob storage
Azure SQL Server with Auditing written to Event Hub	This template allows you to deploy an Azure SQL server with Auditing enabled to write audit logs to Event Hub
Azure SQL Server with Auditing written to Log Analytics	This template allows you to deploy an Azure SQL server with Auditing enabled to write audit logs to Log Analytics (OMS workspace)
Dedicated SQL pool with Transparent Encryption	Creates a SQL Server and a Dedicated SQL pool (formerly SQL DW) with Transparent Data Encryption.
Create a SQL Server and Database	This template allows you to create SQL Database and Server.
Provision a SQL Database with TDE	This template provisions a SQL Server with firewall opened for Azure traffic and a SQL database with Transparent Data Encryption (TDE).
Deploy a new SQL Elastic Pool	This template allows you to deploy a new SQL Elastic Pool with its new associated SQL Server and new SQL Databases to assign to it.
SQL logical server	This template allows you to create SQL logical server.
SQL server with Azure AD-only authentication	This template allows you to create SQL server in Azure with the Azure AD admin set and Azure AD-only authentication feature enabled.
Create Azure SQL Servers and Database with Failover Group	Creates two Azure SQL servers, a database, and a failover group.
App Service Environment with Azure SQL backend	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.
Provision a Mobile App with a SQL Database	This template provisions a Mobile App, SQL Database, and Notification Hub. It configures a connection string in the mobile app for the database and notification hub.
Web App with Managed Identity, SQL Server and ΑΙ	Simple example to deploy Azure infrastructure for app + data + managed identity + monitoring
Create a Web App + Redis Cache + SQL DB with a template	This template creates an Azure Web App with Redis cache and a SQL Database.
Provision a Web App with a SQL Database	This template provisions a Web App, a SQL Database, AutoScale settings, Alert rules, and App Insights. It configures a connection string in the web app for the database.
Create, configure and deploy Web Application to an Azure VM	Create and configure a Windows VM with SQL Azure database, and deploy web application to the environment using PowerShell DSC
Sonarqube Docker Web App on Linux with Azure SQL	This template deploys Sonarqube in an Azure App Service web app Linux container using the official Sonarqube image and backed by an Azure SQL Server.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers@2023-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      administrators = {
        administratorType = "ActiveDirectory"
        azureADOnlyAuthentication = bool
        login = "string"
        principalType = "string"
        sid = "string"
        tenantId = "string"
      }
      federatedClientId = "string"
      isIPv6Enabled = "string"
      keyId = "string"
      minimalTlsVersion = "string"
      primaryUserAssignedIdentityId = "string"
      publicNetworkAccess = "string"
      restrictOutboundNetworkAccess = "string"
      version = "string"
    }
  })
}

Property values

servers

ResourceIdentity

ResourceIdentityUserAssignedIdentities

UserIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

ServerProperties

ServerExternalAdministrator