azurerm_iothub_event_hub_consumer_groups resource
Warning
This resource will be deprecated when version 2 of the inspec-azure resource pack is released. Please use the azure_iothub_event_hub_consumer_groups resource instead.
Use the azurerm_iothub_event_hub_consumer_groups
InSpec audit resource to test properties and configuration of
an Azure IoT Hub Event Hub Consumer Groups within a Resource Group.
Azure REST API version
This resource interacts with version 2018-04-01
of the Azure Management API. For more
information see the Official Azure Documentation.
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.
Availability
Install
This resource is available in the inspec-azure
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 README.
Version
This resource first became available in 1.11.0 of the inspec-azure resource pack.
Syntax
The resource_group
, resource_name
and event_hub_endpoint
must be given as a parameter.
describe azurerm_iothub_event_hub_consumer_groups(resource_group: 'my-rg', resource_name 'my-iot-hub', event_hub_endpoint: 'event-hub') do
its('names') { should include "my-consumer-group"}
its('types') { should include 'Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups' }
end
Examples
If a IoT Hub Event Hub Consumer Groups is referenced with a valid Resource Group
, Resource Name
and Event Hub Endpoint
describe azurerm_iothub_event_hub_consumer_groups(resource_group: 'my-rg', resource_name 'my-iot-hub', event_hub_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 azurerm_iothub_event_hub_consumer_groups(resource_group: 'invalid-rg', resource_name: 'invalid-resource', event_hub_endpoint: 'invalideventhub') do
it { should_not exist }
end
Parameters
resource_group
- The resource Group to which the IoT Hub belongs.resource_name
- The unique name of the IoT Hub.event_hub_endpoint
- The unique name of the IoT Hub Endpoint
Attributes
ids
names
types
etag
properties
ids
The Azure resource IDs.
names
The Event Hub-compatible consumer group names identifier.
its(’types’) { should include(my-consumer-group-a
, my-consumer-group-b
) }
types
The types of the Resources, typically Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups
.
its(’types’) { should include(Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups
) }
properties
A collection of additional configuration properties related to the IoT Hub Consumer Group, e.g. created
.
etags
The etag applied to the IoT Hub Consumer Group.
Other Attributes
There are additional attributes that may be accessed that we have not
documented. Please take a look at the Azure documentation.
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.
Matchers
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
exists
describe azurerm_iothub_event_hub_consumer_group(resource_group: 'my-rg', resource_name 'my-iot-hub', event_hub_endpoint: 'event-hub') do
it { should exist }
end
Azure Permissions
Your Service
Principal
must be setup with a contributor
role on the subscription you wish to test.