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

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

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

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