docs(azure-customrole): update docs and added examples

modules/azure-customrole/.terraform-docs.yml

@@ -0,0 +1,48 @@
+formatter: "markdown" # this is required
+
+version: ""
+
+header-from: docs/header.md
+footer-from: docs/footer.md
+
+recursive:
+  enabled: false
+  path: modules
+  include-main: true
+
+sections:
+  hide: []
+  show: []
+
+content: ""
+
+output:
+  file: "README.md"
+  mode: inject
+  template: |-
+    <!-- BEGIN_TF_DOCS -->
+    {{ .Content }}
+    <!-- END_TF_DOCS -->
+
+output-values:
+  enabled: false
+  from: ""
+
+sort:
+  enabled: true
+  by: name
+
+settings:
+  anchor: true
+  color: true
+  default: true
+  description: false
+  escape: true
+  hide-empty: false
+  html: true
+  indent: 2
+  lockfile: true
+  read-comments: true
+  required: true
+  sensitive: true
+  type: true

modules/azure-customrole/README.md

@@ -1,66 +1,86 @@
+<!-- BEGIN_TF_DOCS -->
+# Azure Custom Role Terraform Module
+
+## Overview
+
+This Terraform module allows you to create a custom role in Azure, specifying actions, data actions, and the assignable scopes.
+
+## Main features
+- Create custom roles in Azure.
+- Flexible definition of actions, data actions, not actions, and not data actions.
+- Support for multiple assignable scopes.
+
+## Ejemplo completo
+
+Puedes encontrar un ejemplo completo en [`_examples/basic/values.yaml`](../\_examples/basic/values.yaml).
+
+## File structure
+
+```
+.
+├── main.tf
+├── variables.tf
+├── outputs.tf
+├── versions.tf
+├── README.md
+├── CHANGELOG.md
+└── docs/
+    ├── header.md
+    └── footer.md
+```
+
 ## Requirements
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.7.5 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.7.0 |
+| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | ~> 4.16.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | ~= 4.16.0 |
+| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | ~> 4.16.0 |
+
+## Modules
+
+No modules.
 
 ## Resources
 
 | Name | Type |
 |------|------|
-| [azurerm_role_definition](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_definition) | source |
+| [azurerm_role_definition.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_definition) | resource |
 
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| name | The name of the Role Definition | `string` | n/a | yes |
-| assignable_scopes | One or more assignable scopes for this Role Definition. The first one will become de scope at which the Role Definition applies to. | `list(string)` | n/a | yes |
-| permissions | A permissions block with possible 'actions', 'data_actions', 'not_actions' and/or 'not_data_actions'. | <pre>object({<br> actions = list(string) (optional)<br> data_actions = list(string) (optional)<br> not_actions = list(string) (optional)<br> not_data_actions = list(string) (optional)<br>})</pre> | n/a | yes |
+| <a name="input_assignable_scopes"></a> [assignable\_scopes](#input\_assignable\_scopes) | One or more assignable scopes for this Role Definition. The first one will become de scope at which the Role Definition applies to. | `list(string)` | n/a | yes |
+| <a name="input_name"></a> [name](#input\_name) | The name of the Role Definition | `string` | n/a | yes |
+| <a name="input_permissions"></a> [permissions](#input\_permissions) | A permissions block with possible 'actions', 'data\_actions', 'not\_actions' and/or 'not\_data\_actions'. | <pre>object({<br/>    actions          = optional(list(string), [])<br/>    data_actions     = optional(list(string), [])<br/>    not_actions      = optional(list(string), [])<br/>    not_data_actions = optional(list(string), [])<br/>  })</pre> | n/a | yes |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| <a name="output_role_definition_id"></a> [role_definition_id](#output\_role\_definition\_id"></a>) | The ID of the Role Definition. |
-
-## Example
-
-### HCL
-```hcl
-{
-    name: "Custom Role"
-    assignable_scopes: ["yyy", "zzz"]
-    permissions: {
-        actions = [
-            "Microsoft.Compute/disks/read",
-            "Microsoft.Compute/disks/write",
-        ]    
-        not_actions = [
-            "Microsoft.Compute/disks/read",
-            "Microsoft.Compute/disks/write",
-        ]    
-    }
-}
-```
+| <a name="output_id"></a> [id](#output\_id) | # OUTPUTS SECTION Role Definition Id |
 
-### Yaml
-```yaml
-name: "Custom Role"
-assignable_scopes: 
-  - "yyy"
-  - "zzz"
-permissions:
-  actions:
-    - "Microsoft.Compute/disks/read"
-    - "Microsoft.Compute/disks/write"
-  notActions:
-    - "Microsoft.Authorization/*/Delete"
-    - "Microsoft.Authorization/*/Write"
-```
+---
+
+## Examples
+
+For detailed examples, refer to the [module examples](https://github.com/prefapp/tfm/tree/main/modules/azure-customrole/_examples):
+
+- [basic](https://github.com/prefapp/tfm/tree/main/modules/azure-customrole/_examples/basic) - Basic custom role definition with assignable scopes and permissions.
+
+## Additional resources
+
+- [Azure Custom Roles](https://learn.microsoft.com/en-us/azure/role-based-access-control/custom-roles)
+- [Terraform AzureRM Provider - azurerm\_role\_definition](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_definition)
+- [Official Terraform documentation](https://www.terraform.io/docs)
+
+## Support
+
+For issues, questions, or contributions related to this module, please visit the [repository's issue tracker](https://github.com/prefapp/tfm/issues).
+<!-- END_TF_DOCS -->

modules/azure-customrole/_examples/basic/main.tf

@@ -0,0 +1,6 @@
+module "custom_role" {
+  source = "../../"
+  name   = var.name
+  assignable_scopes = var.assignable_scopes
+  permissions = var.permissions
+}

modules/azure-customrole/_examples/basic/values.yaml

@@ -0,0 +1,11 @@
+name: "Custom Role"
+assignable_scopes:
+  - "/subscriptions/xxx"
+  - "/subscriptions/yyy"
+permissions:
+  actions:
+    - "Microsoft.Compute/disks/read"
+    - "Microsoft.Compute/disks/write"
+  notActions:
+    - "Microsoft.Authorization/*/Delete"
+    - "Microsoft.Authorization/*/Write"

modules/azure-customrole/docs/footer.md

@@ -0,0 +1,17 @@
+---
+
+## Examples
+
+For detailed examples, refer to the [module examples](https://github.com/prefapp/tfm/tree/main/modules/azure-customrole/_examples):
+
+- [basic](https://github.com/prefapp/tfm/tree/main/modules/azure-customrole/_examples/basic) - Basic custom role definition with assignable scopes and permissions.
+
+## Additional resources
+
+- [Azure Custom Roles](https://learn.microsoft.com/en-us/azure/role-based-access-control/custom-roles)
+- [Terraform AzureRM Provider - azurerm_role_definition](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_definition)
+- [Official Terraform documentation](https://www.terraform.io/docs)
+
+## Support
+
+For issues, questions, or contributions related to this module, please visit the [repository's issue tracker](https://github.com/prefapp/tfm/issues).

modules/azure-customrole/docs/header.md

@@ -0,0 +1,29 @@
+# Azure Custom Role Terraform Module
+
+## Overview
+
+This Terraform module allows you to create a custom role in Azure, specifying actions, data actions, and the assignable scopes.
+
+## Main features
+- Create custom roles in Azure.
+- Flexible definition of actions, data actions, not actions, and not data actions.
+- Support for multiple assignable scopes.
+
+## Ejemplo completo
+
+Puedes encontrar un ejemplo completo en [`_examples/basic/values.yaml`](../_examples/basic/values.yaml).
+
+## File structure
+
+```
+.
+├── main.tf
+├── variables.tf
+├── outputs.tf
+├── versions.tf
+├── README.md
+├── CHANGELOG.md
+└── docs/
+    ├── header.md
+    └── footer.md
+```