azure_data_lake_storage_gen2

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. 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

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

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

Also, see the Azure documentation for other available properties.

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

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

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 have the contributor role on the subscription and Storage Blob Data Contributor role on the ADLS Gen2 Storage Account you wish to test.

azure_data_lake_storage_gen2_paths resource