azure_service_bus_topic Resource

[edit on GitHub]

Use the azure_service_bus_topic InSpec audit resource to test properties related to an Azure Service Bus topic.

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.

Installation

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

See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.

Syntax

describe azure_service_bus_topic(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME', name: 'SERVICE_BUS_NAMESPACE') do
  it                                      { should exist }
  its('type')                             { should eq 'Microsoft.ServiceBus/Namespaces/Topics' }
end

describe azure_service_bus_topic(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME', name: 'SERVICE_BUS_NAMESPACE') do
  it  { should exist }
end

Parameters

name (required)

Name of the Azure Service Bus topics to test.

resource_group (required)

Azure resource group that the targeted resource resides in. MyResourceGroup.

namespace_name (required)

Name of the namespace where the topic resides in.

Properties

id

Resource Id.

name

Resource name.

type

Resource type. Microsoft.ServiceBus/Namespaces/Topics.

properties

The properties of the Service Bus topic.

properties.maxSizeInMegabytes

Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.

properties.sizeInBytes

Size of the topic, in bytes.

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, properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available.

Examples

Test that the Service Bus topics is provisioned successfully.

describe azure_service_bus_topic(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME', name: 'SERVICE_BUS_NAMESPACE') do
  its('properties.status') { should eq 'Active' }
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 a Service Bus topic is found it will exist

describe azure_service_bus_topic(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME', name: 'SERVICE_BUS_NAMESPACE') do
  it { should exist }
end
# if Service Bus topic is not found it will not exist

describe azure_service_bus_topic(resource_group: 'RESOURCE_GROUP', namespace_name: 'SERVICE_BUS_NAMESPACE_NAME', name: 'SERVICE_BUS_NAMESPACE') 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.