azurerm_monitor_log_profile ресурс

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

Используйте ресурс проверки InSpec, чтобы протестировать свойства профиля Azure Monitor Log.

Версия Azure REST API

Этот ресурс взаимодействует с версией 2016-03-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 пакета ресурсов.

Синтаксис

Блок ресурса azurerm_monitor_log_profile определяет профиль журнала по имени.

describe azurerm_monitor_log_profile(name: 'default') do
  ...
end

Примеры

Проверка существования профиля журнала

describe azurerm_monitor_log_profile(name: 'default') do
  it { should exist }
end

Проверка включения удержания профиля журнала

describe azurerm_monitor_log_profile(name: 'default') do
  its('retention_enabled') { should be true }
end

Параметры

• name

Примеры параметров

Имя профиля журнала.

describe azurerm_monitor_log_profile(name: 'default') do
  it { should exist }
end

Атрибуты

• retention_enabled
• retention_days

retention_enabled

Определение, включено ли удержание.

its('retention_enabled') { should be true }

retention_days

Определение количества дней, на которые включено удержание.

its('retention_days')    { should eq(365) }

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

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

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

Обработчики

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

exists

Контроль будет пройден, если ресурс вернет результат. Используйте should_not если ожидается ноль совпадений.

#  If we expect 'default' to exist
describe azurerm_monitor_log_profile(name: 'default') do
  it { should exist }
end

# If we expect 'default' to not exist
describe azurerm_monitor_log_profile(name: 'default') do
  it { should_not exist }
end

Разрешения Azure

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