azure_power_bi_dashboards resource

Use the azure_power_bi_dashboards InSpec audit resource to test the properties related to all AzurePower BI Dashboards within a project.

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_dashboards resource block returns all AzurePower BI Dashboards within a group.

describe azure_power_bi_dashboards do
  #...
end

describe azure_power_bi_dashboards(group_id: 'GROUP_ID') do
  #...
end

Parameters

group_id (optional)

The workspace ID.

Properties

ids

List of all dashboard IDs.

Field: id

displayNames

List of all the dashboard display names.

Field: displayName

embedUrls

List of all dashboard embed URLs.

Field: embedUrl

isReadOnly

List of all read-only dashboards.

Field: isReadOnlies

Also, see the Azure documentation for other available properties.

Examples

Loop throughPower BI Dashboards by their IDs:

azure_power_bi_dashboards.ids.each do |id|
  describe azure_power_bi_dashboard(dashboard_id: id) do
    it { should exist }
  end
end

Test to ensure all Power BI dashboards are ready-only:

describe azure_power_bi_dashboards.where(isReadOnly: true) do
  it { should exist }
end

Matchers

This resource has the following special matchers.

exists

# Should not exist if no Power BI dashboards are present in the group.

describe azure_power_bi_dashboards do
  it { should_not exist }
end

# Should exist if the filter returns at least one Power BI dashboard in the group.

describe azure_power_bi_dashboards do
  it { should exist }
end

Azure permissions

Your service principal must have the dashboard.Read.All role on the Azure Power BI Workspace you wish to test.