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.
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.
Install
This resource is available in the Chef InSpec Azure resource pack.
For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.
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, refer to Azure documentation for other properties available.
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
This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.
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 be set up with a Dataflow.Read.All
role on the Azure Power BI dataflow you wish to test.