azurerm_event_hub_authorization_rule ресурс

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

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

Версия Azure REST API

Этот ресурс взаимодействует с версией 2017-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, namespace_name, event_hub_name и authorization_rule_name должны быть заданы.

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

Примеры

Если правило авторизации Event Hub ссылается на Resource Group, Namespace Name, Event Hub Name и Authorization Rule Name, то:

describe azurerm_event_hub_authorization_rule(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', event_hub_endpoint: 'myeventhub', authorization_rule: 'my-auth-rule') do
  it { should exist }
end

Если правило авторизации Event Hub ссылается на неверные значения Resource Group, Namespace Name, Event Hub Name или Authorization Rule Name, то:

describe azurerm_event_hub_namespace(resource_group: 'invalid-rg', namespace_name: 'i-dont-exist', event_hub_endpoint: 'fakeendpoint', authorization_rule: 'fake-auth-rule') do
  it { should_not exist }
end

Параметры

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

Атрибуты

• id
• name
• properties.rights
• type

id

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

name

Имя правила авторизации Event Hub, например, my-auth-rule.

properties

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

type

Тип ресурса, обычно Microsoft.EventHub/Namespaces/EventHubs/AuthorizationRules.

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

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

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

Матчеры

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

exists

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

Разрешения Azure

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