azure_hpc_caches resource

Use the azure_hpc_caches InSpec audit resource to test the properties related to all Azure HPC Caches.

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_caches resource block returns all Azure HPC Caches.

describe azure_hpc_caches do
  #...
end

Parameters

resource_group (optional): Azure resource group where the targeted resource resides.

Properties

ids: A list of resource IDs.
Field: id
names: A list of HPC Cache names.
Field: name
types: A list of the HPC Cache types.
Field: type
properties: A list of Properties for all the HPC Caches.
Field: properties
locations: A list of the resource locations.
Field: location
cacheSizeGBs: A list of the sizes of the HPC Cache.
Field: cacheSizeGB
subnets: A list of subnets used for the HPC Cache.
Field: subnet

Note

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

Examples

Loop through HPC Caches by their names:

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

Test to ensure that there are provisioned HPC Caches:

describe azure_hpc_caches.where(provisioningState: 'SUCCEEDED') 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 Caches are present.

describe azure_hpc_caches do
  it { should_not exist }
end

not_exists

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

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