azurerm_event_hub_event_hub ресурс

[редактировать на GitHub]

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

Версия Azure REST API

Этот ресурс взаимодействует с версией 2017-04-01 API Azure Management. Дополнительную информацию можно найти в официальной документации 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, 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 может не всегда возвращать ключи, не имеющие связанных данных. В некоторых случаях глубоко вложенное свойство может не иметь желаемого атрибута по вашей цепочке вызова. Если вы обнаруживаете, что пишете тесты на свойства, которые могут быть nil, создайте форк этого пакета ресурсов и добавьте обработчик для ресурса. В этом обработчике вы сможете защититься от nil-ключей. Запросы на включение всегда приветствуются.

Матчеры

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