azurerm_management_groups ресурс

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

Используйте ресурс аудита InSpec azurerm_management_groups для проверки свойств, связанных с группами управления.

Версия Azure REST API

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

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

Доступность

Установка

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

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

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

Синтаксис

describe azurerm_management_groups do
  ...
end

Примеры

Проверка атрибутов всех групп управления

describe azurerm_management_groups do
    its('ids') { should include "/providers/Microsoft.Management/managementGroups/mg_id" }
    its('names') { should include "parent_mg" }
    its('types') { should include '/providers/Microsoft.Management/managementGroups' }
end

Фильтрация результатов для проверки свойств конкретной группы управления

describe azurerm_management_groups.where(name: 'mg_parent').entries.first do
    its('properties') { should have_attributes(:tenantId => tenant_id, :displayName => parent_dn)}
end

Параметры

Нет.

Атрибуты

• ids
• types
• names
• properties

ids

Идентификаторы групп управления.

types

Типы групп управления.

names

Названия групп управления.

properties

Дополнительные свойства, относящиеся к группам управления.

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

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

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

Обработчики

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

exists

Управление пройдёт, если фильтр вернёт хотя бы один результат. Используйте should_not если вы ожидаете нулевое количество совпадений.

describe azurerm_management_groups(name: 'my-mg') do
  it { should exist }
end

Разрешения Azure

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