azure_data_factory_linked_service Resource

[edit on GitHub]

Use the azure_data_factory_linked_service InSpec audit resource to test the properties of an Azure Linked service.

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.

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

resource_group, linked_service_name, and factory_name are required parameters.

describe azure_data_factory_linked_service(resource_group: `RESOURCE_GROUP`, factory_name: `FACTORY_NAME`, linked_service_name: `LINKED_SERVICE_NAME`) do
end

Parameters

resource_group

Azure resource group that the targeted resource resides in.

factory_name

The factory name.

linked_service_name

The name of the linked service.

All the parameter sets are required for a valid query:

• resource_group , factory_name, and linked_service_name.

Properties

name

Name of the Azure resource to test.

type

The resource type.

linked_service_type

The linked services type.

type_properties

The properties of linked service type.

properties

The properties of the resource.

Examples

Test that a Linked Service exists.

describe azure_data_factory_linked_service(resource_group: `RESOURCE_GROUP`, factory_name: `FACTORY_NAME`, linked_service_name: `LINKED_SERVICE_NAME`) do
  it { should exist }
end

Test that a linked service does not exist.

describe azure_data_factory_linked_service(resource_group: `RESOURCE_GROUP`, factory_name: `FACTORY_NAME`, linked_service_name: 'should not exit') do
  it { should_not exist }
end

Test properties of a linked service.

describe azure_data_factory_linked_service(resource_group: `RESOURCE_GROUP`, name: 'FACTORY_NAME') do
  its('name') { should eq linked_service_name1 }
  its('type') { should eq 'Microsoft.DataFactory/factories/linkedservices' }
  its('linked_service_type') { should eq 'MYSQL' }
end

Azure Permissions

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