azure_power_bi_dashboard_tiles Resource

[edit on GitHub]

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. The api_version can be defined as a resource parameter. If not provided, this resource uses the latest version. For more information, refer to the azure_generic_resource document.

Unless defined, this resource uses the azure_cloud global endpoint and default values for the HTTP client. For more information, refer to the resource pack README.

Installation

This resource is available in the Chef InSpec Azure resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.

Syntax

An azure_power_bi_dashboard_tiles resource block returns all Azure Power BI dashboard tiles within 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

Also, refer to Azure documentation for other properties available.

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 top left corner.

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

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

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

# 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 be set up with a dashboard.Read.All role on the Azure Power BI Workspace you wish to test.