Skip to main content

azure_hpc_asc_operation Resource

Use the azure_hpc_asc_operation InSpec audit resource to test the properties related to an Azure HPC ASC Operation.

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_asc_operation(location: 'LOCATION', operation_id: 'OPERATION_ID') do
  it                                      { should exist }
  its('type')                             { should eq 'Microsoft.StorageCache/Cache/StorageTarget' }
  its('location')                         { should eq 'East US' }
end
describe azure_hpc_asc_operation(location: 'LOCATION', operation_id: 'OPERATION_ID') do
  it  { should exist }
end

Parameters

location (required)
The name of the region used to look up the operation.
operation_id (required)
The operation ID that uniquely identifies the asynchronous operation.

Properties

id
The operation ID.
name
The operation name.
startTime
The start time of the operation.
status
The status of the operation.
endTime
The end time of the operation.

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 ASC operation is succeeded

describe azure_hpc_asc_operation(location: 'LOCATION', operation_id: 'OPERATION_ID') do
  its('status') { 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 ASC Operation is found, it will exist.

describe azure_hpc_asc_operation(location: 'LOCATION', operation_id: 'OPERATION_ID') do
  it { should exist }
end

not_exists

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

describe azure_hpc_asc_operation(location: 'LOCATION', operation_id: 'OPERATION_ID') 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.

Edit this page on GitHub

Thank you for your feedback!

×