azure_data_factory_pipeline resource

Use the azure_data_factory_pipeline InSpec audit resource to test the 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. 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

resource_group and pipeline_name, or factory_name are required 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 where the targeted resource resides.

factory_name

Data factory name where you want to create your pipeline.

pipeline_name

The pipeline name.

All the parameter sets need to 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.