azure_snapshot Resource
Use the azure_snapshot
InSpec audit resource to test the properties and configuration of an Azure snapshot.
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
resource_group
and name
are required parameters.
describe azure_snapshot(resource_group: 'RESOURCE_GROUP', name: 'SNAPSHOT_NAME') do
it { should exist }
end
Parameters
resource_group
(required)- Azure resource group where the targeted resource resides.
name
(required)- The name of the snapshot that is being created.
Properties
id
- The id of the snapshot.
name
- The name of the snapshot.
type
- The type of the snapshot.
location
- The location of the snapshot.
properties
- The properties of the snapshot.
sku
- The sku of the snapshot.
For properties applicable to all resources, such as type
, name
, id
, and properties
, refer to azure_generic_resource
.
See the Azure documentation for other available properties.
Any attribute in the response may be accessed with the key names separated by dots (.
). For example, properties.<attribute>
.
Examples
Test if a snapshot is referenced with a valid name
describe azure_snapshot(resource_group: 'RESOURCE_GROUP', name: 'SNAPSHOT_NAME') do
it { should exist }
end
Test if a snapshot is referenced with an invalid name
describe azure_snapshot(resource_group: 'RESOURCE_GROUP', name: 'SNAPSHOT_NAME') do
it { should_not exist }
end
Test if a snapshot has the `Windows’ operating system type
describe azure_snapshot(resource_group: 'RESOURCE_GROUP', name: 'SNAPSHOT_NAME') do
its('properties.osType') { should cmp 'Windows' }
end
Test if the snapshot has a valid disk size
describe azure_snapshot(resource_group: 'RESOURCE_GROUP', name: 'SNAPSHOT_NAME') do
its('properties.diskSizeGB') { should cmp 127 }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
exists
Use should exist
to test for a resource that should exist.
describe azure_snapshot(resource_group: 'RESOURCE_GROUP', name: 'SNAPSHOT_NAME') do
it { should exist }
end
Use should_not exist
to test for a resource that should not exist.
describe azure_snapshot(resource_group: 'RESOURCE_GROUP', name: 'SNAPSHOT_NAME') 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.