azure_snapshots Resource
Use the azure_snapshots
InSpec audit resource to test the properties and configurations of multiple Azure snapshots.
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
describe azure_snapshots do
it { should exist }
end
Parameters
No required parameters.
Properties
ids
- The id of the snapshot.
Field:
id
names
- The name of the snapshot.
Field:
name
types
- The type of the snapshot.
Field:
type
locations
- The location of the snapshot.
Field:
location
properties
- The properties of the snapshot.
Field:
properties
skus
- The sku of the snapshot.
Field:
sku
Note
See the Azure documentation for other available properties.
Examples
Test if a snapshot has a valid type
describe azure_snapshots do
its('types') { should cmp 'Microsoft.Compute/snapshots' }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
exists
The control passes if the filter returns at least one result. Use should_not
if you expect zero matches.
Use should exist
to test that a resource exists.
describe azure_snapshots do
it { should exist }
end
Use should_not exist
to test that resources do not exist.
describe azure_snapshots do
it { should_not exist }
end
Azure Permissions
Your Service Principal must be set up with at least a contributor
role on the subscription you wish to test.