Ресурс azurerm_iothub_event_hub_consumer_group

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

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

Версия Azure REST API

Этот ресурс взаимодействует с версией 2018-04-01 API Azure Management. Более подробная информация представлена в официальной документации 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 и 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

Примеры

Если группа потребителей Azure 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

Если группа потребителей Azure 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 Endpoint.

Атрибуты

• 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 не всегда возвращает ключи без связанных данных. Возможны случаи, когда глубоко вложенное свойство может не содержать требуемого атрибута по цепочке вызова. Если вы обнаруживаете необходимость писать тесты на свойства, которые могут быть null, создайте копию этого пакета ресурсов и добавьте аксессор к ресурсу. В аксессоре вы сможете защититься от null-ключей. Запросы на добавление новых функций всегда приветствуются.

Матчеры

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