Project: Chef InSpec (Provisioning / Security & Compliance)
File: azurerm_iothub.md

+++ title = "azurerm_iothub resource" draft = false gh_repo = "inspec" platform = "azure" [menu] [menu.inspec] title = "azurerm_iothub" identifier = "inspec/resources/azure/azurermiothub.md azurermiothub resource" parent = "inspec/resources/azure" +++ {{< inspec/azurermdeprecated resource="azureiothub" >}} Use the `azurerm_iothub` InSpec audit resource to test properties and configuration of an Azure Event Hub Namespace within a Resource Group. This resource interacts with version `2018-04-01` of the Azure Management API. For more information see the . At the moment, there doesn't appear to be a way to select the version of the Azure API docs. If you notice a newer version being referenced in the official documentation please open an issue or submit a pull request using the updated version. This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the following to your `inspec.yml` in your top-level profile: depends: inspec-azure: git: https://github.com/inspec/inspec-azure.git You'll also need to setup your Azure credentials; see the resource pack . This resource first became available in 1.11.0 of the inspec-azure resource pack. The `resourcegroup` and `resourcename` must be given as a parameter. describe azurermiothub(resourcegroup: 'my-rg', resource_name 'my-iot-hub') do it { should exist } end If an IoT Hub is referenced with a valid `Resource Group` and `Resource Name` describe azurermiothub(resourcegroup: 'my-rg', resource_name 'my-iot-hub') do it { should exist } end If an IoT Hub is referenced with an invalid `Resource Group` or `Resource Name` describe azurermiothub(resourcegroup: 'invalid-rg', resource_name: 'i-do-not-exist') do it { should_not exist } end `resource_group` - The resource Group to which the IoT Hub belongs. `resource_name` - The unique name of the IoT Hub. `id` `name` `type` `location` `tags` `etag` `properties` `sku` Azure resource ID. IoT Hub name, e.g. `my-iot-hub`. The type of Resource, typically `Microsoft.Devices/IotHubs`. Resource location, e.g. `eastus`. A collection of additional configuration properties related to the IoT Hub, e.g. `eventHubEndpoints,routing,messagingEndpoints`. For a full list of properties please take a look at the Resource tags applied to the IoT Hub. The etag applied to the IoT Hub. SKU properties for the IoT Hub. Such as sku name, billing tier and capacity. There are additional attributes that may be accessed that we have not documented. Please take a look at the . Any attribute in the response may be accessed with the key names separated by dots (`.`). The API may not always return keys that do not have any associated data. There may be cases where the deeply nested property may not have the desired attribute along your call chain. If you find yourself writing tests against properties that may be nil, fork this resource pack and add an accessor to the resource. Within that accessor you'll be able to guard against nil keys. Pull requests are always welcome. {{< readfile file="content/inspec/reusable/md/inspecmatcherslink.md" >}} This resource has the following special matchers. describe azurermiothub(resourcegroup: 'my-rg', resource_name 'my-iot-hub') do it { should exist } end Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be setup with a `contributor` role on the subscription you wish to test.