azure_key_vault_secrets Resource
Use the azure_key_vault_secrets
InSpec audit resource to test the properties and configuration of multiple Azure secrets 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.
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_key_vault_secrets
resource block returns all secrets within a vault.
describe azure_key_vault_secrets(vault_name: 'EXAMPLE_VAULT') do
#...
end
Parameters
vault_name
The name of the vault.
Properties
attributes
- A list of the secret management attributes in this format.
Field:
attributes
ids
- A list of secret IDs.
Field:
id
managed
- A list of boolean values indicating if the secrets are managed by key vault or not.
Field:
managed
contentTypes
- A list of secrets content type being interrogated.
Field:
contentType
tags
- A list of
tag:value
pairs defined on the resources being interrogated. Field:
tags
Note
See the documentation on FilterTable for information on using filter criteria on plural resources.
Examples
Test that a vault has the named secret
describe azure_key_vault_secrets(vault_name: 'EXAMPLE_VAULT').where { id.include?('SECRET')} do
it { should exist }
its('count') { should be 1 }
end
Loop through secrets by their IDs
azure_key_vault_secrets(vault_name: 'EXAMPLE_VAULT').ids.each do |id|
describe azure_key_vault_secret(secret_id: id) do
it { should exist }
end
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
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 secret in a vault.
describe azure_key_vault_secrets(vault_name: 'EXAMPLE_VAULT') do
it { should exist }
end
not_exists
# If we expect not have any secrets in a vault.
describe azure_key_vault_secrets(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.
Was this page helpful?