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. 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

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, see the Azure documentation for other available properties.

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

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 have the Dashboard.Read.All role on the Azure Power BI Workspace you wish to test.