Documentation menu

resources

SQL Server

Overview

{
	"sql_server": {
		"name": "sql-lp-test-{env}",
		"keyvault": {
			"name": "kv-lp-test-{env}"
		},
        {
        "admin": {
			"username": "test1234",
			"password": "password1234"
		},

		"@log_analytics_workspace_name": "log-lp-test-{env}",
		"public_access": true,
		"version": "12.0",
		"firewall_rules": [
			{
				"name": "UserA House",
				"ip_address": "8.8.8.8"
			}
		],
		"vnet_config": {
			"@vnet_name": "vnet-lp-test-{env}",
			"@subnet_name": "sqlsub"
		},

		"location": "northeurope",
		"external": false,
		"resource_group_name": "my-rg-name",
    "tags": { "example": "S0" }
		}
	}
}

SQLServer Reference

Key Type Description
name (required) string The name of the SQL Server (see how to name)
admin (required) Admin Definition The admin account configuration
keyvault (required) KeyVault Definition The Key Vault configuration
@log_analytics_workspace_name string The name of the log analytics workspace to bind to (defaults to no log integration)
public_access bool Whether the SQL Server has pulbic access enabled or not (defaults to false)
version string The SQL version to use (defaults 12.0)
firewall_rules array of optionalFirewall Rules The firewall rules to be added to the SQL Server
vnet_config Vnet configuration The configuration of the virtual network (Defaults to no vnet integration)
location string Resource Location (defaults to the resource group location)
external bool A reference to an existing SQL Server (defaults to false)
resource_group_name string The name of the resource group where the resource is located, only with external resources (defaults to the resource group of the deployment)
tags object Additional tags for the resource (defaults to no additional tags)

Admin Configuration

Key Type Description
username (required) string The Key Vault secret name that contains the desired admin username
password (required) string The Key Vault secret name that contains the desired admin password

Key Vault Configuration

Key Type Description
name (required) string The name of the Key Vault to bind to

FirewallRules

Key Type Description
name string The name of the firewall rule to be added
ip_address string The IP address to be added to the rule

VnetConfig

Key Type Description
@vnet_name string The name of the vnet to bind to
@subnet_name string The name of the subnet inside the vnet to use