azure_power_bi_app_dashboard_tiles Resource

[edit on GitHub]

Use the azure_power_bi_app_dashboard_tiles InSpec audit resource to test the properties related to all Azure Power BI App dashboard tiles.

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_app_dashboard_tiles resource block returns all Azure Power BI App dashboard tiles.

describe azure_power_bi_app_dashboard_tiles(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID') do
  #...
end

Parameters

app_id (required)

The app ID.

dashboard_id (required)

The App Dashboard ID.

Properties

ids

List of all App dashboard tile IDs.

Field: id

titles

List of all the dashboard title.

Field: title

embedUrls

List of all the dashboard embed urls.

Field: embedUrl

rowSpans

List of all the row span values.

Field: rowSpan

colSpans

List of all the col span values.

Field: colSpan

reportIds

List of all the report IDs.

Field: reportId

datasetIds

List of all the dataset IDs.

Field: datasetId

Also, refer to Azure documentation for other properties available.

Examples

Loop through Power BI App dashboard tiles by their IDs.

azure_power_bi_app_dashboard_tiles(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID').ids.each do |id|
  describe azure_power_bi_app_dashboard_tile(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID', tile_id: id) do
    it { should exist }
  end
end

Test to filter out Power BI App dashboard tiles that are in left corner.

describe azure_power_bi_app_dashboard_tiles(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID').where(rowSpan: 0, colSpan: 0) 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 that an entity exists.

describe azure_power_bi_app_dashboard_tiles(app_id: 'APP_ID') do
  it { should_not exist }
end

Use should_not to test that the entity does not exist.

describe azure_power_bi_app_dashboard_tiles(app_id: 'APP_ID') do
  it { should 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.