azure_power_bi_app_reports Resource

[edit on GitHub]

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

Also, refer to Azure documentation for other properties available.

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 InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

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 be set up with a Report.Read.All role on the Azure Power BI workspace you wish to test.