https://github.com/bcochofel/terraform-azurerm-resource-group
Terraform module to create Azure Resource Group
https://github.com/bcochofel/terraform-azurerm-resource-group
Last synced: 5 months ago
JSON representation
Terraform module to create Azure Resource Group
- Host: GitHub
- URL: https://github.com/bcochofel/terraform-azurerm-resource-group
- Owner: bcochofel
- License: mit
- Created: 2021-02-04T16:34:13.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-29T11:30:30.000Z (8 months ago)
- Last Synced: 2024-08-30T11:56:44.865Z (8 months ago)
- Language: Go
- Size: 67.4 KB
- Stars: 3
- Watchers: 0
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- jimsghstars - bcochofel/terraform-azurerm-resource-group - Terraform module to create Azure Resource Group (Go)
README
# Terraform module to create Azure Resource Group
This module creates Azure Resource Group.
It also has the option to create a lock on the Resource Group scope.
This module also validates the name according to the Azure Resource naming
restrictions.
**NOTE: To use the lock level option the service principal must have the "Owner"
or "User Access Administrator" roles.**
## Usage
```hcl
provider "azurerm" {
features {}
}
module "rg" {
source = "../../"
name = "rgdemo"
location = "North Europe"
tags = {
ManagedBy = "Terraform"
Environment = "sandbox"
}
}
```
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | ~> 1.9.0 |
| [azurerm](#requirement\_azurerm) | >= 3.106.1, < 4.0 |
## Providers
| Name | Version |
|------|---------|
| [azurerm](#provider\_azurerm) | >= 3.106.1, < 4.0 |
## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [azurerm_management_lock.resource-group-level-lock](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/management_lock) | resource |
| [azurerm_resource_group.rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [location](#input\_location) | The Azure Region where the Resource Group should exist.
Changing this forces a new Resource Group to be created. | `string` | n/a | yes |
| [lock\_level](#input\_lock\_level) | Specifies the Level to be used for this RG Lock.
Possible values are Empty (no lock), CanNotDelete and ReadOnly. | `string` | `""` | no |
| [name](#input\_name) | The Name which should be used for this Resource Group.
Changing this forces a new Resource Group to be created. | `string` | n/a | yes |
| [tags](#input\_tags) | A mapping of tags which should be assigned to the Resource Group. | `map(string)` | `{}` | no |
## Outputs
| Name | Description |
|------|-------------|
| [id](#output\_id) | The Resource Group id. |
| [location](#output\_location) | The Resource Group location. |
| [name](#output\_name) | The Resource Group name. |
| [tags](#output\_tags) | The Resource Group tags. |
## Contributing
This repository uses semantic versioning and conventional commits. Some automation need this to work correctly.
There are 2 GitHub Workflows:
- lint.yml: runs on Pull Request to validate Terraform
- release.yml: runs on merge to the default branch. This workflow generates a Changelog file and creates a GitHub release based on the conventional commit messages.
## Run tests
```bash
cd test/
go test -v
```
## pre-commit hooks
This repository uses [pre-commit](https://pre-commit.com/).
To install execute:
```bash
pre-commit install
pre-commit install --install-hooks -t commit-msg
```
To run the hooks you need to install:
* [terraform](https://github.com/hashicorp/terraform)
* [terraform-docs](https://github.com/terraform-docs/terraform-docs)
* [TFLint](https://github.com/terraform-linters/tflint)
* [TFSec](https://github.com/tfsec/tfsec)
* [checkov](https://github.com/bridgecrewio/checkov)
* [goimports](https://pkg.go.dev/golang.org/x/tools/cmd/goimports)
* [golint](https://pkg.go.dev/golang.org/x/lint/golint)
## References
* [Azure Resource naming restrictions](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules)
* [Azure Resource Group](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal)
* [Terraform azurerm_resource_group](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group)
* [Lock Resources](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/lock-resources)