azure_service_bus_subscription

Use the azure_service_bus_subscription_rules InSpec audit resource to test the properties related to all Azure Service Bus subscription rules.

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, this resource uses the latest version. For more information, refer to the azure_generic_resource document.

Unless defined, this resource uses the azure_cloud global endpoint and default values for the HTTP client. For more information, refer to the resource pack README.

Install

This resource is available in the Chef InSpec Azure resource pack.

For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.

Syntax

An azure_service_bus_subscription_rules resource block returns all Azure Service Bus subscription rules.

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

Parameters

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

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 subscription rules.; Field: properties
filterTypes: A list of the filter types.; Field: filterType
sqlFilter: A list of sqlFilters.; Field: sqlFilter

Note

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

Examples

Test that there are Service Bus subscription rules that are of SQL Filter type

describe azure_service_bus_subscription_rules(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: 'SUBSCRIPTION_NAME', topic_name: 'TOPIC_NAME').where(filterType: 'SqlFilter') 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 subscription rules are present.

describe azure_service_bus_subscription_rules(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: 'SUBSCRIPTION_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 rule.

describe azure_service_bus_subscription_rules(resource_group: 'RESOURCE_GROUP', namespace_name: 'NAMESPACE_NAME', subscription_name: 'SUBSCRIPTION_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.

azure_service_bus_subscription_rules Resource