azure_power_bi_app_dashboard Resource
Use the azure_power_bi_app_dashboard
InSpec audit resource to test the properties of an Azure Power BI app 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
describe azure_power_bi_app_dashboard(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID') do
it { should exist }
end
Parameters
app_id
(required)- The app ID.
dashboard_id
(required)- The app dashboard ID.
Properties
id
- The app 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 app dashboard is read-only
describe azure_power_bi_app_dashboard(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID') do
its('isReadOnly') { should eq true }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
exists
# If the Azure Power BI app dashboard is found, it will exist.
describe azure_power_bi_app_dashboard(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID') do
it { should exist }
end
not_exists
# if the Azure Power BI app dashboard is not found, it will not exist.
describe azure_power_bi_app_dashboard(app_id: 'APP_ID', dashboard_id: 'DASHBOARD_ID') do
it { should_not exist }
end
Azure Permissions
This API does not support service principal authentication. Instead, use the Active Directory (AD) account access token to access this resource.
Your AD account must be set up with a Dashboard.Read.All
role on the Azure Power BI workspace you wish to test.