azure_power_bi_dashboard

Use the azure_power_bi_dashboard_tiles InSpec audit resource to test the properties related to all Azure Power BI dashboard tiles within a project.

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

An azure_power_bi_dashboard_tiles resource block returns all Azure Power BI dashboard tiles within a dashboard and a group.

describe azure_power_bi_dashboard_tiles(dashboard_id: 'dashboard_ID') do
  #...
end

describe azure_power_bi_dashboard_tiles(group_id: 'GROUP_ID') do
  #...
end

Parameters

group_id (required): The workspace ID.
dashboard_id (optional): The dashboard ID.

Properties

ids: List of all dashboard IDs.
Field: id
titles: List of all the titles.
Field: title
embedUrls: List of all dashboard embed URLs.
Field: embedUrl
rowSpans: List of all row spans.
Field: rowSpan
colSpans: List of all col spans.
Field: colSpan
reportIds: List of all report IDs.
Field: reportId
datasetIds: List of all dataset IDs.
Field: datasetId

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

Also, see the Azure documentation for other available properties.

Examples

Loop through Power BI dashboard tiles by their IDs:

azure_power_bi_dashboard_tiles.ids.each do |id|
  describe azure_power_bi_dashboard_tile(dashboard_id: id) do
    it { should exist }
  end
end

Test to ensure all Power BI dashboard tiles that are in the top left corner:

describe azure_power_bi_dashboard_tiles.where(rowSpan: true) do
  it { should exist }
end

Matchers

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

exists

# Use should to test for an Azure Power BI dashboard tile that should be in the resource group.

describe azure_power_bi_dashboard_tiles do
  it { should_not exist }
end

not_exists

# Use should_not to test for an Azure Power BI dashboard tile that should not be in the resource group.

describe azure_power_bi_dashboard_tiles do
  it { should exist }
end

Azure permissions

Your service principal must have the dashboard.Read.All role on the Azure Power BI Workspace you wish to test.

azure_power_bi_dashboard_tiles resource