Skip to main content

azure_event_hub_event_hub Resource

[edit on GitHub]

Use the azure_event_hub_event_hub InSpec audit resource to test properties of an Azure Event Hub description 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

resource_group, namespace_name and name or the resource_id must be given as a parameter.

describe azure_event_hub_event_hub(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', name: 'myeventhub') do
  it { should exist }
end

describe azure_event_hub_event_hub(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}') do
  it { should exist }
end

Parameters

resource_group
Azure resource group that the targeted resource resides in. resourceGroupName.
namespace_name
The unique name of the Event Hub Namespace. namespaceName.
name
The unique name of the targeted resource. eventHubName.
event_hub_name
Alias for the name parameter.
resource_id
The unique resource ID. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}.

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

  • resource_id
  • resource_group, namespace_name and name
  • resource_group, namespace_name and event_hub_name

Properties

properties.messageRetentionInDays
Number of days to retain the events for this Event Hub, value should be 1 to 7 days.

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

Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed with the key names separated by dots (.).

Examples

Test the Message Retention Time of an Event Hub.

describe azure_event_hub_event_hub(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', name: 'myeventhub') do
  its('properties.messageRetentionInDays') { should cmp 4 }
end

describe azure_event_hub_event_hub(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}') do
  its('properties.messageRetentionInDays') { should cmp 4 }
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_event_hub_event_hub(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', name: 'myeventhub') do
  it { should exist }
end

# If we expect the resource not to exist

describe azure_event_hub_event_hub(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', name: '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.

Was this page helpful?

×









Search Results