azure_virtual_machines Resource

[edit on GitHub]

Use the azure_virtual_machines InSpec audit resource to test properties related to virtual machines 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.

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

An azure_virtual_machines resource block returns all Azure virtual machines, either within a Resource Group (if provided), or within an entire Subscription.

describe azure_virtual_machines do
  #...
end

or

describe azure_virtual_machines(resource_group: 'my-rg') do
  #...
end

Parameters

resource_group (optional)

The name of the resource group.

Properties

ids

A list of the unique resource ids.

Field: id

os_disks

A list of OS disk names for all the virtual machines.

Field: os_disk

data_disks

A list of data disks for all the virtual machines.

Field: data_disks

vm_names

A list of all the virtual machine names.

Field: name

platforms

A list of virtual machine operation system platforms. Supported values are windows and linux.

Field: platform

tags

A list of tag:value pairs defined on the resources.

Field: tags

Examples

Test If Any Virtual Machines Exist in the Resource Group.

describe azure_virtual_machines(resource_group: 'MyResourceGroup') do
  it { should exist }
end

Filters Based on Platform.

describe azure_virtual_machines(resource_group: 'MyResourceGroup').where(platform: 'windows') do
  it { should exist }
end

Loop through Virtual Machines by Their Ids .

azure_virtual_machines.ids.each do |id|
  describe azure_virtual_machine(resource_id: id) do
    it { should exist }
  end
end  

Test If There are Windows Virtual Machines .

describe azure_virtual_machines(resource_group: 'MyResourceGroup').where(platform: 'windows') do
  it { should exist }
end

Test that There are Virtual Machines that Includes a Certain String in their Names (Client Side Filtering) .

describe azure_virtual_machines(resource_group: 'MyResourceGroup').where { name.include?('WindowsVm') } do
  it { should exist }
end

Test that There are Virtual Machine that Includes a Certain String in their Names (Server Side Filtering via Generic Resource - Recommended) .

describe azure_generic_resources(resource_group: 'MyResourceGroup', resource_provider: 'Microsoft.Compute/virtualMachine', substring_of_name: 'WindowsVm') do
  it { should exist }
end

Matchers

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

exists

# Should not exist if no virtual machines are in the resource group

describe azure_virtual_machines(resource_group: 'MyResourceGroup') do
  it { should_not exist }
end

# Should exist if the filter returns a single virtual machine

describe azure_virtual_machines(resource_group: 'MyResourceGroup').where(platform: 'windows') 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.