azure_data_factory_pipelines Resource
Use the azure_data_factory_pipelines
InSpec audit resource to test the properties related to a 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, the 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 information, Azure pipeline Docs
.
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
An azure_data_factory_pipelines
resource block returns all Azure pipelines, either within a resource group (if provided) or an entire subscription.
describe azure_data_factory_pipelines(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME') do
#...
end
resource_group
and factory_name
are required parameters.
Parameters
resource_group
- Azure resource group where the targeted resource resides.
factory_name
- Azure Factory Name for which pipeline is being retrieved.
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
Note
Examples
Test if any pipeline exists 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 are not any pipelines in a resource group
# Should not exist if no pipelines is in the resource group.
describe azure_data_factory_pipelines(resource_group: 'RESOURCE_GROUP', factory_name: 'FACTORY_NAME') 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.