Skip to content

Data Source: azurermPortalDashboard

Use this data source to access information about an existing shared dashboard in the Azure Portal. This is the data source of the azurermDashboard resource.

Example Usage

import * as cdktf from "cdktf";
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
new cdktf.TerraformOutput(this, "id", {
  value: "${data.azurerm_dashboard.example.id}",
});
new azurerm.dataAzurermPortalDashboard.DataAzurermPortalDashboard(
  this,
  "example",
  {
    name: "existing-dashboard",
    resource_group_name: "dashboard-rg",
  }
);

Arguments Reference

The following arguments are supported:

  • resourceGroupName - (Required) Specifies the name of the resource group the shared Azure Portal Dashboard is located in.

  • name - (Optional) Specifies the name of the shared Azure Portal Dashboard.

  • displayName - (Optional) Specifies the display name of the shared Azure Portal Dashboard.

Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:

  • id - The ID of the shared Azure Portal dashboard.

  • location - The Azure Region where the shared Azure Portal dashboard exists.

  • dashboardProperties - JSON data representing dashboard body.

  • tags - A mapping of tags assigned to the shared Azure Portal dashboard.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the shared Azure Dashboard.