azurerm_key_vault ресурс

[править на GitHub]

Используйте azurerm_key_vault InSpec ресурс аудита, чтобы протестировать свойства и конфигурацию Azure Key Vault.

Версия Azure REST API

Этот ресурс взаимодействует с версией 2016-10-01 Azure API управления. Дополнительную информацию см. в официальной документации Azure.

В настоящее время не существует способа выбрать версию документации Azure API. Если вы заметите ссылку на новую версию в официальной документации, откройте вопрос или отправьте запрос на изменение с использованием обновленной версии.

Доступность

Установка

Этот ресурс доступен в inspec-azure пакете ресурсов. Для использования добавьте следующее в свой inspec.yml в вашем профиле верхнего уровня:

depends:
  - name: inspec-azure
    git: https://github.com/inspec/inspec-azure.git

Вам также необходимо настроить свои учетные данные Azure; см. в пакете ресурсов README.

Версия

Этот ресурс впервые стал доступен в версии 1.2.0 пакета ресурсов inspec-azure.

Синтаксис

resource_group и vault_name должны быть указаны в качестве параметра.

describe azurerm_key_vault(resource_group: 'inspec-resource-group', vault_name: 'vault-101') do
  it            { should exist }
  its('name')   { should eq('vault-101') }
end

Примеры

Если Key Vault ссылается на допустимый Resource Group и Vault Name

describe azurerm_key_vault(resource_group: 'my-rg', vault_name: 'vault-101') do
  it { should exist }
end

Если Key Vault ссылается на недопустимый Resource Group или Vault Name

describe azurerm_key_vault(resource_group: 'invalid-rg', vault_name: 'vault-null') do
  it { should_not exist }
end

Параметры

• resource_group — Группа ресурсов, к которой принадлежит Key Vault.
• vault_name — Уникальное имя Key Vault.

Атрибуты

• id
• name
• location
• type
• tags
• properties

id

Идентификатор ресурса Azure.

name

Имя Key Vault, например vault-101.

location

Расположение ресурса, например eastus.

type

Тип ресурса, обычно Microsoft.KeyVault/vaults.

теги

Теги ресурсов, примененные к Key Vault.

свойства

Коллекция дополнительных свойств конфигурации, связанных с Key Vault, например vaultUri.

Другие атрибуты

Существуют дополнительные атрибуты, к которым можно получить доступ, но которые мы не задокументировали. Пожалуйста, ознакомьтесь с документацией Azure. Любой атрибут в ответе может быть получен с использованием имен ключей, разделенных точками (.).

API может не всегда возвращать ключи, не имеющие связанных данных. В некоторых случаях глубоко вложенное свойство может не содержать нужного атрибута в цепочке вызовов. Если вы пишете тесты на свойства, которые могут быть nil, создайте ветку этого пакета ресурсов и добавьте к нему метод доступа. В методе доступа вы сможете защититься от пустых ключей. Запросы на изменение приветствуются.

Матчеры

Этот ресурс аудита InSpec имеет следующие специальные матчеры. Полный список доступных матчеров см. на нашей странице Универсальные Матчеры.

существует

describe azurerm_key_vault(resource_group: 'my-rg', vault_name: 'vault-101') do
  it { should exist }
end

Разрешения Azure

Ваш сервисный принцип должен быть настроен с ролью contributor на подписке, которую вы хотите протестировать.