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.
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.
Install
This resource is available in the Chef InSpec Azure resource pack.
For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.
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
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.