azure_key_vault Resource

[edit on GitHub]

Use the azure_key_vault InSpec audit resource to test 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.

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

resource_group and name or the resource_id must be given as a parameter.

describe azure_key_vault(resource_group: 'inspec-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 that the targeted resource resides in. MyResourceGroup.

name

Name of the Azure resource to test. MyVault.

vault_name

Name of the Azure resource to test (for backward compatibility). MyVault.

resource_id

The unique resource ID. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.KeyVault/vaults/{vaultName}.

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, 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: 'MyResourceGroup', name: 'MyVaultName') do
  its('properties.sku.family') { should eq 'A' }
end

Test If Key Vault is Enabled for Disk Encryption.

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

Test If Azure Key Vault audit logging is enabled.

describe azure_key_vault(resource_group: 'MyResourceGroup', name: 'MyVaultName') 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: 'MyResourceGroup', name: 'MyVaultName') do
  it { should exist }
end

# Key vaults that aren't found will not exist
describe azure_key_vault(resource_group: 'MyResourceGroup', name: 'DoesNotExist') 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.