Skip to main content

azurerm_locks resource


This resource will be deprecated when version 2 of the inspec-azure resource pack is released. Please use the azure_locks resource instead.

Use the azurerm_locks InSpec audit resource to test properties of some or all Azure Resource Locks.

Azure REST API version

This resource interacts with version 2016-09-01 of the Azure Management API. For more information see the official Azure documentation.

At the moment, there doesn’t appear to be a way to select the version of the Azure API docs. If you notice a newer version being referenced in the official documentation please open an issue or submit a pull request using the updated version.



This resource is available in the inspec-azure resource pack. To use it, add the following to your inspec.yml in your top-level profile:

  - name: inspec-azure

You’ll also need to setup your Azure credentials; see the resource pack README.


This resource first became available in 1.3.8 of the inspec-azure resource pack.


An azurerm_locks resource block returns all Locks on a given Resource.

describe azurerm_locks(resource_group: 'rg', resource_name: 'my-vm', resource_type: 'Microsoft.Compute/virtualMachines') do


The following examples show how to use this InSpec audit resource.

Ensure a Lock exists

describe azurerm_locks(resource_group: 'my-rg', resource_name: 'my-vm', resource_type: 'Microsoft.Compute/virtualMachines') do
  it { should exist }

Filter Criteria

  • ids
  • names
  • properties


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


The control will pass if the filter returns at least one result. Use should_not if you expect zero matches.

Azure Permissions

Your Service Principal must be setup with a contributor role on the subscription you wish to test.

Edit this page on GitHub

Thank you for your feedback!


Search Results