Skip to content

Commit 8011b2c

Browse files
actions-useractions-user
committed
Update documentation
1 parent 3a3e2c5 commit 8011b2c

File tree

7 files changed

+67
-56
lines changed

7 files changed

+67
-56
lines changed

‎README.md‎

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

‎api-management/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ Basic usage of this module is as follows:
1616
resource_group_name =
1717
sku_name_part1 =
1818
sku_name_part2 =
19+
20+
# Optional variables
21+
application_name = ""
22+
environment = ""
23+
temporary = "TRUE"
1924
}
2025
```
2126

@@ -31,12 +36,15 @@ Basic usage of this module is as follows:
3136
| Name | Description | Type | Required |
3237
|------|-------------|------|:--------:|
3338
| <a name="input_api_management_name"></a> [api_management_name](#input_api_management_name) | Azure api management name | `string` | yes |
39+
| <a name="input_application_name"></a> [application_name](#input_application_name) | Azure application name tag | `string` | no |
40+
| <a name="input_environment"></a> [environment](#input_environment) | Environment tag value in Azure | `string` | no |
3441
| <a name="input_location"></a> [location](#input_location) | Azure storage account location | `string` | yes |
3542
| <a name="input_publisher_email"></a> [publisher_email](#input_publisher_email) | Email ID of API publishers | `list(string)` | yes |
3643
| <a name="input_publisher_name"></a> [publisher_name](#input_publisher_name) | Publisher of API | `list(string)` | yes |
3744
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure Storage Account Rg | `string` | yes |
3845
| <a name="input_sku_name_part1"></a> [sku_name_part1](#input_sku_name_part1) | SKU name of API management | `string` | yes |
3946
| <a name="input_sku_name_part2"></a> [sku_name_part2](#input_sku_name_part2) | Sku capacity part | `string` | yes |
47+
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |
4048

4149
## Outputs
4250

‎log-analytics-workspace/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Basic usage of this module is as follows:
1919
loganalytics_sku = "PerGB2018"
2020
loganalytics_workspace_name = ""
2121
resource_group_name = ""
22+
temporary = "TRUE"
2223
}
2324
```
2425

@@ -40,6 +41,7 @@ Basic usage of this module is as follows:
4041
| <a name="input_loganalytics_sku"></a> [loganalytics_sku](#input_loganalytics_sku) | Specifies the SKU of the Log Analytics Workspace | `string` | no |
4142
| <a name="input_loganalytics_workspace_name"></a> [loganalytics_workspace_name](#input_loganalytics_workspace_name) | Loganalytics workspace name | `string` | no |
4243
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure resource group name to create log analytics workspace | `string` | no |
44+
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |
4345

4446
## Outputs
4547

‎storage-account/README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
| Name | Version |
55
|------|---------|
66
| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | ~> 1.3 |
7-
| <a name="requirement_azurerm"></a> [azurerm](#requirement_azurerm) | ~> 3.0 |
7+
| <a name="requirement_azurerm"></a> [azurerm](#requirement_azurerm) | <= 4.0 |
88
| <a name="requirement_random"></a> [random](#requirement_random) | >= 3.1 |
99
## Usage
1010
Basic usage of this module is as follows:
@@ -26,6 +26,7 @@ Basic usage of this module is as follows:
2626
environment = "DEV"
2727
location = ""
2828
public_network_access_enabled = true
29+
temporary = "TRUE"
2930
}
3031
```
3132

@@ -51,6 +52,7 @@ Basic usage of this module is as follows:
5152
| <a name="input_public_network_access_enabled"></a> [public_network_access_enabled](#input_public_network_access_enabled) | Whether the public network access is enabled | `bool` | no |
5253
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure Storage Account Rg | `string` | yes |
5354
| <a name="input_storage_account_name"></a> [storage_account_name](#input_storage_account_name) | Azure Storage Account name | `string` | yes |
55+
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |
5456

5557
## Outputs
5658

‎user-assigned-managed-identity/README.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
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+
environment = "DEV"
17+
location = "centralindia"
18+
managed_identity_name = "test"
19+
resource_group_name = "testrg"
20+
temporary = "TRUE"
21+
}
22+
```
23+
24+
## Resources
25+
26+
| Name | Type |
27+
|------|------|
28+
| [azurerm_resource_group.rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
29+
| [azurerm_user_assigned_identity.managed_identity](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/user_assigned_identity) | resource |
30+
31+
## Inputs
32+
33+
| Name | Description | Type | Required |
34+
|------|-------------|------|:--------:|
35+
| <a name="input_application_name"></a> [application_name](#input_application_name) | Azure application name tag value | `string` | no |
36+
| <a name="input_environment"></a> [environment](#input_environment) | Environment tag value in Azure | `string` | no |
37+
| <a name="input_location"></a> [location](#input_location) | Azure location | `string` | no |
38+
| <a name="input_managed_identity_name"></a> [managed_identity_name](#input_managed_identity_name) | Name of user assigned managed identity in Azure | `string` | no |
39+
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure resource group name to create managed identity | `string` | no |
40+
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |
41+
42+
## Outputs
43+
44+
| Name | Description |
45+
|------|-------------|
46+
| <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 |
47+
| <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 |
48+
| <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 |
49+
| <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 |
50+
<!-- END_AUTOMATED_TF_DOCS_BLOCK -->

‎virtual-network/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Basic usage of this module is as follows:
1818
location = ""
1919
resource_group_name = ""
2020
subnet_cidrs = []
21+
temporary = "TRUE"
2122
vnet_address_space = []
2223
vnet_name = ""
2324
}
@@ -46,6 +47,7 @@ Basic usage of this module is as follows:
4647
| <a name="input_location"></a> [location](#input_location) | Azure location | `string` | no |
4748
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure Vnet resource group name | `string` | no |
4849
| <a name="input_subnet_cidrs"></a> [subnet_cidrs](#input_subnet_cidrs) | Azure Subnet Ip addresses | `list(string)` | no |
50+
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |
4951
| <a name="input_vnet_address_space"></a> [vnet_address_space](#input_vnet_address_space) | Azure VNET address space | `list(string)` | no |
5052
| <a name="input_vnet_name"></a> [vnet_name](#input_vnet_name) | Azure Vnet name | `string` | no |
5153

‎vmss-linux/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Basic usage of this module is as follows:
3232
resource_group_name = ""
3333
sku_size = ""
3434
subnet_name = ""
35+
temporary = "TRUE"
3536
vmss_name = ""
3637
vnet_name = ""
3738
vnet_resource_group = ""
@@ -76,6 +77,7 @@ Basic usage of this module is as follows:
7677
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure VMSS resource group name | `string` | no |
7778
| <a name="input_sku_size"></a> [sku_size](#input_sku_size) | Azure VMSS sku | `string` | no |
7879
| <a name="input_subnet_name"></a> [subnet_name](#input_subnet_name) | Azure subnet name to create vmss | `string` | no |
80+
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |
7981
| <a name="input_vmss_name"></a> [vmss_name](#input_vmss_name) | Azure VMSS name | `string` | no |
8082
| <a name="input_vnet_name"></a> [vnet_name](#input_vnet_name) | Azure Vnet Name | `string` | no |
8183
| <a name="input_vnet_resource_group"></a> [vnet_resource_group](#input_vnet_resource_group) | Azure Vnet resource group | `string` | no |

0 commit comments

Comments
 (0)