azure_virtual_machine_disk Resource
Use the azure_virtual_machine_disk
InSpec audit resource to test the 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.
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
, or the resource_id
are required parameters.
describe azure_virtual_machine_disk(resource_group: 'RESOURCE_GROUP', 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 where the targeted resource resides.
name
- Name of the disk to test.
Either one of the parameter sets can be provided for a valid query:
resource_id
resource_group
andname
Properties
encryption_enabled<superscript>*</superscript>
- Indicates whether the
properties.EncryptionSettingsCollection.enabled
istrue
orfalse
. Note that this will returnnil
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.
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
, and 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 (.
). For example, properties.<attribute>
.
Examples
Test if a disk is referenced with a valid name
describe azure_virtual_machine_disk(resource_group: 'RESOURCE_GROUP', 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: 'RESOURCE_GROUP', 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: 'RESOURCE_GROUP', name: 'OS_DISK') do
its('managedBy') { should cmp '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}' }
end
Test the key type used to encrypt the data at rest
describe azure_virtual_machine_disk(resource_group: 'RESOURCE_GROUP', 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: 'RESOURCE_GROUP', name: 'OS_DISK') do
its('properties.diskSizeBytes') { should cmp 136367308800 }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
attached
Test if a disk is attached to a virtual machine.
describe azure_virtual_machine_disk(resource_group: 'RESOURCE_GROUP', 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: 'RESOURCE_GROUP', name: 'OS_DISK') do
it { should exist }
end
not_exists
# If we expect a resource to never exist.
describe azure_virtual_machine_disk(resource_group: 'RESOURCE_GROUP', 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.