azure_power_bi_app_dashboard

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. 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

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 titles.
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

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

Also, see the Azure documentation for other available properties.

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 the 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

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

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

not_exists

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

azure_power_bi_app_dashboard_tiles resource