Skip to content

Azure/terraform-azurerm-avm-res-portal-dashboard

Repository files navigation

avm-res-portal-dashboard

This module provides a generic way to create and manage an Azure portal dashboard resource. To use this module in your Terraform configuration, you'll need to provide values for the required variables.

Features

This is the Azure Portal Dashboard for the Azure Verified Modules library. This module deploys the Azure portal dashboard by using json template files for dashboard definitions. It leverages the AzureRM provider and sets a number of initial defaults to minimize the overall inputs for simple configurations.

Example Usage

Here is an example of how you can use this module in your Terraform configuration:

module "portal_dashboard" {
  source                  = "Azure/avm-res-portal-dashboard/azurerm"
  location                = azurerm_resource_group.this.location
  name                    = "portal-dashboard"
  resource_group_name     = azurerm_resource_group.this.name
  template_file_path      = "../templates/defaultDashboard.tpl"
  template_file_variables = {}
  enable_telemetry        = var.enable_telemetry # see variables.tf
}

Requirements

The following requirements are needed by this module:

Resources

The following resources are used by this module:

Required Inputs

The following input variables are required:

Description: Azure region where the resource should be deployed.

Type: string

Description: The name of the dashboard.

Type: string

Description: The resource group where the resources will be deployed.

Type: string

Description: Dashboard template file path. For example, ./templates/defaultDashboard.tpl.

Type: string

Optional Inputs

The following input variables are optional (have default values):

Description: This variable controls whether or not telemetry is enabled for the module.
For more information see https://aka.ms/avm/telemetryinfo.
If it is set to false, then no telemetry will be collected.

Type: bool

Default: true

Description: (Optional) Tags of the resource.

Type: map(string)

Default: null

Description: List of variables values mapping for variables defined in the dashboard template file.

Type: map(string)

Default: {}

Outputs

The following outputs are exported:

Description: This is the full output for the resource.

Description: The ID of the Azure portal dashboard resource.

Modules

No modules.

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

About

AVM Terraform module for Azure portal dashboard.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •