azure_service_bus_subscription resource

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

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(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_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 to test.

namespace_name (required)

The namespace 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.

properties.lockDuration

ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

properties.status

Enumerates the possible values for the status of a messaging entity.

properties.countDetails

Message count details.

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 is active:

describe azure_service_bus_subscription(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_NAME') do
  its('properties.status') { should eq 'Active' }
end

Matchers

This resource has the following special matchers.

exists

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

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

not_exists

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

describe azure_service_bus_subscription(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', topic_name: 'TOPIC_NAME', name: 'SUBSCRIPTION_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.