azure_power_bi_dataset resource

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

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

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

exists

# If the Power BI dataset is found, it will exist.

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

not_exists

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