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. 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

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

For information on using filter criteria on plural resources, see the documentation on FilterTable

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.