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. 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

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