azure_power_bi_apps Resource

[edit on GitHub]

Use the azure_power_bi_apps InSpec audit resource to test the properties related to all Azure Power BI apps.

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_apps resource block returns all Azure Power BI apps.

describe azure_power_bi_apps do
  #...
end

Parameters

This resource does not require any parameters.

Properties

ids

List of all app IDs.

Field: id

names

List of all the app names.

Field: name

descriptions

List of all the app Descriptions.

Field: description

lastUpdates

List of all Last updated times of the apps.

Field: lastUpdate

Also, refer to Azure documentation for other properties available.

Examples

Loop through Power BI apps by their IDs.

azure_power_bi_apps.ids.each do |id|
  describe azure_power_bi_app(app_id: id) do
    it { should exist }
  end
end

Test that a Power BI app named “Finance” exists.

describe azure_power_bi_apps.where(name: 'Finance') 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_apps do
  it { should_not exist }
end
# Should exist if the filter returns at least one Power BI apps

describe azure_power_bi_apps do
  it { should exist }
end

Azure Permissions

This API does not support Service Principal Authentication. Use your Active Directory account access tokens to access this resource. Your Active Directory account must be set up with an App.Read.All role on the Azure Power BI workspace you wish to test.