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.
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
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
Note
Also, refer to Azure documentation for other properties available.
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
For a full list of available matchers, see our Universal Matchers page.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 be set up with a dashboard.Read.All
role on the Azure Power BI Workspace you wish to test.