azurerm_iothub_event_hub_consumer_groups ресурс

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

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

Версия Azure REST API

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

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

Доступность

Установка

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

ids

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

names

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

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

types

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

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

properties

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

etags

Значение etag, применённое к группе потребителей IoT Hub.

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

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

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

Матчеры

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

exists

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 на подписке, которую вы хотите протестировать.