azure_power_bi_app_dashboards Resource

[edit on GitHub]

Use the azure_power_bi_app_dashboards InSpec audit resource to test the properties of all Azure Power BI app dashboards.

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.

Installation

This resource is available in the Chef InSpec Azure resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.

Syntax

An azure_power_bi_app_dashboards resource block returns all Azure Power BI app dashboards.

describe azure_power_bi_app_dashboards(app_id: 'APP_ID') do
  #...
end

Parameters

app_id (required)

The app ID.

Properties

ids

List of all app IDs.

Field: id

displayNames

List of all the dashboard display name.

Field: displayName

embedUrls

List of all the dashboard embed url.

Field: embedUrl

isReadOnlies

List of all the boolean ReadOnly dashboard flags.

Field: isReadOnly

Also, refer to Azure documentation for other properties available.

Examples

Loop through Power BI app dashboards by their IDs.

azure_power_bi_app_dashboards(app_id: 'APP_ID').ids.each do |id|
  describe azure_power_bi_app_dashboard(app_id: 'APP_ID', dashboard_id: id) do
    it { should exist }
  end
end

Test to filter out Power BI app dashboards that are read only.

describe azure_power_bi_app_dashboards(app_id: 'APP_ID').where(isReadOnly: true) do
  it { should exist }
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 not exist if no Power BI apps are present

describe azure_power_bi_app_dashboards(app_id: 'APP_ID') do
  it { should_not exist }
end
# Should exist if the filter returns at least one Power BI apps

describe azure_power_bi_app_dashboards(app_id: 'APP_ID') do
  it { should 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.