azure_virtual_machine_disks Resource
Use the azure_virtual_machine_disks
InSpec audit resource to test the properties related to disks for a resource group or the entire subscription.
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
An azure_virtual_machine_disks
resource block returns all disks within a resource group (if provided) or an entire subscription.
describe azure_virtual_machine_disks do
it { should exist }
end
Or
describe azure_virtual_machine_disks(resource_group: 'RESOURCE_GROUP') do
it { should exist }
end
Parameters
resource_group
(optional)The name of the resource group.
Properties
ids
- A list of the unique resource IDs.
Field:
id
attached
- Indicates whether the disk is currently mounted to a running VM.
Field:
attached
resource_group
- A list of resource groups for all the disks.
Field:
resource_group
names
- A list of names for all the disks.
Field:
name
locations
- A list of locations of the disks.
Field:
location
properties
- A list of properties of the disks.
Field:
properties
tags
- A list of
tag:value
pairs defined on the resources. Field:
tags
Note
Examples
Filter the attached disks
describe azure_virtual_machine_disks(resource_group: 'RESOURCE_GROUP').where(attached: true) do
it { should exist }
its('count') { should eq 3}
end
Loop through disks by their IDs
azure_virtual_machine_disks.ids.each do |id|
describe azure_virtual_machine_disk(resource_id: id) do
it { should exist }
end
end
Test that there are disks that include a certain string in their names (Client Side Filtering)
describe azure_virtual_machine_disks(resource_group: 'RESOURCE_GROUP').where { name.include?('Windows') } do
it { should exist }
end
Test that there are disks that include a certain string in their names (Server Side Filtering via Generic Resource - Recommended)
describe azure_generic_resources(resource_provider: 'Microsoft.Compute/disks', substring_of_name: 'Windows') do
it { should exist }
end
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
exists
# Should not exist if no disks are in the resource group.
describe azure_virtual_machine_disks(resource_group: 'RESOURCE_GROUP') do
it { should_not exist }
end
not_exists
# Should exist if the filter returns a single virtual machine.
describe azure_virtual_machine_disks.where(attached: true ) do
it { should exist }
end
Azure Permissions
Your Service Principal must be set up with at least a contributor
role on the subscription you wish to test.