azure_key_vault_keys resource

Use the azure_key_vault_keys InSpec audit resource to test the properties and configuration of multiple Azure keys within vaults.

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

An azure_key_vault_keys resource block returns all keys within a vault.

describe azure_key_vault_keys(vault_name: 'EXAMPLE_VAULT') do
  #...
end

Parameters

vault_name

The name of the vault.

Properties

attributes

A list of the key management attributes in this format.

Field: attributes

kids

A list of key IDs.

Field: kid

managed

A list of boolean values indicating if the keys are managed by key vault or not.

Field: managed

tags

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

Field: tags

Examples

Test that a vault has the named key:

describe azure_key_vault_keys(vault_name: 'EXAMPLE_VAULT').where { kid.include?('KEY_NAME')} do
  it { should exist }
  its('count') { should be 1 }
end

Loop through keys by the key ID:

azure_key_vault_keys(vault_name: 'EXAMPLE_VAULT').kids.each do |kid|
  describe azure_key_vault_key(key_id: kid) do
    it { should exist }
  end 
end

Matchers

This resource has the following special matchers.

exists

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

# If we expect to have at least one key in a vault.

describe azure_key_vault_keys(vault_name: 'EXAMPLE_VAULT') do
  it { should exist }
end

not_exists

# If we expect not to have any keys in a vault.

describe azure_key_vault_keys(vault_name: 'EXAMPLE_VAULT') 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.