azure_hpc_storage_target Resource

[edit on GitHub]

Use the azure_hpc_storage_target InSpec audit resource to test the properties related to an Azure HPC Storage Target.

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

name, cache_name, and resource_group are required parameters.

describe azure_hpc_storage_target(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME', name: 'HPC_STORAGE_TARGET_NAME') do
  it                                      { should exist }
  its('type')                             { should eq 'Microsoft.StorageCache/Cache/StorageTarget' }
  its('location')                         { should eq 'East US' }
end

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

Parameters

name (required)

Name of the Azure HPC Storage Targets to test.

resource_group (required)

Azure resource group where the targeted resource resides.

cache_name (required)

Azure HPC Cache name.

Properties

id

Resource ID of the Storage Target.

name

Name of the Storage Target.

type

Resource type.

location

Region name string.

properties

The properties of the HPC Storage Target.

properties.blobNfs

The properties when the targetType is blobNfs.

properties.state

The storage target operational state.

properties.nfs3

Properties when the targetType is nfs3.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available.

Examples

Test that the HPC Storage Target is ready

describe azure_hpc_storage_target(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME', name: 'HPC_STORAGE_TARGET_NAME') do
  its('properties.state') { should eq 'Ready' }
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

# If an HPC Storage Target is found, it will exist.

describe azure_hpc_storage_target(resource_group: 'RESOURCE_GROUP', cache_name: 'HPC_CACHE_NAME', name: 'HPC_STORAGE_TARGET_NAME') do
  it { should exist }

not_exists

# if HPC Storage Target is not found, it will not exist.

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

Azure Permissions

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