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. 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_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

For information on using filter criteria on plural resources, see the documentation on FilterTable

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

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 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.