azurerm_key_vault_secret ресурс

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

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

Версия Azure REST API

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

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

Доступность

Установка

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

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

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

Версия

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

Синтаксис

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

Вы также можете указать secret_version - если версия не указана, будет использоваться самая последняя версия секрета.

describe azurerm_key_vault_secret('vault-101', 'secret-101') do
    it           { should exist }
    its('value') { should_not be_nil }
end

Примеры

Если секрет хранилища ключей ссылается на действительный Vault Name, Secret Name и Secret Version.

describe azurerm_key_vault_secret('vault-101', 'secret-101', '7df9bf2c3b4347bab213ebe233f0e350') do
    its('value')       { should_not be_nil }
end

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

describe azurerm_key_vault_secret('vault-101', 'incorrect-secret') do
    it { should_not exist }
end

Параметры

• vault_name - Имя хранилища ключей.
• secret_name - Имя ключа.
• secret_version (необязательно) - Версия ключа, например 7df9bf2c3b4347bab213ebe233f0e350.

Атрибуты

• id
• value
• attributes
• kid
• content_type
• managed
• tags

id

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

значение

Значение секрета.

атрибуты

Атрибуты управления секретом.

kid

Если это секрет, поддерживающий сертификат KV, то это поле указывает соответствующий ключ, поддерживающий сертификат KV.

тип_контента

Тип содержимого секрета.

управляемый

Истина, если срок жизни секрета управляется хранилищем ключей. Если это секрет, поддерживающий сертификат, то управляемый будет равен true.

теги

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

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

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

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

Сопоставители

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

exists

describe azurerm_key_vault_secret('vault-101', 'secret') do
  it { should exist }
end

Разрешения Azure

Ваш сервисный принцип должен быть настроен с ролью contributor на подписке, которую вы хотите протестировать. Ваше хранилище Azure Key Vault также должно содержать этот сервисный принцип в своей политике доступа с разрешениями secret/get и secret/list.