azurerm_iothub_event_hub_consumer_group ресурс

[редактировать на 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 и consumer_group должны быть заданы как параметры.

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

Примеры

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

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

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

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

Параметры

• resource_group — группа ресурсов, к которой принадлежит IoT Hub.
• resource_name — уникальное имя IoT Hub.
• event_hub_endpoint — уникальное имя конечной точки IoT Hub.
• consumer_group — уникальное имя группы потребителей конечной точки IoI Hub.

Атрибуты

• id
• name
• type
• etag
• properties

id

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

name

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

type

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

properties

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

etag

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', consumer_group: 'my-consumer-group') do
  it { should exist }
end

Разрешения Azure

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