azure_key_vaults resource

Use the azure_key_vaults InSpec audit resource to test the properties related to key vaults for a resource group or the entire subscription.

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_vaults resource block returns all Azure key vaults, either within a resource group (if provided) or the entire subscription.

describe azure_key_vaults do
  #...
end

describe azure_key_vaults(resource_group: 'RESOURCE_GROUP') do
  #...
end

Parameters

resource_group (optional): The name of the resource group.

Properties

ids: A list of the unique resource IDs.
Field: id
names: A list of all the key vault names.
Field: name
tags: A list of tag:value pairs defined on the resources.
Field: tags
types: A list of types of all the key vaults.
Field: type
locations: A list of locations for all the key vaults.
Field: location
properties: A list of properties for all the key vaults.
Field: properties

Note

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

Examples

Loop through key vaults by their IDs:

azure_key_vaults.ids.each do |id|
  describe azure_key_vault(resource_id: id) do
    it { should exist }
  end
end

Test to ensure there are key vaults that include a certain string in their names (client-side filtering):

describe azure_key_vaults.where { name.include?('deployment') } do
  it { should exist }
end

Test to ensure there are key vaults that include a certain string in their names (Server Side Filtering via Generic Resource - Recommended):

describe azure_generic_resources(resource_provider: 'Microsoft.KeyVault/vaults', substring_of_name: 'deployment') do
  it { should exist }
end

Matchers

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

not_exists

# Should not exist if no key vaults are in the resource group.

describe azure_key_vaults(resource_group: 'RESOURCE_GROUP') do
  it { should_not exist }
end

exists

# Should exist if the filter returns at least one key vault.

describe azure_key_vaults(resource_group: 'RESOURCE_GROUP') 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.