Skip to content

Commit 4693925

Browse files
committed
update readme
1 parent f63ec8c commit 4693925

File tree

1 file changed

+35
-36
lines changed
  • infra/modules/azure_app_configuration

1 file changed

+35
-36
lines changed

infra/modules/azure_app_configuration/README.md

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -29,54 +29,53 @@ The allowed sizes are:
2929
For examples of how to use this module, refer to the [examples](https://github.com/pagopa-dx/terraform-azurerm-azure-app-configuration/tree/main/examples) folder in the module repository.
3030

3131
<!-- BEGIN_TF_DOCS -->
32-
3332
## Requirements
3433

35-
| Name | Version |
36-
| ------------------------------------------------------------------------ | ------- |
37-
| <a name="requirement_azurerm"></a> [azurerm](#requirement_azurerm) | ~> 4.0 |
38-
| <a name="requirement_pagopa-dx"></a> [pagopa-dx](#requirement_pagopa-dx) | ~> 0.8 |
34+
| Name | Version |
35+
|------|---------|
36+
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | ~> 4.0 |
37+
| <a name="requirement_pagopa-dx"></a> [pagopa-dx](#requirement\_pagopa-dx) | ~> 0.8 |
3938

4039
## Modules
4140

42-
| Name | Source | Version |
43-
| ----------------------------------------------------------------------------------------------- | ---------------------------------------- | ------- |
44-
| <a name="module_app_roles"></a> [app_roles](#module_app_roles) | pagopa-dx/azure-role-assignments/azurerm | ~> 1.3 |
45-
| <a name="module_appconfig_team_roles"></a> [appconfig_team_roles](#module_appconfig_team_roles) | pagopa-dx/azure-role-assignments/azurerm | ~> 1.3 |
41+
| Name | Source | Version |
42+
|------|--------|---------|
43+
| <a name="module_app_roles"></a> [app\_roles](#module\_app\_roles) | pagopa-dx/azure-role-assignments/azurerm | ~> 1.3 |
44+
| <a name="module_appconfig_team_roles"></a> [appconfig\_team\_roles](#module\_appconfig\_team\_roles) | pagopa-dx/azure-role-assignments/azurerm | ~> 1.3 |
4645

4746
## Resources
4847

49-
| Name | Type |
50-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
51-
| [azurerm_app_configuration.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/app_configuration) | resource |
52-
| [azurerm_monitor_diagnostic_setting.app_configuration](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/monitor_diagnostic_setting) | resource |
53-
| [azurerm_private_endpoint.app_config](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/private_endpoint) | resource |
54-
| [azurerm_private_dns_zone.appconfig](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/private_dns_zone) | data source |
48+
| Name | Type |
49+
|------|------|
50+
| [azurerm_app_configuration.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/app_configuration) | resource |
51+
| [azurerm_monitor_diagnostic_setting.app_configuration](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/monitor_diagnostic_setting) | resource |
52+
| [azurerm_private_endpoint.app_config](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/private_endpoint) | resource |
53+
| [azurerm_private_dns_zone.appconfig](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/private_dns_zone) | data source |
5554

5655
## Inputs
5756

58-
| Name | Description | Type | Default | Required |
59-
| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | :------: |
60-
| <a name="input_authorized_teams"></a> [authorized_teams](#input_authorized_teams) | Object containing lists of principal IDs (Azure AD object IDs) of product teams to be granted read or write permissions on the App Configuration. These represent the teams within the organization that need access to this resource." | <pre>object({<br/> writers = optional(list(string), []),<br/> readers = optional(list(string), [])<br/> })</pre> | <pre>{<br/> "readers": [],<br/> "writers": []<br/>}</pre> | no |
61-
| <a name="input_environment"></a> [environment](#input_environment) | Values which are used to generate resource names and location short names. They are all mandatory except for domain, which should not be used only in the case of a resource used by multiple domains. | <pre>object({<br/> prefix = string<br/> env_short = string<br/> location = string<br/> domain = optional(string)<br/> app_name = string<br/> instance_number = string<br/> })</pre> | n/a | yes |
62-
| <a name="input_key_vaults"></a> [key_vaults](#input_key_vaults) | Optionally, integrate App Configuration with a one or more existing Key Vault for secrets retrieval.<br/> Set `has_rbac_support` to true if the referenced Key Vault uses RBAC model for access control.<br/> Use `app_principal_ids` to set application principal IDs to be granted access to the Key Vault. | <pre>list(object({<br/> name = string<br/> resource_group_name = string<br/> has_rbac_support = bool<br/> app_principal_ids = list(string)<br/> }))</pre> | `null` | no |
63-
| <a name="input_private_dns_zone_resource_group_name"></a> [private_dns_zone_resource_group_name](#input_private_dns_zone_resource_group_name) | Name of the resource group containing the private DNS zone for private endpoints. Default is the resource group of the virtual network. | `string` | `null` | no |
64-
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | The name of the resource group where resources will be deployed. | `string` | n/a | yes |
65-
| <a name="input_size"></a> [size](#input_size) | "App Configuration SKU. Allowed values: 'standard', 'premium'. If not set, it will be determined by the use_case." | `string` | `null` | no |
66-
| <a name="input_subnet_pep_id"></a> [subnet_pep_id](#input_subnet_pep_id) | ID of the subnet hosting private endpoints. | `string` | n/a | yes |
67-
| <a name="input_subscription_id"></a> [subscription_id](#input_subscription_id) | Subscription Id of the involved resources | `string` | n/a | yes |
68-
| <a name="input_tags"></a> [tags](#input_tags) | A map of tags to assign to the resources. | `map(any)` | n/a | yes |
69-
| <a name="input_use_case"></a> [use_case](#input_use_case) | Allowed values: 'default', 'development'. | `string` | `"default"` | no |
70-
| <a name="input_virtual_network"></a> [virtual_network](#input_virtual_network) | Virtual network where the subnet will be created. | <pre>object({<br/> name = string<br/> resource_group_name = string<br/> })</pre> | n/a | yes |
57+
| Name | Description | Type | Default | Required |
58+
|------|-------------|------|---------|:--------:|
59+
| <a name="input_authorized_teams"></a> [authorized\_teams](#input\_authorized\_teams) | Object containing lists of principal IDs (Azure AD object IDs) of product teams to be granted read or write permissions on the App Configuration. These represent the teams within the organization that need access to this resource." | <pre>object({<br/> writers = optional(list(string), []),<br/> readers = optional(list(string), [])<br/> })</pre> | <pre>{<br/> "readers": [],<br/> "writers": []<br/>}</pre> | no |
60+
| <a name="input_diagnostic_settings"></a> [diagnostic\_settings](#input\_diagnostic\_settings) | Diagnostic settings for App Configuration logs and metrics. When enabled, sends diagnostics to Log Analytics workspace and/or Storage Account. | <pre>object({<br/> enabled = bool<br/> log_analytics_workspace_id = optional(string, null)<br/> storage_account_id = optional(string, null)<br/> })</pre> | <pre>{<br/> "enabled": false,<br/> "log_analytics_workspace_id": null<br/>}</pre> | no |
61+
| <a name="input_environment"></a> [environment](#input\_environment) | Values which are used to generate resource names and location short names. They are all mandatory except for domain, which should not be used only in the case of a resource used by multiple domains. | <pre>object({<br/> prefix = string<br/> env_short = string<br/> location = string<br/> domain = optional(string)<br/> app_name = string<br/> instance_number = string<br/> })</pre> | n/a | yes |
62+
| <a name="input_key_vaults"></a> [key\_vaults](#input\_key\_vaults) | Optionally, integrate App Configuration with a one or more existing Key Vault for secrets retrieval.<br/> Set `has_rbac_support` to true if the referenced Key Vault uses RBAC model for access control.<br/> Use `app_principal_ids` to set application principal IDs to be granted access to the Key Vault. | <pre>list(object({<br/> name = string<br/> resource_group_name = string<br/> has_rbac_support = bool<br/> app_principal_ids = list(string)<br/> }))</pre> | `null` | no |
63+
| <a name="input_private_dns_zone_resource_group_name"></a> [private\_dns\_zone\_resource\_group\_name](#input\_private\_dns\_zone\_resource\_group\_name) | Name of the resource group containing the private DNS zone for private endpoints. Default is the resource group of the virtual network. | `string` | `null` | no |
64+
| <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) | The name of the resource group where resources will be deployed. | `string` | n/a | yes |
65+
| <a name="input_size"></a> [size](#input\_size) | "App Configuration SKU. Allowed values: 'standard', 'premium'. If not set, it will be determined by the use\_case." | `string` | `null` | no |
66+
| <a name="input_subnet_pep_id"></a> [subnet\_pep\_id](#input\_subnet\_pep\_id) | ID of the subnet hosting private endpoints. | `string` | n/a | yes |
67+
| <a name="input_subscription_id"></a> [subscription\_id](#input\_subscription\_id) | Subscription Id of the involved resources | `string` | n/a | yes |
68+
| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to assign to the resources. | `map(any)` | n/a | yes |
69+
| <a name="input_use_case"></a> [use\_case](#input\_use\_case) | Allowed values: 'default', 'development'. | `string` | `"default"` | no |
70+
| <a name="input_virtual_network"></a> [virtual\_network](#input\_virtual\_network) | Virtual network where the subnet will be created. | <pre>object({<br/> name = string<br/> resource_group_name = string<br/> })</pre> | n/a | yes |
7171

7272
## Outputs
7373

74-
| Name | Description |
75-
| -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
76-
| <a name="output_endpoint"></a> [endpoint](#output_endpoint) | The service endpoint URL |
77-
| <a name="output_id"></a> [id](#output_id) | The ID of the Azure Cosmos DB account. |
78-
| <a name="output_name"></a> [name](#output_name) | The name of the Azure Cosmos DB account. |
79-
| <a name="output_principal_id"></a> [principal_id](#output_principal_id) | The system-assigned managed identity pricipal id |
80-
| <a name="output_resource_group_name"></a> [resource_group_name](#output_resource_group_name) | The name of the resource group containing the Azure Cosmos DB account. |
81-
74+
| Name | Description |
75+
|------|-------------|
76+
| <a name="output_endpoint"></a> [endpoint](#output\_endpoint) | The service endpoint URL |
77+
| <a name="output_id"></a> [id](#output\_id) | The ID of the Azure Cosmos DB account. |
78+
| <a name="output_name"></a> [name](#output\_name) | The name of the Azure Cosmos DB account. |
79+
| <a name="output_principal_id"></a> [principal\_id](#output\_principal\_id) | The system-assigned managed identity pricipal id |
80+
| <a name="output_resource_group_name"></a> [resource\_group\_name](#output\_resource\_group\_name) | The name of the resource group containing the Azure Cosmos DB account. |
8281
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)