Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The servers/virtualNetworkRules 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/virtualNetworkRules resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DBforMySQL/servers/virtualNetworkRules@2017-12-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
ignoreMissingVnetServiceEndpoint: bool
virtualNetworkSubnetId: 'string'
}
}
Property Values
Microsoft.DBforMySQL/servers/virtualNetworkRules
| 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 | Resource properties. | VirtualNetworkRuleProperties |
VirtualNetworkRuleProperties
| Name | Description | Value |
|---|---|---|
| ignoreMissingVnetServiceEndpoint | Create firewall rule before the virtual network has vnet service endpoint enabled. | bool |
| virtualNetworkSubnetId | The ARM resource id of the virtual network subnet. | string (required) |
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Deploy Azure Database for MySQL with VNet | This template provides a way to deploy an Azure database for MySQL with VNet integration. |
ARM template resource definition
The servers/virtualNetworkRules 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/virtualNetworkRules resource, add the following JSON to your template.
{
"type": "Microsoft.DBforMySQL/servers/virtualNetworkRules",
"apiVersion": "2017-12-01",
"name": "string",
"properties": {
"ignoreMissingVnetServiceEndpoint": "bool",
"virtualNetworkSubnetId": "string"
}
}
Property Values
Microsoft.DBforMySQL/servers/virtualNetworkRules
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2017-12-01' |
| name | The resource name | string (required) |
| properties | Resource properties. | VirtualNetworkRuleProperties |
| type | The resource type | 'Microsoft.DBforMySQL/servers/virtualNetworkRules' |
VirtualNetworkRuleProperties
| Name | Description | Value |
|---|---|---|
| ignoreMissingVnetServiceEndpoint | Create firewall rule before the virtual network has vnet service endpoint enabled. | bool |
| virtualNetworkSubnetId | The ARM resource id of the virtual network subnet. | string (required) |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Deploy Azure Database for MySQL with VNet |
This template provides a way to deploy an Azure database for MySQL with VNet integration. |
Terraform (AzAPI provider) resource definition
The servers/virtualNetworkRules 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/virtualNetworkRules resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DBforMySQL/servers/virtualNetworkRules@2017-12-01"
name = "string"
parent_id = "string"
body = {
properties = {
ignoreMissingVnetServiceEndpoint = bool
virtualNetworkSubnetId = "string"
}
}
}
Property Values
Microsoft.DBforMySQL/servers/virtualNetworkRules
| 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 | Resource properties. | VirtualNetworkRuleProperties |
| type | The resource type | "Microsoft.DBforMySQL/servers/virtualNetworkRules@2017-12-01" |
VirtualNetworkRuleProperties
| Name | Description | Value |
|---|---|---|
| ignoreMissingVnetServiceEndpoint | Create firewall rule before the virtual network has vnet service endpoint enabled. | bool |
| virtualNetworkSubnetId | The ARM resource id of the virtual network subnet. | string (required) |
Usage Examples
Terraform Samples
A basic example of deploying Database for MySQL Servers Virtual Network Rules.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
variable "administrator_login" {
type = string
description = "The administrator login name for the MySQL server"
}
variable "administrator_login_password" {
type = string
description = "The administrator login password for the MySQL server"
sensitive = true
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "virtualNetwork" {
type = "Microsoft.Network/virtualNetworks@2022-07-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
addressSpace = {
addressPrefixes = [
"10.7.29.0/29",
]
}
dhcpOptions = {
dnsServers = [
]
}
subnets = [
]
}
}
schema_validation_enabled = false
response_export_values = ["*"]
lifecycle {
ignore_changes = [body.properties.subnets]
}
}
resource "azapi_resource" "server" {
type = "Microsoft.DBforMySQL/servers@2017-12-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
administratorLogin = var.administrator_login
administratorLoginPassword = var.administrator_login_password
createMode = "Default"
infrastructureEncryption = "Disabled"
minimalTlsVersion = "TLS1_2"
publicNetworkAccess = "Enabled"
sslEnforcement = "Enabled"
storageProfile = {
backupRetentionDays = 7
storageAutogrow = "Enabled"
storageMB = 51200
}
version = "5.7"
}
sku = {
capacity = 2
family = "Gen5"
name = "GP_Gen5_2"
tier = "GeneralPurpose"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "subnet" {
type = "Microsoft.Network/virtualNetworks/subnets@2022-07-01"
parent_id = azapi_resource.virtualNetwork.id
name = var.resource_name
body = {
properties = {
addressPrefix = "10.7.29.0/29"
delegations = [
]
privateEndpointNetworkPolicies = "Enabled"
privateLinkServiceNetworkPolicies = "Enabled"
serviceEndpointPolicies = [
]
serviceEndpoints = [
{
service = "Microsoft.Sql"
},
]
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "virtualNetworkRule" {
type = "Microsoft.DBforMySQL/servers/virtualNetworkRules@2017-12-01"
parent_id = azapi_resource.server.id
name = var.resource_name
body = {
properties = {
ignoreMissingVnetServiceEndpoint = false
virtualNetworkSubnetId = azapi_resource.subnet.id
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}