Dashboards

Dashboards let you configure reusable widget layouts to visualize catalog, system, and operational insights.

Below is the sample resource definition file for Dashboard:

{
  "rDashboard": {
    "Type": "Dashboard",
    "Properties": {
      "DashboardName": "cicd_test_dashboard",
      "DashboardDescription": "Base dashboard for CICD QA testing",
      "Widgets": [
        {
          "RefId": "2bb8wjs5nx8",
          "WidgetId": "W_CatalogSearch",
          "Version": "1.0.0",
          "WidgetServiceCategory": "Generic",
          "Configuration": {
            "Layout": {
              "w": 3,
              "h": 2,
              "x": 0,
              "y": 0,
              "i": "2bb8wjs5nx8",
              "minW": 3,
              "maxW": 3,
              "minH": 2,
              "maxH": 2,
              "moved": false,
              "static": false
            },
            "Title": {
              "Value": "Catalog Search"
            },
            "Description": {
              "Value": "Search for amorphic resources in the catalog"
            },
            "RefreshInterval": {
              "Value": "3600"
            },
            "DisplayType": {
              "Value": "search"
            },
            "Size": {}
          }
        },
        {
          "RefId": "z82hsuexgwe",
          "WidgetId": "W_HighCostingResources",
          "Version": "1.0.1",
          "WidgetServiceCategory": "Management",
          "Configuration": {
            "Layout": {
              "w": 1,
              "h": 2,
              "x": 1,
              "y": 2,
              "i": "z82hsuexgwe",
              "minW": 1,
              "maxW": 2,
              "minH": 2,
              "maxH": 2,
              "moved": false,
              "static": false
            },
            "Title": {
              "Value": "High Costing Resources"
            },
            "Description": {
              "Value": "List of all high costing resources in the application"
            },
            "RefreshInterval": {
              "Value": "0"
            },
            "Size": {
              "Value": "small"
            }
          }
        }
      ]
    }
  }
}

Note: Deployment dependencies

Dashboard has dependencies on Tag.

Dependent resources should not be deleted before the primary resource; attempting to do so may lead to failures or inconsistencies during the deletion process.

Referencing this Resource

Below are the common keys that can be used in the DependsOn function to retrieve details of this resource.

Supported Keys

Key	Description
DashboardName	Returns the DashboardName value of this resource
DashboardId	Returns the DashboardId value of this resource

For additional supported keys, refer to the API definition document for the respective resource type.

Example

To reference this schedule from another resource, use !DependsOn with logical name and property in the format <logicalResourceName>.<PropertyName>.

Example: {"!DependsOn": "rDashboard.DashboardId"}