azure_virtual_machine_disk Resource

[edit on GitHub]

Use the azure_virtual_machine_disk InSpec audit resource to test properties and configuration of an Azure disk.

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.

Installation

This resource is available in the Chef InSpec Azure resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.

Syntax

resource_group and name or the resource_id must be given as a parameter.

describe azure_virtual_machine_disk(resource_group: 'inspec-resource-group-9', name: 'example_disk') do
  it { should exist }
end

describe azure_virtual_machine_disk(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}') do
  it { should exist }
end

Parameters

resource_group

Azure resource group that the targeted resource resides in. MyResourceGroup.

name

Name of the disk to test. MyDisk.

Either one of the parameter sets can be provided for a valid query:

• resource_id
• resource_group and name

Properties

encryption_enabled<superscript>*</superscript>

Indicates whether the properties.EncryptionSettingsCollection.enabled is true or false. Note that this will return nil unless the encryption status is defined on the resource explicitly.

rest_encryption_type

The type of key used to encrypt the data of the disk.

sku

The SKU (pricing tier) of the disk.

managedBy

A relative URI containing the ID of the VM that has the disk attached.

properties.diskSizeBytes

The size of the disk in bytes.

* The disk can still be encrypted at rest with a platform key, even though the encryption_enabled is nil. It is recommended to see here for more details on disk encryption.

For properties applicable to all resources, such as type, name, location, id, properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed with the key names separated by dots (.), eg. properties.<attribute>.

Examples

Test If a Disk is Referenced with a Valid Name.

describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'os_disk') do
  it { should exist }
end

Test If a Disk is Referenced with an Invalid Name.

describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'i-dont-exist') do
  it { should_not exist }
end

Test the VM that the Disk is Attached.

describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'os_disk') do
  its('managedBy') { should cmp '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}' }
end

Test the Type of Key Used to Encrypt the Data at Rest.

describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'os_disk') do
  its('rest_encryption_type') { should cmp 'EncryptionAtRestWithPlatformKey' }
end

Test a Disk’s Size in Bytes.

describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'os_disk') do
  its('properties.diskSizeBytes') { should cmp 136367308800 }
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

attached

Test if a disk is attached to a virtual machine.

describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'os_disk') do
  it { should be_attached }
end

exists

# If we expect a resource to always exist

describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'os_disk') do
  it { should exist }
end
# If we expect a resource to never exist

describe azure_virtual_machine_disk(resource_group: 'my-rg', name: 'os_disk') 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.