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.
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.
Install
This resource is available in the Chef InSpec Azure resource pack.
For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.
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, refer to Azure documentation for other properties available.
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
For a full list of available matchers, see our Universal Matchers page.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 be set up with a Report.Read.All
role on the Azure Power BI workspace you wish to test.