README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: Terraform AZURE Monitor

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-azure-monitor

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-azure-monitor.svg"
    url: "https://github.com/clouddrove/terraform-azure-monitor/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-azure-monitor/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-azure-monitor/actions/workflows/tfsec.yml"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"

#  description of this project
description: |-
  This terraform module is designed to create Azure Monitor Private Link Scope (AMPLS) resources. Image result for ampls An Azure Monitor private link connects a private endpoint to a set of Azure Monitor resources to define the boundaries of your monitoring network.

# extra content
include:
  - "terraform.md"

# 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:
   
  ```hcl
      module "key_vault" {
      source                      = "clouddrove/monitor/azure"
      name                        = "app"
      environment                 = "test"
      label_order                 = ["name", "environment"]
      resource_group_name         = module.resource_group.resource_group_name
      location                    = module.resource_group.resource_group_location
      linked_resource_ids         = [module.log-analytics.workspace_id]
      subnet_id                   = module.subnet.default_subnet_id[0]
      private_dns_zones_names = [
        "privatelink.agentsvc.azure-automation.net",
        "privatelink.blob.core.windows.net",
        "privatelink.monitor.azure.com",
        "privatelink.ods.opinsights.azure.com",
        "privatelink.oms.opinsights.azure.com",
       ]
      }
  ```