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.
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_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
Note
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
For a full list of available matchers, see our Universal Matchers page.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.