azure_service_bus_subscription

Use the azure_service_bus_subscription_rule InSpec audit resource to test the properties related to an Azure Service Bus subscription rule.

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

describe azure_service_bus_subscription_rule(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: "SUBSCRIPTION_NAME", topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_RULE_NAME') do
  it                                      { should exist }
  its('type')                             { should eq 'Microsoft.ServiceBus/Namespaces/Topics/Subscriptions/Rules' }
  its('properties.filterType')            { should eq 'SqlFilter' }
end

Parameters

name (required): Name of the Azure Service Bus subscription rule to test.
namespace_name (required): The namespace name.
subscription_name (required): The subscription name.
topic_name (required): The topic name.
resource_group (required): Azure resource group where the targeted resource resides.

Properties

id: Resource ID.
name: Resource name.
type: Resource type.
properties: The properties of the Service Bus subscription rule.
properties.action: Represents the filter actions that are allowed for the transformation of a message that has been matched by a filter expression.
properties.filterType: Filter type that is evaluated against a BrokeredMessage.
properties.sqlFilter: Properties of sqlFilter.

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.

Examples

Test that the Service Bus subscription rule is of SQL Filter type:

describe azure_service_bus_subscription_rule(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: "SUBSCRIPTION_NAME", topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_RULE_NAME') do
  its('properties.filterType') { should eq 'SqlFilter' }
end

Matchers

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

exists

# If a Service Bus subscription rule is found, it will exist.

describe azure_service_bus_subscription_rule(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: "SUBSCRIPTION_NAME", topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_RULE_NAME') do
  it { should exist }
end

not_exists

# If a Service Bus subscription rule is not found, it will not exist.

describe azure_service_bus_subscription_rule(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: "SUBSCRIPTION_NAME", topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_RULE_NAME') do
  it { should_not exist }
end

Azure permissions

Your Service Principal must be set up with at least a reader role on the subscription you wish to test.

azure_service_bus_subscription_rule resource