Share via

Microsoft.DBforMySQL servers/firewallRules 2017-12-01-preview

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.DBforMySQL/servers/firewallRules@2017-12-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    endIpAddress: 'string'
    startIpAddress: 'string'
  }
}

Property values

FirewallRuleProperties

Name Description Value
endIpAddress The end IP address of the server firewall rule. Must be IPv4 format. string

Constraints:
Pattern = ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ (required)
startIpAddress The start IP address of the server firewall rule. Must be IPv4 format. string

Constraints:
Pattern = ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ (required)

Microsoft.DBforMySQL/servers/firewallRules

Name Description Value
name The resource name string (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 The properties of a firewall rule. FirewallRuleProperties (required)

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Build a Web App on Linux with Azure database for MySQL This template provides a way to deploy Web Apps on Linux with Azure database for MySQL.
Deploy Azure Database for MySQL with VNet This template provides a way to deploy an Azure database for MySQL with VNet integration.
Deploys 1 MySQL PaaS instance and up to 5 read only replicas This template will deploy a MySQL PaaS Server instance, and from 0 to 5 read only replicas. They will all be set on the same location as the master and replication will be automatically configured.
Web App with Azure database for MySQL This template provides a easy way to deploy web app on Azure App Service Web Apps with Azure database for MySQL.

ARM template resource definition

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

{
  "type": "Microsoft.DBforMySQL/servers/firewallRules",
  "apiVersion": "2017-12-01-preview",
  "name": "string",
  "properties": {
    "endIpAddress": "string",
    "startIpAddress": "string"
  }
}

Property values

FirewallRuleProperties

Name Description Value
endIpAddress The end IP address of the server firewall rule. Must be IPv4 format. string

Constraints:
Pattern = ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ (required)
startIpAddress The start IP address of the server firewall rule. Must be IPv4 format. string

Constraints:
Pattern = ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ (required)

Microsoft.DBforMySQL/servers/firewallRules

Name Description Value
apiVersion The api version '2017-12-01-preview'
name The resource name string (required)
properties The properties of a firewall rule. FirewallRuleProperties (required)
type The resource type 'Microsoft.DBforMySQL/servers/firewallRules'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Build a Web App on Linux with Azure database for MySQL

Deploy to Azure		 This template provides a way to deploy Web Apps on Linux with Azure database for MySQL.
Deploy Azure Database for MySQL with VNet

Deploy to Azure		 This template provides a way to deploy an Azure database for MySQL with VNet integration.
Deploys 1 MySQL PaaS instance and up to 5 read only replicas

Deploy to Azure		 This template will deploy a MySQL PaaS Server instance, and from 0 to 5 read only replicas. They will all be set on the same location as the master and replication will be automatically configured.
Web App with Azure database for MySQL

Deploy to Azure		 This template provides a easy way to deploy web app on Azure App Service Web Apps with Azure database for MySQL.

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforMySQL/servers/firewallRules@2017-12-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      endIpAddress = "string"
      startIpAddress = "string"
    }
  })
}

Property values

FirewallRuleProperties

Name Description Value
endIpAddress The end IP address of the server firewall rule. Must be IPv4 format. string

Constraints:
Pattern = ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ (required)
startIpAddress The start IP address of the server firewall rule. Must be IPv4 format. string

Constraints:
Pattern = ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ (required)

Microsoft.DBforMySQL/servers/firewallRules

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: servers
properties The properties of a firewall rule. FirewallRuleProperties (required)
type The resource type "Microsoft.DBforMySQL/servers/firewallRules@2017-12-01-preview"