azure_hpc_storage_targets Resource

[edit on GitHub]

Use the azure_hpc_storage_targets InSpec audit resource to test the properties related to all Azure HPC Storage Targets.

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_hpc_storage_targets resource block returns all Azure HPC Storage Targets.

describe azure_hpc_storage_targets(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME') do
  #...
end

Parameters

resource_group (required)

Azure resource group where the targeted resource resides.

cache_name (required)

Azure HPC Cache name.

Properties

ids

A list of resource IDs.

Field: id

names

A list of resource Names.

Field: name

types

A list of the resource types.

Field: type

properties

A list of Properties for all the HPC Storage Targets.

Field: properties

locations

A list of the resource locations.

Field: location

targetTypes

A list of the types of storage target.

Field: targetType

states

A list of the operational state of the storage target.

Field: provisioningState

Examples

Loop through HPC Storage Targets by their names

azure_hpc_storage_targets(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME').names.each do |name|
  describe azure_hpc_storage_target(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME', name: name) do
    it { should exist }
  end
end

Test that there are HPC Storage Targets that are ready

describe azure_hpc_storage_targets(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME').where(state: 'Ready') 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 HPC Storage Targets are present.

describe azure_hpc_storage_targets(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME') do
  it { should_not exist }
end

not_exists

# Should exist if the filter returns at least one HPC Storage Targets.

describe azure_hpc_storage_targets(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME') do
  it { should exist }
end

Azure Permissions

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