azure_hpc_cache resource

Use the azure_hpc_cache InSpec audit resource to test the properties related to an Azure HPC Cache.

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

name, cache_name, and resource_group are required parameters.

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

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

Parameters

name (required)

Name of the Azure HPC Cache to test.

resource_group (required)

Azure resource group where the targeted resource resides.

Properties

id

Resource ID of the HPC Cache.

name

Name of the HPC Cache.

type

Type of the HPC Cache, Microsoft.StorageCache/Cache.

location

Region name string.

properties

The properties of the HPC Cache.

properties.cacheSizeGB

The size of this HPC Cache (in GB).

properties.subnet

The subnet used for the HPC Cache.

properties.health

Health of the HPC Cache.

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

Also, see the Azure documentation for other available properties.

Examples

Test that the HPC Cache is provisioned:

describe azure_hpc_cache(resource_group: 'RESOURCE_GROUP', name: 'HPC_CACHE_NAME') do
  its('properties.provisioningState') { should eq 'Succeeded' }
end

Matchers

This resource has the following special matchers.

exists

# If an HPC Cache is found, it will exist.

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

not_exists

# If an HPC Cache is not found, it will not exist.

describe azure_hpc_cache(resource_group: 'RESOURCE_GROUP', name: 'HPC_CACHE_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.