azurerm_iothub_event_hub_consumer_groups ресурс

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

Используйте azurerm_iothub_event_hub_consumer_groups ресурс аудита InSpec для проверки свойств и конфигурации групп потребителей Azure IoT Hub Event Hub внутри группы ресурсов.

Версия Azure REST API

Этот ресурс взаимодействует с версией 2018-04-01 API управления Azure. Более подробная информация доступна в официальной документации Azure.

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

Доступность

Установка

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

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

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

Версия

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

Синтаксис

resource_group, resource_name и event_hub_endpoint должны быть заданы как параметр.

describe azurerm_iothub_event_hub_consumer_groups(resource_group: 'my-rg', resource_name 'my-iot-hub', event_hub_endpoint: 'myeventhub') do
  its('names') { should include "my-consumer-group"}
  its('types') { should include 'Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups' }
end

Примеры

Если группа потребителей IoT Hub Event Hub ссылается с корректным Resource Group, Resource Name и Event Hub Endpoint

describe azurerm_iothub_event_hub_consumer_groups(resource_group: 'my-rg', resource_name 'my-iot-hub', event_hub_endpoint: 'myeventhub') do
  it { should exist }
end

Если группа потребителей IoT Hub Event Hub ссылается с некорректным Resource Group, Resource Name или Event Hub Endpoint

describe azurerm_iothub_event_hub_consumer_groups(resource_group: 'invalid-rg', resource_name: 'invalid-resource', event_hub_endpoint: 'invalideventhub') do
  it { should_not exist }
end

Параметры

• resource_group - Группа ресурсов, к которой принадлежит IoT Hub.
• resource_name - Уникальное имя IoT Hub.
• event_hub_endpoint - Уникальное имя конечной точки IoT Hub

Атрибуты

• ids
• names
• types
• etag
• properties

id

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

названия

Идентификатор имени группы потребителей, совместимой с Event Hub.

its(‘types’) { should include(my-consumer-group-a, my-consumer-group-b) }

типы

Типы ресурсов, обычно Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups.

its(‘types’) { should include(Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups) }

свойства

Коллекция дополнительных свойств конфигурации, связанных с группой потребителей IoT Hub, например, created.

etags

Элемент etag, примененный к группе потребителей IoT Hub.

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

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

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

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

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

существует

describe azurerm_iothub_event_hub_consumer_group(resource_group: 'my-rg', resource_name 'my-iot-hub', event_hub_endpoint: 'myeventhub') do
  it { should exist }
end

Разрешения Azure

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