azure_event_hub_authorization_rule.md

title	platform
About the azure_event_hub_authorization_rule Resource	azure

azure_event_hub_authorization_rule

Use the azure_event_hub_authorization_rule InSpec audit resource to test properties and configuration of an Azure Event Hub Authorization Rule 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, event_hub_endpoint and name or the resource_id must be given as a parameter.

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

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

Parameters

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

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

• resource_id
• resource_group, namespace_name, event_hub_endpoint and name
• resource_group, namespace_name, event_hub_endpoint and authorization_rule

Properties

Property	Description
properties.rights	The list of rights associated with the rule.

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 Name of an Authorization Rule

describe azure_event_hub_authorization_rule(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', event_hub_endpoint: 'myeventhub', name: 'my-auth-rule') do
  its('name') { should cmp 'my-auth-rule' }
end

describe azure_event_hub_authorization_rule(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}') do
  its('name') { should cmp 'my-auth-rule' }
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_authorization_rule(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', event_hub_endpoint: 'myeventhub', name: 'my-auth-rule') do
  it { should exist }
end

# If we expect the resource not to exist
describe azure_event_hub_authorization_rule(resource_group: 'my-rg', namespace_name: 'my-event-hub-ns', event_hub_endpoint: 'myeventhub', name: 'my-auth-rule') 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.