From 57c4aeb3b73e375b1b82b37e1dbc63266a03fe60 Mon Sep 17 00:00:00 2001 From: mamrajyadav Date: Tue, 2 Jan 2024 18:54:40 +0530 Subject: [PATCH] fix: update readme yaml --- README.yaml | 76 ++++++++++++++++++++++++++--------------------------- 1 file changed, 37 insertions(+), 39 deletions(-) diff --git a/README.yaml b/README.yaml index 5962ed8..46a9669 100644 --- a/README.yaml +++ b/README.yaml @@ -36,43 +36,41 @@ include: # How to use this project # yamllint disable rule:line-length usage: |- - Here is an example of how you can use this module in your inventory structure: ### Basic Example - ```hcl - module "vnet" { - source = "clouddrove/vnet/azure" - name = local.name - environment = local.environment - resource_group_name = "testsg" - location = "NorthEurope" - address_space = "10.0.0.0/16" - enable_network_watcher = false # To be set true when network security group flow logs are to be tracked and network watcher with specific name is to be deployed. - } - ``` - ### Complete Example - ```hcl - module "vnet" { - source = "clouddrove/vnet/azure" - name = local.name - environment = local.environment - resource_group_name = module.resource_group.resource_group_name - location = module.resource_group.resource_group_location - address_space = "10.0.0.0/16" - enable_ddos_pp = false - enable_network_watcher = false # To be set true when network security group flow logs are to be tracked and network watcher with specific name is to be deployed. - } - ``` - ### vnet_with_existing_ddos_id Example - ```hcl - module "vnet" { - source = "clouddrove/vnet/azure" - name = local.name - environment = local.environment - resource_group_name = module.resource_group.resource_group_name - location = module.resource_group.resource_group_location - address_space = "10.0.0.0/16" - existing_ddos_pp = "/subscriptions/068245d4-3c94-42fe-9c4d-9e5e1cabc60c/resourceGroups/" - enable_network_watcher = false - } - ``` - + ```hcl + module "vnet" { + source = "clouddrove/vnet/azure" + name = local.name + environment = local.environment + resource_group_name = "testsg" + location = "NorthEurope" + address_space = "10.0.0.0/16" + enable_network_watcher = false # To be set true when network security group flow logs are to be tracked and network watcher with specific name is to be deployed. + } + ``` + ### Complete Example + ```hcl + module "vnet" { + source = "clouddrove/vnet/azure" + name = local.name + environment = local.environment + resource_group_name = module.resource_group.resource_group_name + location = module.resource_group.resource_group_location + address_space = "10.0.0.0/16" + enable_ddos_pp = false + enable_network_watcher = false # To be set true when network security group flow logs are to be tracked and network watcher with specific name is to be deployed. + } + ``` + ### vnet_with_existing_ddos_id Example + ```hcl + module "vnet" { + source = "clouddrove/vnet/azure" + name = local.name + environment = local.environment + resource_group_name = module.resource_group.resource_group_name + location = module.resource_group.resource_group_location + address_space = "10.0.0.0/16" + existing_ddos_pp = "/subscriptions/068245d4-3c94-42fe-9c4d-9e5e1cabc60c/resourceGroups/" + enable_network_watcher = false + } + ```