Microsoft.Sql servers/firewallRules 2014-04-01

• Latest
• 2023-05-01-preview
• 2023-02-01-preview
• 2022-11-01-preview
• 2022-08-01-preview
• 2022-05-01-preview
• 2022-02-01-preview
• 2021-11-01
• 2021-11-01-preview
• 2021-08-01-preview
• 2021-05-01-preview
• 2021-02-01-preview
• 2020-11-01-preview
• 2020-08-01-preview
• 2020-02-02-preview
• 2015-05-01-preview
• 2014-04-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Sql/servers/firewallRules@2014-04-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    endIpAddress: 'string'
    startIpAddress: 'string'
  }
}

Property values

servers/firewallRules

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required) Character limit: 1-128 Valid characters: Can't use: <>*%&:;\/? or control characters Can't end with period.
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	The properties representing the resource.	FirewallRuleProperties

FirewallRuleProperties

Name	Description	Value
endIpAddress	The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' to represent all Azure-internal IP addresses.	string (required)
startIpAddress	The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' to represent all Azure-internal IP addresses.	string (required)

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

{
  "type": "Microsoft.Sql/servers/firewallRules",
  "apiVersion": "2014-04-01",
  "name": "string",
  "properties": {
    "endIpAddress": "string",
    "startIpAddress": "string"
  }
}

Property values

servers/firewallRules

Name	Description	Value
type	The resource type	'Microsoft.Sql/servers/firewallRules'
apiVersion	The resource api version	'2014-04-01'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required) Character limit: 1-128 Valid characters: Can't use: <>*%&:;\/? or control characters Can't end with period.
properties	The properties representing the resource.	FirewallRuleProperties

FirewallRuleProperties

Name	Description	Value
endIpAddress	The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' to represent all Azure-internal IP addresses.	string (required)
startIpAddress	The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' to represent all Azure-internal IP addresses.	string (required)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/firewallRules@2014-04-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      endIpAddress = "string"
      startIpAddress = "string"
    }
  })
}

Property values

servers/firewallRules

Name	Description	Value
type	The resource type	"Microsoft.Sql/servers/firewallRules@2014-04-01"
name	The resource name	string (required) Character limit: 1-128 Valid characters: Can't use: <>*%&:;\/? or control characters Can't end with period.
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: servers
properties	The properties representing the resource.	FirewallRuleProperties

FirewallRuleProperties

Name	Description	Value
endIpAddress	The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' to represent all Azure-internal IP addresses.	string (required)
startIpAddress	The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' to represent all Azure-internal IP addresses.	string (required)