azure_data_lake_storage_gen2_filesystems Resource

[edit on GitHub]

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

Also, refer to Azure documentation for other properties available.

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