azure_service_bus_subscriptions resource

Use the azure_service_bus_subscriptions InSpec audit resource to test the properties related to all Azure Service Bus subscriptions.

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

An azure_service_bus_subscriptions resource block returns all Azure Service Bus subscriptions.

describe azure_service_bus_subscriptions(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', topic_name: 'TOPIC_NAME') do
  #...
end

Parameters

namespace_name (required): The namespace name.
topic_name (required): The topic name.
resource_group (required): Azure resource group where the targeted resource resides.

Properties

ids: A list of resource IDs.
Field: id
names: A list of resource names.
Field: name
types: A list of the resource types.
Field: type
properties: A list of properties for all the Service Bus subscriptions.
Field: properties
lockDurations: A list of the lock duration timespans.
Field: lockDuration
statuses: A list of statuses of a messaging entity.
Field: status

Note

For information on using filter criteria on plural resources, see the documentation on FilterTable

Examples

Test that there are Service Bus subscriptions that are active:

describe azure_service_bus_subscriptions(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', topic_name: 'TOPIC_NAME').where(status: 'Active') do
  it { should exist }
end

Matchers

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

This resource has the following special matchers.

exists

# Should not exist if no Service Bus subscriptions are present.

describe azure_service_bus_subscriptions(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', topic_name: 'TOPIC_NAME') do
  it { should_not exist }
end

not_exists

# Should exist if the filter returns at least one Service Bus subscription.

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

Azure permissions

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