azure_data_factory resource

Use the azure_data_factory InSpec audit resource to test the properties of an Azure Data Factory.

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 Data Factory name are required parameters.

describe azure_data_factory(resource_group: RESOURCE_GROUP, name: NAME) do
  it { should exist }
  its('name') { should eq factory_name }
  its('type') { should eq 'Microsoft.DataFactory/factories' }
end

Parameters

resource_group

Azure resource group where the targeted resource resides.

name

The factory name.

Both the parameter sets need to be provided for a valid query: resource_group and name.

Properties

resource_group

Azure resource group that the targeted resource resides in.

name

Name of the Azure resource to test.

type

The resource type.

provisioning_state

The Data Factory provisioning state.

repo_configuration_type

The Git or VSTS repository configuration type.

repo_configuration_project_name

The VSTS repository project name.

repo_configuration_account_name

The Git or VSTS repository account name.

repo_configuration_repository_name

The Git or VSTS repository name.

repo_configuration_collaboration_branch

The Git or VSTS repository collaboration branch.

repo_configuration_root_folder

The Git or VSTS repository root folder.

repo_configuration_tenant_id

The VSTS tenant ID.

Examples

Test that a Data Factory exists:

describe azure_data_factory(resource_group: resource_group, name: 'DATA_FACTORY_NAME') do
  it { should exist }
end

Test that a Data Factory does not exist:

describe azure_data_factory(resource_group: resource_group, name: 'DATA_FACTORY_NAME') do
  it { should_not exist }
end

Test properties of a Data Factory:

describe azure_data_factory(resource_group: `RESOURCE_GROUP`, name: 'NAME') do
  its('repo_configuration_type') { should include REPO_CONFIGURATION_TYPE }
  its('repo_configuration_project_name') { should include REPO_CONFIGURATION_PROJECT_NAME }
  its('repo_configuration_account_name') { should include REPO_CONFIGURATION_ACCOUNT_NAME }
  its('repo_configuration_repository_name') { should include REPO_CONFIGURATION_REPOSITORY_NAME }
  its('repo_configuration_collaboration_branch') { should include REPO_CONFIGURATION_COLLABORATION_BRANCH }
  its('repo_configuration_root_folder') { should include REPO_CONFIGURATION_ROOT_FOLDER }
  its('repo_configuration_tenant_id') { should include REPO_CONFIGURATION_TENANT_ID }
end

Azure permissions

Your Service Principal must be set up with at least a contributor role on the subscription you wish to test.