Skip to content

Commit 6b045e4

Browse files
committed
Update documentation
1 parent 796c6f9 commit 6b045e4

File tree

2 files changed

+53
-125
lines changed

2 files changed

+53
-125
lines changed

README.md

Lines changed: 0 additions & 125 deletions
This file was deleted.
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
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+
## Usage
9+
Basic usage of this module is as follows:
10+
```hcl
11+
module "example" {
12+
source = "<module-path>"
13+
14+
# Optional variables
15+
application_name = "devwithkrishna"
16+
create_in_existing_resource_group = false
17+
environment = "DEV"
18+
location = ""
19+
managed_identity_name = ""
20+
resource_group_name = ""
21+
temporary = "TRUE"
22+
}
23+
```
24+
25+
## Resources
26+
27+
| Name | Type |
28+
|------|------|
29+
| [azurerm_resource_group.rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
30+
| [azurerm_user_assigned_identity.managed_identity](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/user_assigned_identity) | resource |
31+
| [azurerm_resource_group.existing](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group) | data source |
32+
33+
## Inputs
34+
35+
| Name | Description | Type | Required |
36+
|------|-------------|------|:--------:|
37+
| <a name="input_application_name"></a> [application_name](#input_application_name) | Azure application name tag value | `string` | no |
38+
| <a name="input_create_in_existing_resource_group"></a> [create_in_existing_resource_group](#input_create_in_existing_resource_group) | Create managed identity in existing resource group | `bool` | no |
39+
| <a name="input_environment"></a> [environment](#input_environment) | Environment tag value in Azure | `string` | no |
40+
| <a name="input_location"></a> [location](#input_location) | Azure location | `string` | no |
41+
| <a name="input_managed_identity_name"></a> [managed_identity_name](#input_managed_identity_name) | Name of user assigned managed identity in Azure | `string` | no |
42+
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure resource group name to create managed identity | `string` | no |
43+
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |
44+
45+
## Outputs
46+
47+
| Name | Description |
48+
|------|-------------|
49+
| <a name="output_client_id_of_user_assigned_managed_identity"></a> [client_id_of_user_assigned_managed_identity](#output_client_id_of_user_assigned_managed_identity) | Id of the service principal associated to the Identity |
50+
| <a name="output_id_of_user_assigned_managed_identity"></a> [id_of_user_assigned_managed_identity](#output_id_of_user_assigned_managed_identity) | Id of the user assigned managed identity |
51+
| <a name="output_principal_id_of_user_assigned_managed_identity"></a> [principal_id_of_user_assigned_managed_identity](#output_principal_id_of_user_assigned_managed_identity) | Id of the service principal associated with the managed identity |
52+
| <a name="output_tenanat_id_of_user_assigned_managed_identity"></a> [tenanat_id_of_user_assigned_managed_identity](#output_tenanat_id_of_user_assigned_managed_identity) | Id of the tenant in which managed identity is created |
53+
<!-- END_AUTOMATED_TF_DOCS_BLOCK -->

0 commit comments

Comments
 (0)