Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Dec 17, 2024
1 parent 3a3e2c5 commit 8011b2c
Show file tree
Hide file tree
Showing 7 changed files with 67 additions and 56 deletions.
55 changes: 0 additions & 55 deletions README.md

This file was deleted.

8 changes: 8 additions & 0 deletions api-management/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ Basic usage of this module is as follows:
resource_group_name =
sku_name_part1 =
sku_name_part2 =
# Optional variables
application_name = ""
environment = ""
temporary = "TRUE"
}
```

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

## Outputs

Expand Down
2 changes: 2 additions & 0 deletions log-analytics-workspace/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Basic usage of this module is as follows:
loganalytics_sku = "PerGB2018"
loganalytics_workspace_name = ""
resource_group_name = ""
temporary = "TRUE"
}
```

Expand All @@ -40,6 +41,7 @@ Basic usage of this module is as follows:
| <a name="input_loganalytics_sku"></a> [loganalytics_sku](#input_loganalytics_sku) | Specifies the SKU of the Log Analytics Workspace | `string` | no |
| <a name="input_loganalytics_workspace_name"></a> [loganalytics_workspace_name](#input_loganalytics_workspace_name) | Loganalytics workspace name | `string` | no |
| <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 |
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |

## Outputs

Expand Down
4 changes: 3 additions & 1 deletion storage-account/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | ~> 1.3 |
| <a name="requirement_azurerm"></a> [azurerm](#requirement_azurerm) | ~> 3.0 |
| <a name="requirement_azurerm"></a> [azurerm](#requirement_azurerm) | <= 4.0 |
| <a name="requirement_random"></a> [random](#requirement_random) | >= 3.1 |
## Usage
Basic usage of this module is as follows:
Expand All @@ -26,6 +26,7 @@ Basic usage of this module is as follows:
environment = "DEV"
location = ""
public_network_access_enabled = true
temporary = "TRUE"
}
```

Expand All @@ -51,6 +52,7 @@ Basic usage of this module is as follows:
| <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 |
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure Storage Account Rg | `string` | yes |
| <a name="input_storage_account_name"></a> [storage_account_name](#input_storage_account_name) | Azure Storage Account name | `string` | yes |
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |

## Outputs

Expand Down
50 changes: 50 additions & 0 deletions user-assigned-managed-identity/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<!-- BEGIN_AUTOMATED_TF_DOCS_BLOCK -->
## Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | ~> 1.3 |
| <a name="requirement_azurerm"></a> [azurerm](#requirement_azurerm) | <= 4.0 |
## Usage
Basic usage of this module is as follows:
```hcl
module "example" {
source = "<module-path>"
# Optional variables
application_name = "devwithkrishna"
environment = "DEV"
location = "centralindia"
managed_identity_name = "test"
resource_group_name = "testrg"
temporary = "TRUE"
}
```

## Resources

| Name | Type |
|------|------|
| [azurerm_resource_group.rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
| [azurerm_user_assigned_identity.managed_identity](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/user_assigned_identity) | resource |

## Inputs

| Name | Description | Type | Required |
|------|-------------|------|:--------:|
| <a name="input_application_name"></a> [application_name](#input_application_name) | Azure application name tag value | `string` | no |
| <a name="input_environment"></a> [environment](#input_environment) | Environment tag value in Azure | `string` | no |
| <a name="input_location"></a> [location](#input_location) | Azure location | `string` | no |
| <a name="input_managed_identity_name"></a> [managed_identity_name](#input_managed_identity_name) | Name of user assigned managed identity in Azure | `string` | no |
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure resource group name to create managed identity | `string` | no |
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |

## Outputs

| Name | Description |
|------|-------------|
| <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 |
| <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 |
| <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 |
| <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 |
<!-- END_AUTOMATED_TF_DOCS_BLOCK -->
2 changes: 2 additions & 0 deletions virtual-network/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Basic usage of this module is as follows:
location = ""
resource_group_name = ""
subnet_cidrs = []
temporary = "TRUE"
vnet_address_space = []
vnet_name = ""
}
Expand Down Expand Up @@ -46,6 +47,7 @@ Basic usage of this module is as follows:
| <a name="input_location"></a> [location](#input_location) | Azure location | `string` | no |
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure Vnet resource group name | `string` | no |
| <a name="input_subnet_cidrs"></a> [subnet_cidrs](#input_subnet_cidrs) | Azure Subnet Ip addresses | `list(string)` | no |
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |
| <a name="input_vnet_address_space"></a> [vnet_address_space](#input_vnet_address_space) | Azure VNET address space | `list(string)` | no |
| <a name="input_vnet_name"></a> [vnet_name](#input_vnet_name) | Azure Vnet name | `string` | no |

Expand Down
2 changes: 2 additions & 0 deletions vmss-linux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Basic usage of this module is as follows:
resource_group_name = ""
sku_size = ""
subnet_name = ""
temporary = "TRUE"
vmss_name = ""
vnet_name = ""
vnet_resource_group = ""
Expand Down Expand Up @@ -76,6 +77,7 @@ Basic usage of this module is as follows:
| <a name="input_resource_group_name"></a> [resource_group_name](#input_resource_group_name) | Azure VMSS resource group name | `string` | no |
| <a name="input_sku_size"></a> [sku_size](#input_sku_size) | Azure VMSS sku | `string` | no |
| <a name="input_subnet_name"></a> [subnet_name](#input_subnet_name) | Azure subnet name to create vmss | `string` | no |
| <a name="input_temporary"></a> [temporary](#input_temporary) | Temporary tag value in Azure | `string` | no |
| <a name="input_vmss_name"></a> [vmss_name](#input_vmss_name) | Azure VMSS name | `string` | no |
| <a name="input_vnet_name"></a> [vnet_name](#input_vnet_name) | Azure Vnet Name | `string` | no |
| <a name="input_vnet_resource_group"></a> [vnet_resource_group](#input_vnet_resource_group) | Azure Vnet resource group | `string` | no |
Expand Down

0 comments on commit 8011b2c

Please sign in to comment.