{"id":19129449,"url":"https://github.com/launchbynttdata/tf-azurerm-module_reference-key_vault","last_synced_at":"2026-04-17T06:32:23.944Z","repository":{"id":237970212,"uuid":"795598834","full_name":"launchbynttdata/tf-azurerm-module_reference-key_vault","owner":"launchbynttdata","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-30T14:00:26.000Z","size":81,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-30T16:04:33.423Z","etag":null,"topics":["azure","infrastructure-as-code","platform-automation","reference","terraform"],"latest_commit_sha":null,"homepage":"","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/launchbynttdata.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-05-03T16:14:51.000Z","updated_at":"2026-02-26T17:39:25.000Z","dependencies_parsed_at":"2024-05-08T22:25:33.997Z","dependency_job_id":"9da19567-3a3f-4c3f-b00d-84f5f93bc40c","html_url":"https://github.com/launchbynttdata/tf-azurerm-module_reference-key_vault","commit_stats":null,"previous_names":["launchbynttdata/tf-azurerm-module_reference-key_vault"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/launchbynttdata/tf-azurerm-module_reference-key_vault","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-azurerm-module_reference-key_vault","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-azurerm-module_reference-key_vault/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-azurerm-module_reference-key_vault/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-azurerm-module_reference-key_vault/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/launchbynttdata","download_url":"https://codeload.github.com/launchbynttdata/tf-azurerm-module_reference-key_vault/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-azurerm-module_reference-key_vault/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31918479,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-16T18:22:33.417Z","status":"online","status_checked_at":"2026-04-17T02:00:06.879Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["azure","infrastructure-as-code","platform-automation","reference","terraform"],"created_at":"2024-11-09T06:07:32.263Z","updated_at":"2026-04-17T06:32:23.930Z","avatar_url":"https://github.com/launchbynttdata.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tf-azurerm-module_reference-key_vault\n\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![License: CC BY-NC-ND 4.0](https://img.shields.io/badge/License-CC_BY--NC--ND_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-nd/4.0/)\n\n## Overview\n\nThis reference architecture module provisions a Key Vault in its own Resource Group. Based on the inputs provided, it can also\nprovision a Private Key Vault with private endpoints in a provided subnet.\n\nThe module also supports Azure Monitor integration through action groups, metric alerts, diagnostic settings, Log Analytics\nworkspaces, and scheduled query alerts for Key Vault log-based detections.\n\n## Pre-Commit hooks\n\n[.pre-commit-config.yaml](.pre-commit-config.yaml) file defines certain `pre-commit` hooks that are relevant to terraform, golang and common linting tasks. There are no custom hooks added.\n\n`commitlint` hook enforces commit message in certain format. The commit contains the following structural elements, to communicate intent to the consumers of your commit messages:\n\n- **fix**: a commit of the type `fix` patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).\n- **feat**: a commit of the type `feat` introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).\n- **BREAKING CHANGE**: a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.\nfooters other than BREAKING CHANGE: \u003cdescription\u003e may be provided and follow a convention similar to git trailer format.\n- **build**: a commit of the type `build` adds changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)\n- **chore**: a commit of the type `chore` adds changes that don't modify src or test files\n- **ci**: a commit of the type `ci` adds changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)\n- **docs**: a commit of the type `docs` adds documentation only changes\n- **perf**: a commit of the type `perf` adds code change that improves performance\n- **refactor**: a commit of the type `refactor` adds code change that neither fixes a bug nor adds a feature\n- **revert**: a commit of the type `revert` reverts a previous commit\n- **style**: a commit of the type `style` adds code changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)\n- **test**: a commit of the type `test` adds missing tests or correcting existing tests\n\nBase configuration used for this project is [commitlint-config-conventional (based on the Angular convention)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum)\n\nIf you are a developer using vscode, [this](https://marketplace.visualstudio.com/items?itemName=joshbolduc.commitlint) plugin may be helpful.\n\n`detect-secrets-hook` prevents new secrets from being introduced into the baseline. TODO: INSERT DOC LINK ABOUT HOOKS\n\nIn order for `pre-commit` hooks to work properly\n\n- You need to have the pre-commit package manager installed. [Here](https://pre-commit.com/#install) are the installation instructions.\n- `pre-commit` would install all the hooks when commit message is added by default except for `commitlint` hook. `commitlint` hook would need to be installed manually using the command below\n\n```\npre-commit install --hook-type commit-msg\n```\n\n## To test the resource group module locally\n\n1. For development/enhancements to this module locally, you'll need to install all of its components. This is controlled by the `configure` target in the project's [`Makefile`](./Makefile). Before you can run `configure`, familiarize yourself with the variables in the `Makefile` and ensure they're pointing to the right places.\n\n```\nmake configure\n```\n\nThis adds in several files and directories that are ignored by `git`. They expose many new Make targets.\n\n2. _THIS STEP APPLIES ONLY TO MICROSOFT AZURE. IF YOU ARE USING A DIFFERENT PLATFORM PLEASE SKIP THIS STEP._ The first target you care about is `env`. This is the common interface for setting up environment variables. The values of the environment variables will be used to authenticate with cloud provider from local development workstation.\n\n`make configure` command will bring down `azure_env.sh` file on local workstation. Devloper would need to modify this file, replace the environment variable values with relevant values.\n\nThese environment variables are used by `terratest` integration suit.\n\nService principle used for authentication(value of ARM_CLIENT_ID) should have below privileges on resource group within the subscription.\n\n```\n\"Microsoft.Resources/subscriptions/resourceGroups/write\"\n\"Microsoft.Resources/subscriptions/resourceGroups/read\"\n\"Microsoft.Resources/subscriptions/resourceGroups/delete\"\n```\n\nThen run this make target to set the environment variables on developer workstation.\n\n```\nmake env\n```\n\n3. The first target you care about is `check`.\n\n**Pre-requisites**\nBefore running this target it is important to ensure that, developer has created files mentioned below on local workstation under root directory of git repository that contains code for primitives/segments. Note that these files are `azure` specific. If primitive/segment under development uses any other cloud provider than azure, this section may not be relevant.\n\n- A file named `provider.tf` with contents below\n\n```\nprovider \"azurerm\" {\n  features {}\n}\n```\n\n- A file named `terraform.tfvars` which contains key value pair of variables used.\n\nNote that since these files are added in `gitignore` they would not be checked in into primitive/segment's git repo.\n\nAfter creating these files, for running tests associated with the primitive/segment, run\n\n```\nmake check\n```\n\nIf `make check` target is successful, developer is good to commit the code to primitive/segment's git repo.\n\n`make check` target\n\n- runs `terraform commands` to `lint`,`validate` and `plan` terraform code.\n- runs `conftests`. `conftests` make sure `policy` checks are successful.\n- runs `terratest`. This is integration test suit.\n- runs `opa` tests\n\u003c!-- BEGIN_TF_DOCS --\u003e\n## Requirements\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"requirement_terraform\"\u003e\u003c/a\u003e [terraform](#requirement\\_terraform) | ~\u003e 1.5 |\n| \u003ca name=\"requirement_azurerm\"\u003e\u003c/a\u003e [azurerm](#requirement\\_azurerm) | ~\u003e 3.77 |\n\n## Providers\n\nNo providers.\n\n## Modules\n\n| Name | Source | Version |\n|------|--------|---------|\n| \u003ca name=\"module_resource_names\"\u003e\u003c/a\u003e [resource\\_names](#module\\_resource\\_names) | terraform.registry.launch.nttdata.com/module_library/resource_name/launch | ~\u003e 2.0 |\n| \u003ca name=\"module_resource_group\"\u003e\u003c/a\u003e [resource\\_group](#module\\_resource\\_group) | terraform.registry.launch.nttdata.com/module_primitive/resource_group/azurerm | ~\u003e 1.0 |\n| \u003ca name=\"module_key_vault\"\u003e\u003c/a\u003e [key\\_vault](#module\\_key\\_vault) | terraform.registry.launch.nttdata.com/module_primitive/key_vault/azurerm | ~\u003e 2.0 |\n| \u003ca name=\"module_role_assignment\"\u003e\u003c/a\u003e [role\\_assignment](#module\\_role\\_assignment) | terraform.registry.launch.nttdata.com/module_primitive/role_assignment/azurerm | ~\u003e 1.2.1 |\n| \u003ca name=\"module_secrets\"\u003e\u003c/a\u003e [secrets](#module\\_secrets) | terraform.registry.launch.nttdata.com/module_primitive/key_vault_secret/azurerm | ~\u003e 1.0 |\n| \u003ca name=\"module_imported_certificates\"\u003e\u003c/a\u003e [imported\\_certificates](#module\\_imported\\_certificates) | terraform.registry.launch.nttdata.com/module_primitive/key_vault_certificate/azurerm | ~\u003e 1.0 |\n| \u003ca name=\"module_certificate_issuers\"\u003e\u003c/a\u003e [certificate\\_issuers](#module\\_certificate\\_issuers) | terraform.registry.launch.nttdata.com/module_primitive/key_vault_certificate_issuer/azurerm | ~\u003e 1.0 |\n| \u003ca name=\"module_generated_certificates\"\u003e\u003c/a\u003e [generated\\_certificates](#module\\_generated\\_certificates) | terraform.registry.launch.nttdata.com/module_primitive/key_vault_certificate/azurerm | ~\u003e 1.0 |\n| \u003ca name=\"module_private_endpoint\"\u003e\u003c/a\u003e [private\\_endpoint](#module\\_private\\_endpoint) | terraform.registry.launch.nttdata.com/module_primitive/private_endpoint/azurerm | ~\u003e 1.0 |\n| \u003ca name=\"module_monitor_action_group\"\u003e\u003c/a\u003e [monitor\\_action\\_group](#module\\_monitor\\_action\\_group) | terraform.registry.launch.nttdata.com/module_primitive/monitor_action_group/azurerm | ~\u003e 1.0.0 |\n| \u003ca name=\"module_monitor_metric_alert\"\u003e\u003c/a\u003e [monitor\\_metric\\_alert](#module\\_monitor\\_metric\\_alert) | terraform.registry.launch.nttdata.com/module_primitive/monitor_metric_alert/azurerm | ~\u003e 2.0 |\n| \u003ca name=\"module_monitor_scheduled_query_alert\"\u003e\u003c/a\u003e [monitor\\_scheduled\\_query\\_alert](#module\\_monitor\\_scheduled\\_query\\_alert) | terraform.registry.launch.nttdata.com/module_primitive/monitor_scheduled_query_alert/azurerm | ~\u003e 1.0 |\n| \u003ca name=\"module_log_analytics_workspace\"\u003e\u003c/a\u003e [log\\_analytics\\_workspace](#module\\_log\\_analytics\\_workspace) | terraform.registry.launch.nttdata.com/module_primitive/log_analytics_workspace/azurerm | ~\u003e 1.0 |\n| \u003ca name=\"module_diagnostic_setting\"\u003e\u003c/a\u003e [diagnostic\\_setting](#module\\_diagnostic\\_setting) | terraform.registry.launch.nttdata.com/module_primitive/monitor_diagnostic_setting/azurerm | ~\u003e 3.0 |\n\n## Resources\n\nNo resources.\n\n## Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\n| \u003ca name=\"input_location\"\u003e\u003c/a\u003e [location](#input\\_location) | Location of the resource group and other services in this module. | `string` | n/a | yes |\n| \u003ca name=\"input_key_vault_name\"\u003e\u003c/a\u003e [key\\_vault\\_name](#input\\_key\\_vault\\_name) | (Optional) If specified, this module will use this name for key vault else the naming module will create a name.\u003cbr/\u003e    Length must be less than 24 characters | `string` | `null` | no |\n| \u003ca name=\"input_enabled_for_deployment\"\u003e\u003c/a\u003e [enabled\\_for\\_deployment](#input\\_enabled\\_for\\_deployment) | If Azure VM is permitted to retrieve secrets | `bool` | `false` | no |\n| \u003ca name=\"input_enabled_for_template_deployment\"\u003e\u003c/a\u003e [enabled\\_for\\_template\\_deployment](#input\\_enabled\\_for\\_template\\_deployment) | If Azure RM is permitted to retrieve secrets | `bool` | `false` | no |\n| \u003ca name=\"input_soft_delete_retention_days\"\u003e\u003c/a\u003e [soft\\_delete\\_retention\\_days](#input\\_soft\\_delete\\_retention\\_days) | Number of retention days for soft delete | `number` | `7` | no |\n| \u003ca name=\"input_purge_protection_enabled\"\u003e\u003c/a\u003e [purge\\_protection\\_enabled](#input\\_purge\\_protection\\_enabled) | If purge\\_protection is enabled | `bool` | `false` | no |\n| \u003ca name=\"input_sku_name\"\u003e\u003c/a\u003e [sku\\_name](#input\\_sku\\_name) | SKU for the key vault - standard or premium | `string` | `\"standard\"` | no |\n| \u003ca name=\"input_access_policies\"\u003e\u003c/a\u003e [access\\_policies](#input\\_access\\_policies) | Additional Access policies for the vault except the current user which are added by default.\u003cbr/\u003e    Required only when enable\\_rbac\\_authorization is set to false. | \u003cpre\u003emap(object({\u003cbr/\u003e    object_id               = string\u003cbr/\u003e    tenant_id               = string\u003cbr/\u003e    key_permissions         = list(string)\u003cbr/\u003e    certificate_permissions = list(string)\u003cbr/\u003e    secret_permissions      = list(string)\u003cbr/\u003e    storage_permissions     = list(string)\u003cbr/\u003e  }))\u003c/pre\u003e | `{}` | no |\n| \u003ca name=\"input_enable_rbac_authorization\"\u003e\u003c/a\u003e [enable\\_rbac\\_authorization](#input\\_enable\\_rbac\\_authorization) | Enable RBAC authorization for the key vault | `bool` | `false` | no |\n| \u003ca name=\"input_network_acls\"\u003e\u003c/a\u003e [network\\_acls](#input\\_network\\_acls) | Network ACLs for the key vault | \u003cpre\u003eobject({\u003cbr/\u003e    bypass                     = string\u003cbr/\u003e    default_action             = string\u003cbr/\u003e    ip_rules                   = optional(list(string))\u003cbr/\u003e    virtual_network_subnet_ids = optional(list(string))\u003cbr/\u003e  })\u003c/pre\u003e | \u003cpre\u003e{\u003cbr/\u003e  \"bypass\": \"AzureServices\",\u003cbr/\u003e  \"default_action\": \"Allow\",\u003cbr/\u003e  \"ip_rules\": [],\u003cbr/\u003e  \"virtual_network_subnet_ids\": []\u003cbr/\u003e}\u003c/pre\u003e | no |\n| \u003ca name=\"input_public_network_access_enabled\"\u003e\u003c/a\u003e [public\\_network\\_access\\_enabled](#input\\_public\\_network\\_access\\_enabled) | (Optional) Whether public network access is allowed for this Key Vault. Defaults to true. If false, then only private\u003cbr/\u003e    endpoints can access the Key Vault. | `bool` | `true` | no |\n| \u003ca name=\"input_certificates\"\u003e\u003c/a\u003e [certificates](#input\\_certificates) | List of certificates to be imported. If `filepath` is specified then the pfx files should be present in the root of the module (path.root). If `content` is specified then the content of the certificate should be provided in base 64 encoded format. Only one of them should be provided. | \u003cpre\u003emap(object({\u003cbr/\u003e    contents = optional(string)\u003cbr/\u003e    filepath = optional(string)\u003cbr/\u003e    password = optional(string)\u003cbr/\u003e  }))\u003c/pre\u003e | `{}` | no |\n| \u003ca name=\"input_certificate_issuers\"\u003e\u003c/a\u003e [certificate\\_issuers](#input\\_certificate\\_issuers) | List of certificate issuers to be created | \u003cpre\u003emap(object({\u003cbr/\u003e    provider_name = string\u003cbr/\u003e    org_id        = string\u003cbr/\u003e    account_id    = string\u003cbr/\u003e    password      = string\u003cbr/\u003e\u003cbr/\u003e    admins = optional(list(object({\u003cbr/\u003e      email_address = string\u003cbr/\u003e      first_name    = optional(string)\u003cbr/\u003e      last_name     = optional(string)\u003cbr/\u003e      phone         = optional(string)\u003cbr/\u003e    })), [])\u003cbr/\u003e  }))\u003c/pre\u003e | `{}` | no |\n| \u003ca name=\"input_generated_certificates\"\u003e\u003c/a\u003e [generated\\_certificates](#input\\_generated\\_certificates) | List of certificates to be generated using an issuer. | \u003cpre\u003emap(object({\u003cbr/\u003e    issuer_name = string\u003cbr/\u003e\u003cbr/\u003e    key_properties = optional(object({\u003cbr/\u003e      exportable = bool\u003cbr/\u003e      reuse_key  = bool\u003cbr/\u003e      key_type   = string\u003cbr/\u003e\u003cbr/\u003e      key_size = optional(number)\u003cbr/\u003e      curve    = optional(string)\u003cbr/\u003e      }), {\u003cbr/\u003e      exportable = true\u003cbr/\u003e      key_type   = \"RSA\"\u003cbr/\u003e      key_size   = 2048\u003cbr/\u003e      reuse_key  = false\u003cbr/\u003e    })\u003cbr/\u003e\u003cbr/\u003e    lifetime_action = optional(object({\u003cbr/\u003e      action = object({\u003cbr/\u003e        action_type = string\u003cbr/\u003e      })\u003cbr/\u003e      trigger = object({\u003cbr/\u003e        lifetime_percentage = optional(number)\u003cbr/\u003e        days_before_expiry  = optional(number)\u003cbr/\u003e      })\u003cbr/\u003e    }))\u003cbr/\u003e\u003cbr/\u003e    secret_properties = optional(object({\u003cbr/\u003e      content_type = string\u003cbr/\u003e      }), {\u003cbr/\u003e      content_type = \"application/x-pkcs12\"\u003cbr/\u003e    })\u003cbr/\u003e\u003cbr/\u003e    x509_certificate_properties = optional(object({\u003cbr/\u003e      key_usage          = list(string)\u003cbr/\u003e      extended_key_usage = optional(list(string))\u003cbr/\u003e      subject            = string\u003cbr/\u003e      validity_in_months = number\u003cbr/\u003e      subject_alternative_names = optional(object({\u003cbr/\u003e        dns_names = optional(list(string))\u003cbr/\u003e        emails    = optional(list(string))\u003cbr/\u003e        upns      = optional(list(string))\u003cbr/\u003e      }))\u003cbr/\u003e    }))\u003cbr/\u003e  }))\u003c/pre\u003e | `{}` | no |\n| \u003ca name=\"input_secrets\"\u003e\u003c/a\u003e [secrets](#input\\_secrets) | List of secrets (name and value) | `map(string)` | `{}` | no |\n| \u003ca name=\"input_resource_names_map\"\u003e\u003c/a\u003e [resource\\_names\\_map](#input\\_resource\\_names\\_map) | A map of key to resource\\_name that will be used by tf-launch-module\\_library-resource\\_name to generate resource names | \u003cpre\u003emap(object({\u003cbr/\u003e    name       = string\u003cbr/\u003e    max_length = optional(number, 60)\u003cbr/\u003e  }))\u003c/pre\u003e | \u003cpre\u003e{\u003cbr/\u003e  \"diagnostic_setting\": {\u003cbr/\u003e    \"max_length\": 80,\u003cbr/\u003e    \"name\": \"ds\"\u003cbr/\u003e  },\u003cbr/\u003e  \"key_vault\": {\u003cbr/\u003e    \"max_length\": 24,\u003cbr/\u003e    \"name\": \"kv\"\u003cbr/\u003e  },\u003cbr/\u003e  \"log_analytics_workspace\": {\u003cbr/\u003e    \"max_length\": 80,\u003cbr/\u003e    \"name\": \"law\"\u003cbr/\u003e  },\u003cbr/\u003e  \"private_endpoint\": {\u003cbr/\u003e    \"max_length\": 80,\u003cbr/\u003e    \"name\": \"pe\"\u003cbr/\u003e  },\u003cbr/\u003e  \"private_service_connection\": {\u003cbr/\u003e    \"max_length\": 80,\u003cbr/\u003e    \"name\": \"pesc\"\u003cbr/\u003e  },\u003cbr/\u003e  \"resource_group\": {\u003cbr/\u003e    \"max_length\": 80,\u003cbr/\u003e    \"name\": \"rg\"\u003cbr/\u003e  }\u003cbr/\u003e}\u003c/pre\u003e | no |\n| \u003ca name=\"input_environment\"\u003e\u003c/a\u003e [environment](#input\\_environment) | Environment in which the resource should be provisioned like dev, qa, prod etc. | `string` | n/a | yes |\n| \u003ca name=\"input_environment_number\"\u003e\u003c/a\u003e [environment\\_number](#input\\_environment\\_number) | The environment count for the respective environment. Defaults to 000. Increments in value of 1 | `string` | `\"000\"` | no |\n| \u003ca name=\"input_resource_number\"\u003e\u003c/a\u003e [resource\\_number](#input\\_resource\\_number) | The resource count for the respective resource. Defaults to 000. Increments in value of 1 | `string` | `\"000\"` | no |\n| \u003ca name=\"input_logical_product_family\"\u003e\u003c/a\u003e [logical\\_product\\_family](#input\\_logical\\_product\\_family) | (Required) Name of the product family for which the resource is created.\u003cbr/\u003e    Example: org\\_name, department\\_name. | `string` | n/a | yes |\n| \u003ca name=\"input_logical_product_service\"\u003e\u003c/a\u003e [logical\\_product\\_service](#input\\_logical\\_product\\_service) | (Required) Name of the product service for which the resource is created.\u003cbr/\u003e    For example, backend, frontend, middleware etc. | `string` | n/a | yes |\n| \u003ca name=\"input_use_azure_region_abbr\"\u003e\u003c/a\u003e [use\\_azure\\_region\\_abbr](#input\\_use\\_azure\\_region\\_abbr) | Use Azure region abbreviation in the resource name | `bool` | `true` | no |\n| \u003ca name=\"input_role_assignments\"\u003e\u003c/a\u003e [role\\_assignments](#input\\_role\\_assignments) | A map of role assignments to be created | \u003cpre\u003emap(object({\u003cbr/\u003e    role_definition_name = string\u003cbr/\u003e    principal_id         = string\u003cbr/\u003e    principal_type       = string\u003cbr/\u003e  }))\u003c/pre\u003e | `{}` | no |\n| \u003ca name=\"input_subnet_id\"\u003e\u003c/a\u003e [subnet\\_id](#input\\_subnet\\_id) | The ID of the Subnet from which Private IP Addresses will be allocated for this Private Endpoint.\u003cbr/\u003e    Changing this forces a new resource to be created. | `string` | `null` | no |\n| \u003ca name=\"input_private_dns_zone_ids\"\u003e\u003c/a\u003e [private\\_dns\\_zone\\_ids](#input\\_private\\_dns\\_zone\\_ids) | A list of Private DNS Zone IDs to link with the Private Endpoint. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_private_dns_zone_group_name\"\u003e\u003c/a\u003e [private\\_dns\\_zone\\_group\\_name](#input\\_private\\_dns\\_zone\\_group\\_name) | Specifies the Name of the Private DNS Zone Group. | `string` | `\"vault\"` | no |\n| \u003ca name=\"input_is_manual_connection\"\u003e\u003c/a\u003e [is\\_manual\\_connection](#input\\_is\\_manual\\_connection) | Does the Private Endpoint require Manual Approval from the remote resource owner? Changing this forces a new resource\u003cbr/\u003e    to be created. | `bool` | `false` | no |\n| \u003ca name=\"input_subresource_names\"\u003e\u003c/a\u003e [subresource\\_names](#input\\_subresource\\_names) | A list of subresource names which the Private Endpoint is able to connect to. subresource\\_names corresponds to group\\_id.\u003cbr/\u003e    Possible values are detailed in the product documentation in the Subresources column.\u003cbr/\u003e    https://docs.microsoft.com/azure/private-link/private-endpoint-overview#private-link-resource | `list(string)` | \u003cpre\u003e[\u003cbr/\u003e  \"vault\"\u003cbr/\u003e]\u003c/pre\u003e | no |\n| \u003ca name=\"input_request_message\"\u003e\u003c/a\u003e [request\\_message](#input\\_request\\_message) | A message passed to the owner of the remote resource when the private endpoint attempts to establish the connection\u003cbr/\u003e    to the remote resource. The request message can be a maximum of 140 characters in length.\u003cbr/\u003e    Only valid if `is_manual_connection=true` | `string` | `\"\"` | no |\n| \u003ca name=\"input_tags\"\u003e\u003c/a\u003e [tags](#input\\_tags) | A map of tags to be associated with the resources | `map(string)` | `{}` | no |\n| \u003ca name=\"input_action_group\"\u003e\u003c/a\u003e [action\\_group](#input\\_action\\_group) | An action group object. Each action group can have:\u003cbr/\u003e  - short\\_name: (Required) The short name of the action group\u003cbr/\u003e  - arm\\_role\\_receivers: (Optional) List of ARM role receivers\u003cbr/\u003e  - email\\_receivers: (Optional) List of email receivers | \u003cpre\u003eobject({\u003cbr/\u003e    name       = string\u003cbr/\u003e    short_name = string\u003cbr/\u003e\u003cbr/\u003e    arm_role_receivers = optional(list(object({\u003cbr/\u003e      name                    = string\u003cbr/\u003e      role_id                 = string\u003cbr/\u003e      use_common_alert_schema = optional(bool)\u003cbr/\u003e    })), [])\u003cbr/\u003e\u003cbr/\u003e    email_receivers = optional(list(object({\u003cbr/\u003e      name                    = string\u003cbr/\u003e      email_address           = string\u003cbr/\u003e      use_common_alert_schema = optional(bool)\u003cbr/\u003e    })), [])\u003cbr/\u003e  })\u003c/pre\u003e | `null` | no |\n| \u003ca name=\"input_action_group_ids\"\u003e\u003c/a\u003e [action\\_group\\_ids](#input\\_action\\_group\\_ids) | A list of action group IDs. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_metric_alerts\"\u003e\u003c/a\u003e [metric\\_alerts](#input\\_metric\\_alerts) | n/a | \u003cpre\u003emap(object({\u003cbr/\u003e\u003cbr/\u003e    description        = string\u003cbr/\u003e    action_groups      = optional(set(string), [])\u003cbr/\u003e    frequency          = optional(string, \"PT1M\")\u003cbr/\u003e    severity           = optional(number, 3)\u003cbr/\u003e    enabled            = optional(bool, true)\u003cbr/\u003e    webhook_properties = optional(map(string))\u003cbr/\u003e\u003cbr/\u003e    criteria = optional(list(object({\u003cbr/\u003e      metric_namespace       = string\u003cbr/\u003e      metric_name            = string\u003cbr/\u003e      aggregation            = string\u003cbr/\u003e      operator               = string\u003cbr/\u003e      threshold              = number\u003cbr/\u003e      skip_metric_validation = optional(bool, false)\u003cbr/\u003e\u003cbr/\u003e      dimensions = optional(list(object({\u003cbr/\u003e        name     = string\u003cbr/\u003e        operator = string\u003cbr/\u003e        values   = list(string)\u003cbr/\u003e      })))\u003cbr/\u003e    })))\u003cbr/\u003e\u003cbr/\u003e    dynamic_criteria = optional(object({\u003cbr/\u003e      metric_namespace       = string\u003cbr/\u003e      metric_name            = string\u003cbr/\u003e      aggregation            = string\u003cbr/\u003e      operator               = string\u003cbr/\u003e      alert_sensitivity      = string\u003cbr/\u003e      ignore_data_before     = optional(string)\u003cbr/\u003e      skip_metric_validation = optional(bool, false)\u003cbr/\u003e\u003cbr/\u003e      dimensions = optional(list(object({\u003cbr/\u003e        name     = string\u003cbr/\u003e        operator = string\u003cbr/\u003e        values   = list(string)\u003cbr/\u003e      })))\u003cbr/\u003e    }))\u003cbr/\u003e\u003cbr/\u003e  }))\u003c/pre\u003e | `{}` | no |\n| \u003ca name=\"input_scheduled_query_alerts\"\u003e\u003c/a\u003e [scheduled\\_query\\_alerts](#input\\_scheduled\\_query\\_alerts) | n/a | \u003cpre\u003emap(object({\u003cbr/\u003e    data_source_id          = optional(string)\u003cbr/\u003e    description             = optional(string, \"\")\u003cbr/\u003e    enabled                 = optional(bool, true)\u003cbr/\u003e    query                   = string\u003cbr/\u003e    severity                = optional(number, 1)\u003cbr/\u003e    frequency               = optional(number, 5)\u003cbr/\u003e    time_window             = optional(number, 30)\u003cbr/\u003e    authorized_resource_ids = optional(list(string), [])\u003cbr/\u003e    trigger_operator        = optional(string, \"GreaterThan\")\u003cbr/\u003e    trigger_threshold       = optional(number, 0)\u003cbr/\u003e    action_group_ids        = optional(list(string), [])\u003cbr/\u003e    email_subject           = optional(string, \"Alert Notification\")\u003cbr/\u003e    custom_webhook_payload  = optional(string, \"{}\")\u003cbr/\u003e  }))\u003c/pre\u003e | `{}` | no |\n| \u003ca name=\"input_diagnostic_settings\"\u003e\u003c/a\u003e [diagnostic\\_settings](#input\\_diagnostic\\_settings) | n/a | \u003cpre\u003emap(object({\u003cbr/\u003e\u003cbr/\u003e    enabled_log = optional(list(object({\u003cbr/\u003e      category_group = optional(string, \"allLogs\")\u003cbr/\u003e      category       = optional(string, null)\u003cbr/\u003e    })))\u003cbr/\u003e\u003cbr/\u003e    metrics = optional(list(object({\u003cbr/\u003e      category = string\u003cbr/\u003e      enabled  = optional(bool)\u003cbr/\u003e    })))\u003cbr/\u003e\u003cbr/\u003e  }))\u003c/pre\u003e | `{}` | no |\n| \u003ca name=\"input_log_analytics_workspace\"\u003e\u003c/a\u003e [log\\_analytics\\_workspace](#input\\_log\\_analytics\\_workspace) | n/a | \u003cpre\u003eobject({\u003cbr/\u003e\u003cbr/\u003e    sku               = string\u003cbr/\u003e    retention_in_days = number\u003cbr/\u003e    daily_quota_gb    = number\u003cbr/\u003e\u003cbr/\u003e    identity = optional(object({\u003cbr/\u003e      type         = string\u003cbr/\u003e      identity_ids = optional(list(string))\u003cbr/\u003e    }))\u003cbr/\u003e\u003cbr/\u003e    local_authentication_disabled = optional(bool)\u003cbr/\u003e\u003cbr/\u003e  })\u003c/pre\u003e | `null` | no |\n| \u003ca name=\"input_log_analytics_workspace_id\"\u003e\u003c/a\u003e [log\\_analytics\\_workspace\\_id](#input\\_log\\_analytics\\_workspace\\_id) | (Optional) The ID of the Log Analytics Workspace. | `string` | `null` | no |\n\n## Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_resource_group_id\"\u003e\u003c/a\u003e [resource\\_group\\_id](#output\\_resource\\_group\\_id) | ID of the Resource Group |\n| \u003ca name=\"output_resource_group_name\"\u003e\u003c/a\u003e [resource\\_group\\_name](#output\\_resource\\_group\\_name) | Name of the Resource Group |\n| \u003ca name=\"output_key_vault_id\"\u003e\u003c/a\u003e [key\\_vault\\_id](#output\\_key\\_vault\\_id) | ID of the Key Vault |\n| \u003ca name=\"output_vault_uri\"\u003e\u003c/a\u003e [vault\\_uri](#output\\_vault\\_uri) | URI of the Key Vault |\n| \u003ca name=\"output_access_policies_object_ids\"\u003e\u003c/a\u003e [access\\_policies\\_object\\_ids](#output\\_access\\_policies\\_object\\_ids) | Object IDs of the Key Vault Access Policies |\n| \u003ca name=\"output_key_vault_name\"\u003e\u003c/a\u003e [key\\_vault\\_name](#output\\_key\\_vault\\_name) | Name of the Key Vault |\n| \u003ca name=\"output_private_endpoint_id\"\u003e\u003c/a\u003e [private\\_endpoint\\_id](#output\\_private\\_endpoint\\_id) | ID of the Private Endpoint |\n| \u003ca name=\"output_certificate_ids\"\u003e\u003c/a\u003e [certificate\\_ids](#output\\_certificate\\_ids) | IDs of the certificates from the Key Vault in the reference module |\n| \u003ca name=\"output_secret_ids\"\u003e\u003c/a\u003e [secret\\_ids](#output\\_secret\\_ids) | IDs of the secrets from the Key Vault in the reference module |\n| \u003ca name=\"output_key_ids\"\u003e\u003c/a\u003e [key\\_ids](#output\\_key\\_ids) | IDs of the keys from the Key Vault in the reference module |\n| \u003ca name=\"output_scheduled_query_alert_ids\"\u003e\u003c/a\u003e [scheduled\\_query\\_alert\\_ids](#output\\_scheduled\\_query\\_alert\\_ids) | IDs of the scheduled query alerts created by the reference module |\n| \u003ca name=\"output_scheduled_query_alert_names\"\u003e\u003c/a\u003e [scheduled\\_query\\_alert\\_names](#output\\_scheduled\\_query\\_alert\\_names) | Names of the scheduled query alerts created by the reference module |\n\u003c!-- END_TF_DOCS --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaunchbynttdata%2Ftf-azurerm-module_reference-key_vault","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flaunchbynttdata%2Ftf-azurerm-module_reference-key_vault","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaunchbynttdata%2Ftf-azurerm-module_reference-key_vault/lists"}