azure_power_bi_dashboard Resource
Use the azure_power_bi_dashboard
InSpec audit resource to test the properties related to Azure Power BI Dashboard.
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
dashboard_id
is a required parameter, and group_id
is an optional parameter.
describe azure_power_bi_dashboard(group_id: 'GROUP_ID', dashboard_id: 'dashboard_ID') do
it { should exist }
end
Parameters
dashboard_id
(required)The dashboard ID.
group_id
(optional)The workspace ID.
Properties
id
- Power BI dashboard ID.
displayName
- The dashboard display name.
embedUrl
- The dashboard embed URL.
isReadOnly
- Is ReadOnly dashboard.
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 Dashboard is read-only
describe azure_power_bi_dashboard(group_id: 'GROUP_ID', dashboard_id: 'DASHBOARD_ID') do
its('isReadOnly') { should eq 'true' }
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 exist if the Power BI dashboard is present in the group.
describe azure_power_bi_dashboard(group_id: 'GROUP_ID', dashboard_id: 'dashboard_ID') do
it { should exist }
end
not_exists
# Should not exist if the Power BI dashboard is not present in the group.
describe azure_power_bi_dashboard(group_id: 'GROUP_ID', dashboard_id: 'dashboard_ID') do
it { should_not 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.