azure_data_factory_pipelines Resource

[edit on GitHub]

Use the azure_data_factory_pipelines InSpec audit resource to test properties related to pipeline for a resource group or the entire subscription.

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, the latest version will be used. For more information, refer to azure_generic_resource.

Unless defined, azure_cloud global endpoint, and default values for the HTTP client will be used. For more information, refer to the resource pack README. For api related info : Azure pipeline Docs.

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

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

resource_group and factory_name must be given as parameters.

Parameters

resource_group

Azure resource group that the targeted resource resides in.

factory_name

Azure Factory Name for which pipeline are being retrived.

Properties

names

A list of the unique resource names.

Field: name

ids

A list of pipeline IDs .

Field: id

properties

A list of properties for the resource.

Field: properties

Examples

Test If Any Pipeline Exist In The Resource Group.

describe azure_data_factory_pipelines(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME') do
  it { should exist }
  its('names') { should include 'pipeline_name' }
end

Test that there aren’t any pipeline in a resource group.

**Should not exist if no pipeline are in the resource group.**

describe azure_data_factory_pipelines(resource_group: 'example', factory_name: 'fake') 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.