azure_data_lake_storage_gen2_filesystems resource

Use the azure_data_lake_storage_gen2_filesystems InSpec audit resource to test the properties related to all Azure Data Lake Storage Gen2 Filesystems 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_filesystems resource block returns all Azure Data Lake Storage Gen2 filesystems within a project.

describe azure_data_lake_storage_gen2_filesystems(account_name: 'ACCOUNT_NAME') do
  #...
end

Parameters

account_name (required)

The Azure Storage account name.

dns_suffix (optional)

The DNS suffix for the Azure Data Lake Storage endpoint.

Properties

names

Unique names for all Azure Storage Account Filesystems.

Field: name

lastModifieds

Last modified timestamps of Azure Storage Account Filesystem.

Field: lastModified

eTags

A list of eTags for all the Azure Storage Account Filesystems.

Field: eTag

DefaultEncryptionScopes

A list of all Encryption scopes of the ADLS Filesystems.

Field: DefaultEncryptionScope

DenyEncryptionScopeOverrides

A list of all Deny Encryption Scope Overrides.

Field: DenyEncryptionScopeOverrides

Examples

Loop through Data Lake Storage Gen2 Filesystems by their names and verify that each exists:

azure_data_lake_storage_gen2_filesystems(account_name: 'ACCOUNT_NAME').names.each do |name|
  describe azure_data_lake_storage_gen2_filesystem(account_name: 'ACCOUNT_NAME', name: name) do
    it { should exist }
  end
end

Test To ensure Data Lake Storage Gen2 Filesystems With :‘$account-encryption-key’ encryption scope

describe azure_data_lake_storage_gen2_filesystems(account_name: 'ACCOUNT_NAME').where(DefaultEncryptionScope: '$account-encryption-key') do
  it { should exist }
end

Matchers

This resource has the following special matchers.

exists

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

describe azure_data_lake_storage_gen2_filesystems(account_name: 'ACCOUNT_NAME') do
  it { should_not exist }
end

not_exists

# Should exist if the filter returns at least one Data Lake Storage Gen2 filesystem in the project and the resource group.

describe azure_data_lake_storage_gen2_filesystems(account_name: 'ACCOUNT_NAME') do
  it { should exist }
end

Azure permissions

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