azure_power_bi_app_dashboard_tile resource

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

app_id, dashboard_id, and tile_id are required parameters.

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, see the Azure documentation for other available properties.

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

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

not_exists

# 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 have the Dashboard.Read.All role on the Azure Power BI workspace you wish to test.