azure_data_lake_storage_gen2_paths Resource

[edit on GitHub]

Use the azure_data_lake_storage_gen2_paths InSpec audit resource to test the properties related to all Azure Data Lake Storage Gen2 Filesystem paths within a project.

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

An azure_data_lake_storage_gen2_paths resource block returns all Azure Data Lake Storage Gen2 Filesystem paths within a project.

describe azure_data_lake_storage_gen2_paths(account_name: 'ACCOUNT_NAME', filesystem: 'ADLS FILESYSTEM') do
  #...
end

Parameters

account_name (required)

The Azure Storage account name.

filesystem (required)

The filesystem identifier.

dns_suffix (optional)

The DNS suffix for the Azure Data Lake Storage endpoint.

Properties

names

Unique names for all the paths in the Filesystem.

Field: name

lastModifieds

Last modified timestamps of all the paths in the Filesystem.

Field: lastModified

eTags

A list of eTags for all the paths in the Filesystem.

Field: eTag

contentLengths

A list of Content-Length of all the paths in the Filesystem.

Field: contentLength

Also, refer to Azure documentation for other properties available.

Examples

Loop through Data Lake Storage Gen2 Filesystem paths by their names

azure_data_lake_storage_gen2_paths(account_name: 'ACCOUNT_NAME', filesystem: 'ADLS FILESYSTEM').names.each do |name|
  describe azure_data_lake_storage_gen2_path(account_name: 'ACCOUNT_NAME', filesystem: 'ADLS FILESYSTEM', name: name) do
    it { should exist }
  end
end

Test to ensure Data Lake Storage Gen2 Filesystem paths with file size greater than 2 MB

describe azure_data_lake_storage_gen2_paths(account_name: 'ACCOUNT_NAME', filesystem: 'ADLS FILESYSTEM').where{ contentLength > 2097152 } do
  it { should exist }
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

exists

# Should not exist if no Data Lake Storage Gen2 Filesystems are present in the project and in the resource group.

describe azure_data_lake_storage_gen2_paths(account_name: 'ACCOUNT_NAME', filesystem: 'ADLS FILESYSTEM') do
  it { should_not exist }
end

not_exists

# Should exist if the filter returns at least one Migrate Assessment in the project and in the resource group.

describe azure_data_lake_storage_gen2_paths(account_name: 'ACCOUNT_NAME', filesystem: 'ADLS FILESYSTEM') do
  it { should exist }
end

Azure Permissions

Your Service Principal must be set up with a contributor role on the subscription and Storage Blob Data Contributor role on the ADLS Gen2 Storage Account you wish to test.