Skip to content

Latest commit

 

History

History
97 lines (75 loc) · 4.6 KB

azure_event_hub_event_hub.md

File metadata and controls

97 lines (75 loc) · 4.6 KB
title platform
About the azure_event_hub_event_hub Resource
azure

azure_event_hub_event_hub

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, the latest version will be used. For more information, refer to azure_generic_resource.

Unless defined, azure_cloud global endpoint, and default values for the http client will be used. For more information, refer to the resource pack README.

Availability

Installation

This resource is available in the InSpec Azure resource pack. For an example inspec.yml file and how to set up your Azure credentials, refer to resource pack README.

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

Name Description
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

Property Description
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 setup with a contributor role on the subscription you wish to test.