azure_locks Resource
Use the azure_locks
InSpec audit resource to test the properties and configuration of all Management Locks for an Azure resource or any level below it.
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_locks
resource block returns all Management Locks within a resource group (if provided) or the entire subscription.
describe azure_locks do
it { should exist }
end
Or
describe azure_locks(resource_group: 'RESOURCE_GROUP') do
it { should exist }
end
Also, at resource level test can be done by providing the following identifiers: resource_group
, resource_name
, and resource_type
or the resource_id
.
describe azure_locks(resource_group: 'RESOURCE_GROUP', resource_name: 'VM_NAME`, resource_type: 'Microsoft.Compute/virtualMachines') do
it { should exist }
end
Or
describe azure_locks(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/{vmName}') do
it { should exist }
end
Parameters
resource_group
- Azure resource group where the targeted resource resides.
resource_name
- Name of the Azure resource on which the Management Locks are being tested.
resource_type
- Type of the Azure resource on which the Management Locks are being tested.
resource_id
- The unique resource ID of the Azure resource on which the Management Locks are being tested.
Either one of the parameter sets can be provided for a valid query:
resource_id
resource_group
,resource_name
andresource_type
resource_group
- None for a subscription level test.
Properties
ids
- A list of the unique resource IDs of the Management Locks.
Field:
id
names
- A list of names of all the Management Locks being interrogated.
Field:
name
properties
- A list of properties for all the Management Locks being interrogated.
Field:
properties
Note
Examples
Check if a specific Management Lock is present for a resource
describe azure_locks(resource_group: 'RESOURCE_GROUP', resource_name: 'VM_NAME', resource_type: 'Microsoft.Compute/virtualMachines') do
its('names') { should include 'production_agents' }
end
Filters the results to include only those Management Locks that have the specific name
describe azure_locks.where{ name.include?('production') } do
it { should exist }
end
Loop through all virtual machines to test if they have Management Locks defined
azure_virtual_machines.ids.each do |id|
describe azure_locks(resource_id: id) do
it { should exist }
end
end
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
exists
The control will pass if the filter returns at least one result. Use should_not
if you expect zero matches.
describe azure_locks(resource_group: 'RESOURCE_GROUP', resource_name: 'VM_NAME', resource_type: 'Microsoft.Compute/virtualMachines') 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.