azure_power_bi_app_reports resource

Use the azure_power_bi_app_reports InSpec audit resource to test the properties related to all Azure Power BI app reports.

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

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

Parameters

app_id (required)

The app ID.

Properties

ids

List of all app report IDs.

Field: id

embedUrls

List of all the report embed URLs.

Field: embedUrl

appIds

List of all the app IDs.

Field: appId

datasetIds

List of all the Dataset IDs.

Field: datasetId

names

List of all the report names.

Field: name

webUrls

List of all the report web URLs.

Field: webUrl

Examples

Loop through Power BI app reports by their IDs:

azure_power_bi_app_reports(app_id: 'APP_ID').ids.each do |id|
  describe azure_power_bi_app_report(app_id: 'APP_ID', report_id: id) do
    it { should exist }
  end
end

Test to filter out Power BI app reports by report name:

describe azure_power_bi_app_reports(app_id: 'APP_ID').where(name: 'REPORT_NAME') do
  it { should exist }
end

Matchers

This resource has the following special matchers.

exists

# Should not exist if no Power BI app reports are present.

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

not_exists

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

describe azure_power_bi_app_reports(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 Report.Read.All role on the Azure Power BI workspace you wish to test.