azure_data_factory_pipeline Resource

[edit on GitHub]

Use the azure_data_factory_pipeline InSpec audit resource to test properties of an Azure pipeline.

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

resource_group and pipeline_name, factory_name must be given as parameters.

describe azure_data_factory_pipeline(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME', pipeline_name: 'PIPELINE_NAME') do
  #...
end

Parameters

resource_group

Azure resource group that the targeted resource resides in. MyResourceGroup.

factory_name

Name for the data factory that you want to create your pipeline in..

pipeline_name

The pipeline name.

All the parameter sets needs be provided for a valid query:

• resource_group , factory_name and pipeline_name

Properties

name

Name of the Azure resource to test.

id

The pipeline type.

properties

The properties of the Resource.

Examples

Test That A Pipeline Exists.

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

Test That A Pipeline Does Not Exist.

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

Test Properties Of A Pipeline.

describe azure_data_factory_pipeline(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME', pipeline_name: 'PIPELINE_NAME') do
  its('name') { should eq 'PIPELINE_NAME' }
end

Azure Permissions

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