Skip to content

Commit 0a731d5

Browse files
committed
feat: updated README.md
1 parent f6a3568 commit 0a731d5

File tree

1 file changed

+52
-3
lines changed

1 file changed

+52
-3
lines changed

README.md

Lines changed: 52 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,61 @@
1-
****# Azure <> Terraform module
2-
Terraform module for creation Azure <>
1+
# Azure Microsoft SQL Database Server Terraform module
2+
Terraform module for creation Azure Microsoft SQL Database Server
33

44
## Usage
55

66
<!-- BEGIN_TF_DOCS -->
7+
## Requirements
78

9+
| Name | Version |
10+
| ------------------------------------------------------------------------- | --------- |
11+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
12+
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | >= 3.23.0 |
13+
14+
## Providers
15+
16+
| Name | Version |
17+
| ------------------------------------------------------------- | ------- |
18+
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | 3.24.0 |
19+
20+
## Modules
21+
22+
No modules.
23+
24+
## Resources
25+
26+
| Name | Type |
27+
| ----------------------------------------------------------------------------------------------------------------------------- | -------- |
28+
| [azurerm_mssql_database.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/mssql_database) | resource |
29+
30+
## Inputs
31+
32+
| Name | Description | Type | Default | Required |
33+
| --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ------------------ | ---------------------------- | :------: |
34+
| <a name="input_server_id"></a> [server\_id](#input\_server\_id) | Id of SQL server | `string` | n/a | yes |
35+
| <a name="input_server_fqdn"></a> [server\_fqdn](#input\_server\_fqdn) | FQDN of Azure SQL Server | `string` | n/a | yes |
36+
| <a name="input_tags"></a> [tags](#input\_tags) | tags for resources | `map(string)` | {} | no |
37+
| <a name="input_default_collation"></a> [default\_collation](#input\_default\_collation) | Specifies the collation of the database | `string` | SQL_Latin1_General_CP1_CI_AS | no |
38+
| <a name="input_default_sku"></a> [default\_sku](#input\_default\_sku) | Specifies the SKU of the database | `string` | GP_S_Gen5_1 | no |
39+
| <a name="input_default_max_size"></a> [default\_max_size](#input\_default\_max\_size) | The max size of the database in gigabytes | `string` | 20 | no |
40+
| <a name="input_default_min_capacity"></a> [default\_min\_capacity](#input\_default\_min\_capacity) | The min size of the database in gigabytes | `string` | 0.5 | no |
41+
| <a name="input_default_autopause_delay"></a> [default\_autopause\_delay](#input\_default\_autopause\_delay) | Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled | `string` | 60 | no |
42+
| <a name="input_default_retention_days"></a> [default\_retention\_days](#input\_default\_retention\_days) | Specifies the number of days to keep in the Threat Detection audit logs | `string` | 3 | no |
43+
| <a name="input_default_create_mode"></a> [default\_create\_mode](#input\_default\_create\_mode) | Type of create mode selected in database config object | `string` | Default | no |
44+
| <a name="input_default_creation_source_database_id"></a> [default\_creation\_source\_database\_id](#input\_default\_creation\_source\_database\_id) | This variable is used in case 'create_mode'='Copy' | `string` | null | no |
45+
| <a name="input_storage_account_type"></a> [storage\_account\_type](#input\_storage\_account\_type) | Specifies the storage account type used to store backups for this database | `string` | ZRS | no |
46+
| <a name="input_databases"></a> [databases](#input\_databases) | "Map of databases | `map(map(string))` | {} | no |
47+
48+
## Outputs
49+
50+
| Name | Description |
51+
| ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
52+
| <a name="output_mssql_database_secrets"></a> [mssql\_database\_secrets](#output\_mssql\_database\_secrets) | Map of Database Name to JDBC Connection String |
53+
| <a name="output_sql_server_id"></a> [sql\_server\_id](#output\_sql\_server\_id) | Id of SQL server |
54+
| <a name="output_sql_database_names"></a> [sql\_database\_names](#output\_sql\_database\_names) | Database name of the Azure SQL Database created |
55+
| <a name="output_sql_database_max_size"></a> [sql\_database\_max\_size](#output\_sql\_database\_max\_size) | Database max size in GB of the Azure SQL Database created |
56+
| <a name="output_storage_account_type"></a> [storage\_account\_type](#output\_storage\_account\_type) | Storage Account Type |
857
<!-- END_TF_DOCS -->
958

1059
## License
1160

12-
Apache 2 Licensed. For more information please see [LICENSE](https://github.com/data-platform-hq/terraform-azurerm-mssql-database/blob/add-module/LICENSE)
61+
Apache 2 Licensed. For more information please see [LICENSE](https://github.com/data-platform-hq/terraform-azurerm-mssql-database/blob/main/LICENSE)

0 commit comments

Comments
 (0)