azure_power_bi_app_report resource

Use the azure_power_bi_app_report InSpec audit resource to test the properties related to an Azure Power BI app report.

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

describe azure_power_bi_app_report(app_id: 'APP_ID', report_id: 'REPORT_ID') do
  it  { should exist }
end

Parameters

app_id (required)

The app ID.

report_id (required)

The app report ID.

Properties

id

The report ID.

appId

The app ID.

embedUrl

The report embed URL.

datasetId

The dataset ID.

name

The report name.

webUrl

The report web URL.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, see the Azure documentation for other available properties.

Examples

Test that the Power BI app report is paginated and embed URL is present:

describe azure_power_bi_app_report(app_id: 'APP_ID', report_id: 'REPORT_ID')  do
  its('reportType') { should eq 'PaginatedReport' }
  its('embedUrl') { should_not be_empty }
end

Matchers

This resource has the following special matchers.

exists

Use should to test that the entity exists.

describe azure_power_bi_app_report(app_id: 'APP_ID', report_id: 'REPORT_ID')  do
  it { should exist }
end

not_exists

Use should_not to test that the entity does not exist.

describe azure_power_bi_app_report(app_id: 'APP_ID', report_id: 'REPORT_ID')  do
  it { should_not 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.