azurerm_key_vault ресурс

[редактировать на GitHub]

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

Версия Azure REST API

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

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

Доступность

Установка

Этот ресурс доступен в 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

Примеры

Если хранилище ключей ссылается на допустимый Resource Group и Vault Name.

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

Если хранилище ключей ссылается на недопустимый Resource Group или Vault Name.

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

Параметры

• resource_group - Группа ресурсов, к которой принадлежит хранилище ключей.
• vault_name - Уникальное имя хранилища ключей.

Атрибуты

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

id

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

name

Имя хранилища ключей, например vault-101.

location

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

type

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

метки

Метки ресурсов, примененные к хранилищу ключей.

свойства

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

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

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

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

Обработчики соответствия

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

exists

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

Разрешения Azure

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