azure_data_factory_datasets Resource

[edit on GitHub]

Use the azure_data_factory_datasets InSpec audit resource to test the properties of multiple Azure Data Factory datasets for a resource group or the entire subscription.

See the Azure Data Factories Dataset documentation for additional information.

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_data_factory_datasets resource block returns all Azure datasets, either within a resource group (if provided) or within an entire Subscription.

describe azure_data_factory_datasets(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME') do
  #...
end

Parameters

resource_group (required)

Azure resource group where the targeted resource resides.

factory_name (required)

The Azure Data factory name.

Properties

names

A list of the unique resource names.

Field: name

ids

A list of dataset IDs.

Field: id

properties

A list of properties for the resources.

Field: properties

types

A list of types for each resource.

Field: type

descriptions

A list of descriptions of the resources.

Field: description

linkedServiceName_referenceNames

The list of linked service names.

Field: linkedServiceName_referenceName

linkedServiceName_types

The list of linked service types.

Field: linkedServiceName_type

Examples

Test to ensure if properties match

describe azure_data_factory_datasetsazure_data_factory_datasets(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME') do
  its('names') { should include 'DATASET_NAME' }
  its('types') { should include 'Microsoft.SecurityInsights/alertRules' }
  its('enableds') { should include 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.

Test to ensure if any dataset exists in the data factory

describe azure_data_factory_datasetsazure_data_factory_datasets(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME') do
  it { should exist }
end

Test to ensure there are not any datasets in a data factory

# Should not exist if no datasets are in the data factory

describe azure_data_factory_datasetsazure_data_factory_datasets(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME') do
  it { should_not exist }
end

Azure Permissions

Your Service Principal must be set up with at least a contributor role on the subscription you wish to test.