Share via

Microsoft.Sql servers/virtualNetworkRules 2023-05-01-preview

  • Article

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

resource symbolicname 'Microsoft.Sql/servers/virtualNetworkRules@2023-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    ignoreMissingVnetServiceEndpoint: bool
    virtualNetworkSubnetId: 'string'
  }
}

Property values

Microsoft.Sql/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)

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

{
  "type": "Microsoft.Sql/servers/virtualNetworkRules",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "ignoreMissingVnetServiceEndpoint": "bool",
    "virtualNetworkSubnetId": "string"
  }
}

Property values

Microsoft.Sql/servers/virtualNetworkRules

Name Description Value
apiVersion The api version '2023-05-01-preview'
name The resource name string (required)
properties Resource properties. VirtualNetworkRuleProperties
type The resource type 'Microsoft.Sql/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)

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/virtualNetworkRules@2023-05-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      ignoreMissingVnetServiceEndpoint = bool
      virtualNetworkSubnetId = "string"
    }
  })
}

Property values

Microsoft.Sql/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.Sql/servers/virtualNetworkRules@2023-05-01-preview"

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)