azure_iothub resource

Use the azure_iothub InSpec audit resource to test the properties of an Azure IoT hub within a resource group.

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

resource_group and name, or the resource_id are required parameters.

describe azure_iothub(resource_group: 'RESOURCE_GROUP', name: 'IoT_NAME') do
  it { should exist }
end

describe azure_iothub(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}') do
  it { should exist }
end

Parameters

resource_group: Azure resource group where the targeted resource resides.
name: The unique name of the IoT hub.
resource_name: Alias for the name parameter.
resource_id: The unique resource ID.

Either one of the parameter sets can be provided for a valid query:

resource_id
resource_group and name
resource_group and resource_name

Properties

sku: The SKU of the resource with these properties.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, see the Azure documentation for other available properties. You can access any attribute in the response with the key names separated by dots (.).

Examples

Test if file upload notifications are enabled:

describe azure_iothub(resource_group: 'RESOURCE_GROUP', name: 'IoT_NAME') do
  its('properties.enableFileUploadNotifications') { should cmp true }
end

describe azure_iothub(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}') do
  its('properties.enableFileUploadNotifications') { should cmp true }
end

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

exists

# If we expect the resource to always exist.

describe azure_iothub(resource_group: 'RESOURCE_GROUP', name: 'IoT_NAME') do
  it { should exist }
end

not_exists

# If we expect the resource to never exist.

describe azure_iothub(resource_group: 'RESOURCE_GROUP', name: 'IoT_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.