azure_power_bi_dataset Resource

[edit on GitHub]

Use the azure_power_bi_dataset InSpec audit resource to test the properties related to Azure Power BI dataset.

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

describe azure_power_bi_dataset(name: 'DATASET_ID') do
  it  { should exist }
end

describe azure_power_bi_dataset(group_id: 'GROUP_ID', name: 'DATASET_ID')  do
  it  { should exist }
end

Parameters

name (required)

The dataset ID.

group_id (optional)

The workspace ID.

Properties

name

The dataset name.

addRowsAPIEnabled

Whether the dataset allows adding new rows.

configuredBy

The dataset owner.

isRefreshable

Can this dataset be refreshed.

isEffectiveIdentityRequired

Whether the dataset requires an effective identity. This indicates that you must send an effective identity using the GenerateToken API.

isEffectiveIdentityRolesRequired

Whether RLS is defined inside the PBIX file. This indicates that you must specify a role.

isOnPremGatewayRequired

dataset requires an On-premises Data Gateway.

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 dataset requires an on-prem gateway.

describe azure_power_bi_dataset(name: 'DATASET_ID')  do
  it { should exist }
  its('IsOnPremGatewayRequired') { should eq true }
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

# If the Power BI dataset is found, it will exist
describe azure_power_bi_dataset(name: 'DATASET_ID')  do
  it { should exist }
end
# if the Power BI dataset is not found, it will not exist
describe azure_power_bi_dataset(name: 'DATASET_ID')  do
  it { should_not exist }
end

Azure Permissions

Your Service Principal must be set up with a Dataset.Read.All role on the Azure Power BI dataset you wish to test.