azure_iothub_event_hub_consumer_groups Resource
Use the azure_iothub_event_hub_consumer_groups
InSpec audit resource to test the properties and configuration of an Azure IoT Hub Event Hub Consumer Groups within a resource group.
Azure REST API Version, Endpoint, and HTTP Client Parameters
This resource interacts with API versions supported by the resource provider.
The api_version
can be defined as a resource parameter.
If not provided, this resource uses the latest version.
For more information, refer to the azure_generic_resource
document.
Unless defined, this resource uses the azure_cloud
global endpoint and default values for the HTTP client.
For more information, refer to the resource pack README.
Install
This resource is available in the Chef InSpec Azure resource pack.
For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.
Syntax
The resource_group
, resource_name
, and event_hub_endpoint
are required parameters.
describe azure_iothub_event_hub_consumer_groups(resource_group: 'RESOURCE_GROUP', resource_name: 'IoT_NAME', event_hub_endpoint: 'EVENT_HUB_NAME') do
its('names') { should include 'CONSUMER_GROUP'}
its('types') { should include 'Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups' }
end
Parameters
resource_group
- Azure resource group where the targeted resource resides.
resource_name
- The name of the IoT hub.
event_hub_endpoint
- The name of the Event Hub-compatible endpoint in the IoT hub.
Properties
ids
- A list of the unique resource IDs.
Field:
id
locations
- A list of locations for all the resources being interrogated.
Field:
location
names
- A list of names of all the resources being interrogated.
Field:
name
tags
- A list of
tag:value
pairs defined on the resources being interrogated. Field:
tags
types
- A list of the types of resources being interrogated.
Field:
type
properties
- A list of properties for all the resources being interrogated.
Field:
properties
etags
- A list of etags defined on the resources.
Field:
etag
Note
Examples
Check if a specific consumer group exists
describe azure_iothub_event_hub_consumer_groups(resource_group: 'RESOURCE_GROUP', resource_name: 'IoT_NAME', event_hub_endpoint: 'EVENT_HUB_NAME') do
its('names') { should include('CONSUMER_GROUP') }
end
exists
The control passes if the filter returns at least one result. Use should_not
if you expect zero matches.
**If we expect at least one resource to exist on a specified endpoint.**
describe azure_iothub_event_hub_consumer_groups(resource_group: 'RESOURCE_GROUP', resource_name: 'IoT_NAME', event_hub_endpoint: 'EVENT_HUB_NAME') do
it { should exist }
end
**If we expect not to exist consumer groups on a specified endpoint.**
describe azure_iothub_event_hub_consumer_groups(resource_group: 'RESOURCE_GROUP', resource_name: 'IoT_NAME', event_hub_endpoint: 'EVENT_HUB_NAME') do
it { should_not exist }
end
Azure Permissions
Your Service Principal must be set up with at least a contributor
role on the subscription you wish to test.