azurerm_iothub ресурс

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

Используйте ресурс проверки InSpec azurerm_iothub для проверки свойств и конфигурации пространства имен Azure 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 должны быть заданы в качестве параметра.

describe azurerm_iothub(resource_group: 'my-rg', resource_name 'my-iot-hub') do
  it { should exist }
end

Примеры

Если Центр IoT указан с допустимым Resource Group и Resource Name

describe azurerm_iothub(resource_group: 'my-rg', resource_name 'my-iot-hub') do
  it { should exist }
end

Если Центр IoT указан с недопустимым Resource Group или Resource Name

describe azurerm_iothub(resource_group: 'invalid-rg', resource_name: 'i-dont-exist') do
  it { should_not exist }
end

Параметры

• resource_group - Группа ресурсов, к которой принадлежит Центр IoT.
• resource_name - Уникальное имя Центра IoT.

Атрибуты

• id
• name
• type
• location
• tags
• etag
• properties
• sku

id

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

name

Имя Центра IoT, например my-iot-hub.

type

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

location

Расположение ресурса, например eastus.

properties

Коллекция дополнительных свойств конфигурации, относящихся к Центру IoT, например eventHubEndpoints,routing,messagingEndpoints.

Полный список свойств см. в документации Azure

теги

Теги ресурсов, примененные к Центру IoT.

etag

Этэг, примененный к Центру IoT.

sku

Свойства SKU для Центра IoT. Например, имя SKU, тарифный план и емкость.

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

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

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

Матчеры

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

exists

describe azurerm_iothub(resource_group: 'my-rg', resource_name 'my-iot-hub') do
  it { should exist }
end

Разрешения Azure

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