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.
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
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, refer to Azure documentation for other properties available.
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
For a full list of available matchers, see our Universal Matchers page.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.