This module returns a resource name based on the naming convention standards specified in the HLD.
Note: please validate which input is necessary based on the required resource name
For example:
1. For type = "resource_group" the necessary parameters are:
i. service_name
ii. environment
2. For type = "network_security_group" the necessary parameters are:
i. nsg_scope
ii. nsg_resourcemodule "resource_group_name" {
source = "git::https://github.com/adammontlake/alz-naming-convention/naming_convention"
service_name = "shared_resources"
environment = "production"
type = "resource_group"
}| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| action | Specifies the nsg rule action type. | string |
"allow" |
no |
| des_usage | Specifies the disk encryption set usage. | string |
"os" |
no |
| desatination_address_title | Describes the destination of the traffic. | string |
"" |
no |
| destination_description | Specifies the DNS private resolver rule set rule destination description | string |
"" |
no |
| destination_port | Destination port for the traffic. | string |
"" |
no |
| destination_resource | Specifies the nsg rule destination resource. | string |
"allow" |
no |
| direction | Specifies the DNS private resolver endpoint direction | string |
"in" |
no |
| disk_description | Specifies what the storage will be used for. | string |
"os" |
no |
| disk_resource_description | Disc resource description. | string |
"" |
no |
| environment | Specifies the environment, for example: 'production' or 'staging' | string |
"" |
no |
| er_circuit_name | Specifies the express route circuit name. | string |
"" |
no |
| er_gateway_name | Specifies the express route gateway name. | string |
"" |
no |
| erp_name | Specifies the express route peering name. | string |
"" |
no |
| erp_type | Specifies the express route peering type. | string |
"AzurePrivatePeering" |
no |
| group_description | Specifies the description of the firewall rule group. | string |
"" |
no |
| kv_env | Specifies the environment, for example: 'p for production' or 'd for deployment' | string |
"p" |
no |
| law_purpose | Specifies the log analytics purpose. | string |
"sentinel" |
no |
| local_network_ref | Specifies the vpn gateway connection local network. | string |
"" |
no |
| nsg_resource | Specifies the resource type for which the NSG is created. | string |
"" |
no |
| nsg_scope | Specifies the scope for which the NSG is created. | string |
"subnet" |
no |
| number | Specifies the number of the resource being created, defaults to 1. | number |
1 |
no |
| plane | Specifies the vpn gateway plane. | string |
"" |
no |
| policy_description | Specifies the description of the firewall policy. | string |
"" |
no |
| remote_network_ref | Specifies the vpn gateway connection local remote. | string |
"" |
no |
| resource_name | (private_endpoint_resource) Specifies the name of the target resource that the private endpoint resource will be associated to. | string |
"" |
no |
| resource_number | Specifies the number (in order) of the service which will be created. | string |
"" |
no |
| rule_set_description | Specifies the DNS private resolver rule set description | string |
"" |
no |
| service_name | Specifies the name of the service which will be created. | string |
"" |
no |
| source_address_title | Describes the source of the traffic. | string |
"" |
no |
| source_network | Specifies the name of the source virtual network for the peering association. | string |
"" |
no |
| source_port | Source port for the traffic. | string |
"" |
no |
| source_resource | Specifies the nsg rule source resource. | string |
"" |
no |
| ssh_key_usage | Specifies the ssh key usage. | string |
"access" |
no |
| storage_description | Specifies the name of the subnet that the resource will be associated to. | string |
"" |
no |
| subnet_name | Specifies the name of the subnet that the resource will be associated to. | string |
"" |
no |
| subscription_purpose | Specifies the vpn gateway subscription purpose. | string |
"" |
no |
| subscrtiption_name | Specifies the name of the subscription, for example: 'sub-sentinel-pron' or 'sub-dev' | string |
"" |
no |
| target_network | Specifies the name of the target virtual network for the peering association. | string |
"" |
no |
| traffic_protocol | Specifies the protocol of the traffic this rule relates to, can be: tcp, udp or icmp. | string |
"tcp" |
no |
| traffic_type | Specifies the type of the traffic this resource relates to, can be: application, network or DNAT. | string |
"network" |
no |
| type | [Mandatory] Specifies the type of the resource in lower case, for example: 'resource_group' or 'subnet'. | string |
n/a | yes |
| usage | Specifies the key vault key or secret usage. | string |
"" |
no |
| vnet_name | (private_endpoint_resource) Specifies the name of the virtual network that the private endpoint resource will be associated to. | string |
"" |
no |
| vnet_purpose | Specifies the vpn gateway vnet purpose. | string |
"" |
no |
| vpn_type | Specifies the vpn gateway type. | string |
"vpn" |
no |
| workload | Specifies the name of the service which will be created. | string |
"" |
no |
| Name | Description |
|---|---|
| name | Output include the full name which containe the naming standard |
No providers.
No resources.
No requirements.
- V1.0.0 - module created
- V1.0.1 - Use SSO for context pullingThis README was generated automatically.
Documentation is validated and corrected during push.