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. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

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. You can access any attribute in the response 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

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.