Skip to content

Commit 8291b82

Browse files
actions-useractions-user
committed
Update documentation
1 parent 8654c73 commit 8291b82

File tree

2 files changed

+86
-103
lines changed

2 files changed

+86
-103
lines changed

‎README.md‎

Lines changed: 0 additions & 103 deletions
This file was deleted.

‎keyvault-with-private-endpoint/README.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
<!-- BEGIN_AUTOMATED_TF_DOCS_BLOCK -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | ~> 1.3 |
7+
| <a name="requirement_azurerm"></a> [azurerm](#requirement_azurerm) | <= 4.0 |
8+
| <a name="requirement_random"></a> [random](#requirement_random) | >= 3.1 |
9+
## Usage
10+
Basic usage of this module is as follows:
11+
```hcl
12+
module "example" {
13+
source = "<module-path>"
14+
15+
# Required variables
16+
keyvault_name =
17+
resource_group_name =
18+
19+
# Optional variables
20+
application_name = "devwithkrishna"
21+
azure_disk_encryption_can_retrieve_secrets = false
22+
azure_resource_manager_can_retrieve_secrets = false
23+
azure_vms_can_access_certs_stored_as_secrets = false
24+
enable_rbac_authorization = false
25+
environment = "DEV"
26+
location = ""
27+
public_network_access_enabled = true
28+
purge_protection_enabled = false
29+
sku_name = "standard"
30+
soft_delete_retention_days = 90
31+
subnet_name = ""
32+
temporary = "TRUE"
33+
virtual_network_name = ""
34+
virtual_network_rg = "value"
35+
}
36+
```
37+
38+
## Resources
39+
40+
| Name | Type |
41+
|------|------|
42+
| [azurerm_key_vault.kv](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/key_vault) | resource |
43+
| [azurerm_private_endpoint.pvt_end_pt](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/private_endpoint) | resource |
44+
| [azurerm_resource_group.keyvault_rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
45+
| [azurerm_client_config.current](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config) | data source |
46+
| [azurerm_private_dns_zone.key_vault_dns_zone](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/private_dns_zone) | data source |
47+
| [azurerm_subnet.pvt_end_pt](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/subnet) | data source |
48+
49+
## Inputs
50+
51+
| Name | Description | Type | Required |
52+
|------|-------------|------|:--------:|
53+
| <a name="input_application_name"></a> [application_name](#input_application_name) | Azure application name tag | `string` | no |
54+
| <a name="input_azure_disk_encryption_can_retrieve_secrets"></a> [azure_disk_encryption_can_retrieve_secrets](#input_azure_disk_encryption_can_retrieve_secrets) | Boolean flag to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys | `bool` | no |
55+
| <a name="input_azure_resource_manager_can_retrieve_secrets"></a> [azure_resource_manager_can_retrieve_secrets](#input_azure_resource_manager_can_retrieve_secrets) | Boolean flag to specify whether Azure Resource Manager is permitted to retrieve secrets from the vault | `bool` | no |
56+
| <a name="input_azure_vms_can_access_certs_stored_as_secrets"></a> [azure_vms_can_access_certs_stored_as_secrets](#input_azure_vms_can_access_certs_stored_as_secrets) | Boolean flag to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault | `bool` | no |
57+
| <a name="input_enable_rbac_authorization"></a> [enable_rbac_authorization](#input_enable_rbac_authorization) | Boolean flag to specify whether Azure Key Vault uses Role Based Access Control (RBAC) for authorization of data actions | `bool` | no |
58+
| <a name="input_environment"></a> [environment](#input_environment) | Environment tag value in Azure | `string` | no |
59+
| <a name="input_keyvault_name"></a> [keyvault_name](#input_keyvault_name) | Azure keyvault name | `string` | yes |
60+
| <a name="input_location"></a> [location](#input_location) | Azure keyvault location | `string` | no |
61+
| <a name="input_public_network_access_enabled"></a> [public_network_access_enabled](#input_public_network_access_enabled) | Whether public network access is allowed for this Key Vault | `bool` | no |
62+
| <a name="input_purge_protection_enabled"></a> [purge_protection_enabled](#input_purge_protection_enabled) | Purge Protection enabled or not | `bool` | no |
63+
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure keyvault Rg | `string` | yes |
64+
| <a name="input_sku_name"></a> [sku_name](#input_sku_name) | Keyvault SKUs available in azure. Valid options are standard and premium | `string` | no |
65+
| <a name="input_soft_delete_retention_days"></a> [soft_delete_retention_days](#input_soft_delete_retention_days) | The number of days that items should be retained for once soft-deleted. This value can be between 7 and 90 | `number` | no |
66+
| <a name="input_subnet_name"></a> [subnet_name](#input_subnet_name) | Name of the subnet in which private endpoint will be created | `string` | no |
67+
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |
68+
| <a name="input_virtual_network_name"></a> [virtual_network_name](#input_virtual_network_name) | Name of the virtual network in which private endpoint will be created | `string` | no |
69+
| <a name="input_virtual_network_rg"></a> [virtual_network_rg](#input_virtual_network_rg) | Virtual network resource group | `string` | no |
70+
71+
## Outputs
72+
73+
| Name | Description |
74+
|------|-------------|
75+
| <a name="output_azurerm_resource_group"></a> [azurerm_resource_group](#output_azurerm_resource_group) | Azure resource group name |
76+
| <a name="output_enable_rbac_authorization"></a> [enable_rbac_authorization](#output_enable_rbac_authorization) | Azure kv RBAC access enabled or not |
77+
| <a name="output_enabled_for_deployment"></a> [enabled_for_deployment](#output_enabled_for_deployment) | Azure vms can access certs from kv |
78+
| <a name="output_enabled_for_disk_encryption"></a> [enabled_for_disk_encryption](#output_enabled_for_disk_encryption) | Azure disk encryption can access keys from keyvault or not |
79+
| <a name="output_enabled_for_template_deployment"></a> [enabled_for_template_deployment](#output_enabled_for_template_deployment) | Azure resource manager can access secrets or not |
80+
| <a name="output_keyvault_id"></a> [keyvault_id](#output_keyvault_id) | value of keyvault id |
81+
| <a name="output_keyvault_location"></a> [keyvault_location](#output_keyvault_location) | Azure keyvault location |
82+
| <a name="output_keyvault_name"></a> [keyvault_name](#output_keyvault_name) | Azure keyvault name |
83+
| <a name="output_keyvault_sku"></a> [keyvault_sku](#output_keyvault_sku) | Azure Keyvault SKu |
84+
| <a name="output_privat_enedpoint_ipaddress"></a> [privat_enedpoint_ipaddress](#output_privat_enedpoint_ipaddress) | Azure kv private endpoint address |
85+
| <a name="output_public_access_enabled"></a> [public_access_enabled](#output_public_access_enabled) | Azure kv enabled public access or not |
86+
<!-- END_AUTOMATED_TF_DOCS_BLOCK -->

0 commit comments

Comments
 (0)