azure_key_vault Resource

Use the azure_key_vault InSpec audit resource to test the properties related to a key vault.

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

resource_group and name, or the resource_id are required parameters.

describe azure_key_vault(resource_group: 'RESOURCE_GROUP', name: 'VAULT-101') do
  it            { should exist }
  its('name')   { should cmp 'vault-101' }    
end

describe azure_key_vault(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.KeyVault/vaults/{vaultName}') do
  it            { should exist }
end

Parameters

resource_group: Azure resource group where the targeted resource resides.
name: Name of the Azure resource to test.
vault_name: Name of the Azure resource to test (for backward compatibility).
resource_id: The unique resource ID.
diagnostic_settings_api_version: The endpoint API version for the diagnostic_settings property. 2017-05-01-preview will be used for backward compatibility unless provided.

Either one of the parameter sets can be provided for a valid query:

resource_id
resource_group and name
resource_group and vault_name

Properties

diagnostic_settings: The active diagnostic settings list for the key vault.
diagnostic_settings_logs: The logs enabled status of every category for the key vault.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed with the key names separated by dots (.).

Examples

Test key vault’s SKU family

describe azure_key_vault(resource_group: 'RESOURCE_GROUP', name: 'VAULT_NAME') do
  its('properties.sku.family') { should eq 'A' }
end

Test if the key vault is enabled for disk encryption

describe azure_key_vault(resource_group: 'RESOURCE_GROUP', name: 'VAULT_NAME') do
  its('properties.enabledForDiskEncryption') { should be_true }
end

Test if Azure key vault audit logging is enabled

describe azure_key_vault(resource_group: 'RESOURCE_GROUP', name: 'VAULT_NAME') do
  its('diagnostic_settings_logs') { should include(true) }
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

# If a key vault is found, it will exist.

describe azure_key_vault(resource_group: 'RESOURCE_GROUP', name: 'VAULT_NAME') do
  it { should exist }
end

not_exists

# Key vaults that aren't found, will not exist.

describe azure_key_vault(resource_group: 'RESOURCE_GROUP', name: 'VAULT_NAME') 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.