azure_data_factory_pipeline_run

Use the azure_data_factory_pipeline_run_resource InSpec audit resource to test the properties of an Azure Data Factory pipeline run.

For additional information, see the Azure API documentation on Data Factory pipeline runs.

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_data_factory_pipeline_run_resource(resource_group: `RESOURCE_GROUP`, factory_name: `FACTORY_NAME`, run_id: `RUN_ID`) do
  #...
end

Parameters

resource_group (required): Azure resource group where the targeted resource resides.
factory_name (required): The factory name.
run_id (required): The name of the pipeline runs.

Properties

invokedBy.name: The unique resource names.
pipelineName: The pipeline name.
status: The status of a pipeline run.
runId: Identifiers of a run.
runStart: Start time of a pipeline run in ISO8601 format.
runEnd: End time of a pipeline run in ISO8601 format.
runStart: The properties of the resource.

Examples

Test properties of a pipeline runs

describe azure_data_factory_pipeline_run_resource(resource_group: `RESOURCE_GROUP`, name: 'FACTORY_NAME', run_id: `RUN_ID`) do
  its('invokedBy.name') { should include 'INVOKED_BY_NAME' }
  its('pipelineNames') { should include 'PIPELINE_NAME' }
  its('status') { should include 'PIPELINE_STATUS' }
end

Matchers

Test that a pipeline runs exists

describe azure_data_factory_pipeline_run_resource(resource_group: `RESOURCE_GROUP`, factory_name: `FACTORY_NAME`, run_id: `RUN_ID`) do
  it { should exist }
end

Test that a pipeline runs does not exist

describe azure_data_factory_pipeline_run_resource(resource_group: `RESOURCE_GROUP`, factory_name: `FACTORY_NAME`, run_id: 'RUN_ID') 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.

azure_data_factory_pipeline_run_resource Resource