azure_power_bi_dataflow resource

Use the azure_power_bi_dataflow InSpec audit resource to test the properties of a single Azure Power BI dataflow.

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_dataflow(group_id: 'GROUP_ID', name: 'DATAFLOW_ID') do
  it  { should exist }
end

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

Parameters

name (required)

The dataflow ID.

group_id (required)

The workspace ID.

Properties

name

The dataflow name.

objectId

The dataflow ID.

description

The dataflow description.

modelUrl

A URL to the dataflow definition file (model.json).

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 dataflow name exists:

describe azure_power_bi_dataflow(group_id: 'GROUP_ID', name: 'DATAFLOW_ID')  do
  it { should exist }
  its('name') { should eq 'DATAFLOW_NAME' }
end

Matchers

exists

Use should to test that the entity exists.

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

not_exists

Use should_not to test if the entity does not exist.

describe azure_power_bi_dataflow(group_id: 'GROUP_ID', name: 'DATAFLOW_ID')  do
  it { should_not exist }
end

Azure permissions

Your service principal must have the Dataflow.Read.All role on the Azure Power BI dataflow you wish to test.