azurerm_event_hub_event_hub ресурс

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

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

Версия Azure REST API

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

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

Доступность

Установка

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

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

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

Версия

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

Синтаксис

resource_group, namespace_name и event_hub_name должны быть указаны в качестве параметра.

describe azurerm_event_hub_event_hub(resource_group: 'my-rg', namespace_name 'my-event-hub-ns', event_hub_name 'myeventhub') do
  it { should exist }
end

Примеры

Если Event Hub Event Hub ссылается на допустимый Resource Group, Namespace Name и Event Hub Name.

describe azurerm_event_hub_event_hub(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', event_hub_name 'myeventhub') do
  it { should exist }
end

Если Event Hub Event Hub ссылается на недопустимый Resource Group, Namespace Name и Event Hub Name.

describe azurerm_event_hub_event_hub(resource_group: 'invalid-rg', namespace_name: 'i-dont-exist', event_hub_name 'i-dont-exist') do
  it { should_not exist }
end

Параметры

• resource_group - Группа ресурсов, к которой принадлежит Event Hub Event Hub.
• namespace_name - Уникальное имя пространства имён Event Hub.
• event_hub_name - Уникальное имя Event Hub.

Атрибуты

• id
• name
• type
• properties

id

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

name

Имя Event Hub, например, myeventhub.

type

Тип ресурса, как правило, Microsoft.EventHub/Namespaces/EventHubs.

properties

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

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

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

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

Обработчики

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

exists

describe azurerm_event_hub_event_hub(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', event_hub_name: 'myeventhub') do
  it { should exist }
end

Разрешения Azure

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