azure_power_bi_dashboard_tile Resource

[edit on GitHub]

Use the azure_power_bi_dashboard_tile InSpec audit resource to test the properties related to 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. 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

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

number of rows a tile should span.

colSpan

number of columns a tile should span.

reportId

The report ID, which is available only for tiles created from a report.

datasetId

The dataset ID, which is 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, refer to Azure documentation for other properties available.

Examples

Test that the Power BI dashboard tile is on 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

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_tile(group_id: 'GROUP_ID', dashboard_id: 'dashboard_ID', title_id: 'TITLE_ID')  do
  it { should 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_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 be set up with a dashboard.Read.All role on the Azure Power BI Workspace you wish to test.