azurerm_iothub ресурс

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

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

Версия Azure REST API

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

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

Примеры

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

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

Если IoT Hub ссылается на неверный 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 Hub.
• resource_name - Уникальное имя IoT Hub.

Атрибуты

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

id

ID ресурса Azure.

name

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

type

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

location

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

properties

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

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

tags

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

etag

Значение etag, применённое к IoT Hub.

sku

Свойства SKU для IoT Hub. Например, имя 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 на подписке, которую вы хотите протестировать.