azure_iothub_event_hub_consumer_groups Resource

[edit on GitHub]

Use the azure_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, 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.

Installation

This resource is available in the Chef InSpec Azure resource pack.

See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.

Syntax

The resource_group, resource_name and event_hub_endpoint must be given as a parameter.

describe azure_iothub_event_hub_consumer_groups(resource_group: 'my-rg', resource_name: 'my-iot-hub', event_hub_endpoint: 'myeventhub') do
  its('names') { should include 'my-consumer-group'}
  its('types') { should include 'Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups' }
end

Parameters

resource_group

Azure resource group that the targeted resource resides in. MyResourceGroup.

resource_name

The name of the IoT hub. my-iot-hub.

event_hub_endpoint

The name of the Event Hub-compatible endpoint in the IoT hub. eventHubEndpointName.

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

Examples

Check If a Specific Consumer Group Exists.

describe azure_iothub_event_hub_consumer_groups(resource_group: 'my-rg', resource_name: 'my-iot-hub', event_hub_endpoint: 'myeventhub') do
  its('names') { should include('my_consumer_group') }
end

exists.

The control will pass if the filter returns at least one result. Use should_not if you expect zero matches.

**If we expect at least one resource to exists on a specified endpoint.**

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

**If we expect not to exist any consumer groups on a specified endpoint.**

describe azure_iothub_event_hub_consumer_groups(resource_group: 'my-rg', resource_name: 'my-iot-hub', event_hub_endpoint: 'myeventhub') 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.