databases/mssql_managed_instance¶
Overview¶
This page documents the Terraform module implementation, key configuration surfaces, and how it integrates with CAF.
Dependency diagram (Mermaid)¶
graph TD
azapi_resource.sqlmi_admin_password["azapi_resource.sqlmi_admin_password"]
azurecaf_name.mssqlmi["azurecaf_name.mssqlmi"]
azurerm_key_vault_secret.sqlmi_admin_password["azurerm_key_vault_secret.sqlmi_admin_password"]
azurerm_resource_group_template_deployment.mssqlmi["azurerm_resource_group_template_deployment.mssqlmi"]
data.azapi_resource.mssqlmi["data.azapi_resource.mssqlmi"]
data.external.sqlmi_admin_password["data.external.sqlmi_admin_password"]
module.private_endpoint["module.private_endpoint"]
random_password.sqlmi_admin["random_password.sqlmi_admin"]
azapi_resource.sqlmi_admin_password --> azurecaf_name.mssqlmi
azapi_resource.sqlmi_admin_password --> random_password.sqlmi_admin
azurerm_key_vault_secret.sqlmi_admin_password --> azurecaf_name.mssqlmi
azurerm_key_vault_secret.sqlmi_admin_password --> random_password.sqlmi_admin
azurerm_resource_group_template_deployment.mssqlmi --> azurecaf_name.mssqlmi
data.azapi_resource.mssqlmi --> azurecaf_name.mssqlmi
data.azapi_resource.mssqlmi --> azurerm_resource_group_template_deployment.mssqlmi
data.external.sqlmi_admin_password --> azapi_resource.sqlmi_admin_password
data.external.sqlmi_admin_password --> azurecaf_name.mssqlmi
Module Reference¶
Category: databases
Path: modules/databases/mssql_managed_instance
Azure Resources: azapi_resource, azurecaf_name, azurerm_key_vault_secret, azurerm_resource_group_template_deployment, random_password
Inputs¶
| Name | Description | Type | Required | Default | Validation |
|---|---|---|---|---|---|
"global_settings" |
"Global settings object (see module README.md)" | any |
yes | - |
- |
"client_config" |
"Client configuration object (see module README.md)." | any |
yes | - |
- |
"settings" |
"The settings for the Azure resource." | any |
yes | - |
- |
"base_tags" |
"Base tags for the resource to be inherited from the resource group." | map(any) |
yes | - |
- |
"inherit_tags" |
"Base tags for the resource to be inherited from the resource group." | bool |
yes | - |
- |
"subnet_id" |
any |
yes | - |
- | |
"resource_group_name" |
"(Required) The name of the resource group where to create the resource." | string |
yes | - |
- |
"location" |
"(Required) Specifies the supported Azure location where to create the resource. Changing this forces a new resource ... | string |
yes | - |
- |
"primary_server_id" |
any |
no | "" |
- | |
"keyvault" |
any |
yes | - |
- | |
"vnets" |
any |
yes | - |
- | |
"resource_groups" |
any |
yes | - |
- | |
"private_endpoints" |
any |
yes | - |
- | |
"private_dns" |
any |
no | {} |
- |
Outputs¶
| Name | Description | Sensitive | Value |
|---|---|---|---|
"name" |
"SQL MI Name" | - | azurecaf_name.mssqlmi.result |
"id" |
"SQL MI Id" | - | local.output.id |
"location" |
- | var.location |
|
"principal_id" |
"SQL MI Identity Principal Id" | - | local.output.principal_id |
"resource_group_id" |
"Resource group resource id of the SQL Server managed instance." | - | local.parent_id |
Sources¶
modules/databases/mssql_managed_instance/locals.tfmodules/databases/mssql_managed_instance/locals_managed_instance.tfmodules/databases/mssql_managed_instance/main.tfmodules/databases/mssql_managed_instance/managed_instance.tfmodules/databases/mssql_managed_instance/outputs.tfmodules/databases/mssql_managed_instance/private_endpoints.tfmodules/databases/mssql_managed_instance/variables.tf