azure_power_bi_app_dashboard_tile Resource

[edit on GitHub]

Use the azure_power_bi_app_dashboard_tile InSpec audit resource to test the properties related to Azure Power BI App 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

app_id, dashboard_id and tile_id is a required parameter.

describe azure_power_bi_app_dashboard_tile(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID', tile_id: 'TILE_ID') do
  it  { should exist }
end

Parameters

app_id (required)

The app ID.

dashboard_id (required)

The App Dashboard ID.

tile_id (required)

The App dashboard tile ID.

Properties

id

The 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 App dashboard tile is at the left corner.

describe azure_power_bi_app_dashboard_tile(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID', tile_id: 'TILE_ID')  do
  its('rowSpan') { should eq 0 }
  its('colSpan') { 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

# If the Azure Power BI App dashboard tile is found, it will exist
describe azure_power_bi_app_dashboard_tile(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID', tile_id: 'TILE_ID')  do
  it { should exist }
end
# if the Azure Power BI App dashboard tile is not found, it will not exist
describe azure_power_bi_app_dashboard_tile(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID', tile_id: 'TILE_ID')  do
  it { should_not exist }
end

Azure Permissions

This API does not support service principal authentication. Instead, use an Active Directory account access token to access this resource. Your Active Directory account must be set up with a Dashboard.Read.All role on the Azure Power BI workspace that you wish to test.