README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#


# Name of this project
name: Terraform AZURE MSSQL-DB

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-azure-mssql-db

# Badges to display
badges:
  - name: "Terraform"
    image: "https://img.shields.io/badge/Terraform-v1.1.7-green"
    url: "https://www.terraform.io"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"

#  description of this project
description: |-
  Terraform module to create mssql-db resource on AZURE.

# extra content
include:
  - "terraform.md"

# How to use this project
# yamllint disable rule:line-length
usage: |-
  ### Simple Example
  Here is an example of how you can use this module in your inventory structure:
  ```hcl
  module "mssql-server" {
   source                          = "clouddrove/mssql-db/azure"
   name                            = "app"
   environment                     = "test"
   label_order                     = ["environment", "name"]
   create_resource_group           = false
   resource_group_name             = module.resource_group.resource_group_name
   location                        = module.resource_group.resource_group_location
   sqlserver_name                  = "mssqldbserver"
   database_name                   = "demomssqldb"
   sql_database_edition            = "Standard"
   sqldb_service_objective_name    = "S1"
   sql_server_version              = "12.0"
   enable_threat_detection_policy  = true
   enable_private_endpoint         = true
   virtual_network_name            = module.vnet.vnet_name[0]
   private_subnet_address_prefix   = ["10.0.3.0/24"]
   }
    ```