azure_hpc_storage_targets resource

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

Note

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

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

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