azure_power_bi_app_dashboards resource

Use the azure_power_bi_app_dashboards InSpec audit resource to test the properties of all Azure Power BI app dashboards.

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_dashboards resource block returns all Azure Power BI app dashboards.

describe azure_power_bi_app_dashboards(app_id: 'APP_ID') do
  #...
end

Parameters

app_id (required)

The app ID.

Properties

ids

List of all app IDs.

Field: id

displayNames

List of all the dashboard display names.

Field: displayName

embedUrls

List of all the dashboard embed URLs.

Field: embedUrl

isReadOnlies

List of all the boolean read-only dashboard flags.

Field: isReadOnly

Examples

Loop through Power BI app dashboards by their IDs:

azure_power_bi_app_dashboards(app_id: 'APP_ID').ids.each do |id|
  describe azure_power_bi_app_dashboard(app_id: 'APP_ID', dashboard_id: id) do
    it { should exist }
  end
end

Test to filter out Power BI app dashboards that are read-only:

describe azure_power_bi_app_dashboards(app_id: 'APP_ID').where(isReadOnly: true) do
  it { should exist }
end

Matchers

This resource has the following special matchers.

exists

# Should not exist if no Power BI apps are present.

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

not_exists

# Should exist if the filter returns at least one Power BI app.

describe azure_power_bi_app_dashboards(app_id: 'APP_ID') do
  it { should exist }
end

Azure permissions

This API does not support service principal authentication. Instead, use the Active Directory (AD) account access token to access this resource. Your AD account must have the Dashboard.Read.All role on the Azure Power BI workspace you wish to test.