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

+++ title = "azurermiothubeventhubconsumer_groups resource" draft = false gh_repo = "inspec" platform = "azure" [menu] [menu.inspec] title = "azurermiothubeventhubconsumer_groups" identifier = "inspec/resources/azure/azurermiothubeventhubconsumergroups.md azurermiothubeventhubconsumergroups resource" parent = "inspec/resources/azure" +++ {{< inspec/azurermdeprecated resource="azureiothubeventhubconsumergroups" >}} Use the `azurermiothubeventhubconsumer_groups` InSpec audit resource to test properties and configuration of an Azure IoT Hub Event Hub Consumer Groups 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`, `resourcename` and `eventhubendpoint` must be given as a parameter. describe azurermiothubeventhubconsumergroups(resourcegroup: 'my-rg', resourcename 'my-iot-hub', eventhub_endpoint: 'event-hub') do its('names') { should include "my-consumer-group"} its('types') { should include 'Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups' } end If a IoT Hub Event Hub Consumer Groups is referenced with a valid `Resource Group`, `Resource Name` and `Event Hub Endpoint` describe azurermiothubeventhubconsumergroups(resourcegroup: 'my-rg', resourcename 'my-iot-hub', eventhub_endpoint: 'event-hub') do it { should exist } end If a IoT Hub Event Hub Consumer Groups is referenced with an invalid `Resource Group`, `Resource Name` or `Event Hub Endpoint` describe azurermiothubeventhubconsumergroups(resourcegroup: 'invalid-rg', resourcename: 'invalid-resource', eventhub_endpoint: 'invalideventhub') 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. `eventhubendpoint` - The unique name of the IoT Hub Endpoint `ids` `names` `types` `etag` `properties` The Azure resource IDs. The Event Hub-compatible consumer group names identifier. its('types') { should include(`my-consumer-group-a`, `my-consumer-group-b`) } The types of the Resources, typically `Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups`. its('types') { should include(`Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups`) } A collection of additional configuration properties related to the IoT Hub Consumer Group, e.g. `created`. The etag applied to the IoT Hub Consumer Group. 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 azurermiothubeventhubconsumergroup(resourcegroup: 'my-rg', resourcename 'my-iot-hub', eventhub_endpoint: 'event-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.