Skip to main content

azure_power_bi_dashboard_tile resource

Use the azure_power_bi_dashboard_tile InSpec audit resource to test the properties related to an Azure Power BI dashboard tile.

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

describe azure_power_bi_dashboard_tile(group_id: 'GROUP_ID', dashboard_id: 'dashboard_ID', title_id: 'TITLE_ID') do
  it  { should exist }
end

Parameters

dashboard_id (required)

The dashboard ID.

tile_id (required)

The tile ID.

group_id (optional)

The workspace ID.

Properties

id
Power BI dashboard tile ID.
title
The dashboard display name.
embedUrl
The tile embed URL.
rowSpan
The number of rows a tile should span.
colSpan
The number of columns a tile should span.
reportId
The report ID available only for tiles created from a report.
datasetId
The dataset ID available only for tiles created from a report or using a dataset, such as Q&A tiles.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, see the Azure documentation for other available properties.

Examples

Test that the Power BI dashboard tile is on the left corner:

describe azure_power_bi_dashboard_tile(group_id: 'GROUP_ID', dashboard_id: 'dashboard_ID', title_id: 'TITLE_ID')  do
  its('rowSpan') { should eq 0 }
end

Matchers

For a full list of available matchers, see 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_tile(group_id: 'GROUP_ID', dashboard_id: 'dashboard_ID', title_id: 'TITLE_ID')  do
  it { should 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_tile(group_id: 'GROUP_ID', dashboard_id: 'dashboard_ID', title_id: 'TITLE_ID')  do
  it { should_not exist }
end

Azure permissions

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

Thank you for your feedback!

×