azure_data_factory_linked_service resource

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. 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, 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 where the targeted resource resides.
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.