azure_service_bus_namespace Resource

Use the azure_service_bus_namespace InSpec audit resource to test the properties related to an Azure Service Bus Namespace.

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

name and resource_group are required parameters.

describe azure_service_bus_namespace(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_BUS_NAMESPACE') do
  it                                      { should exist }
  its('type')                             { should eq 'Microsoft.ServiceBus/Namespaces' }
  its('location')                         { should eq 'East US' }
end

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

Parameters

name (required)

Name of the Azure Service Bus namespaces to test.

resource_group (required)

Azure resource group where the targeted resource resides.

Properties

id

Resource ID.

name

Resource name.

type

Resource type. Microsoft.ServiceBus/Namespaces.

location

The Geo-location where the resource lives.

properties

The properties of the Service Bus Namespace.

properties.serviceBusEndpoint

Endpoint you can use to perform Service Bus operations.

properties.metricId

Identifier for Azure Insights metrics.

properties.provisioningState

Provisioning state of the Namespace.

sku.name

Name of this SKU.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available.

Examples

Test that the Service Bus Namespaces are provisioned successfully

describe azure_service_bus_namespace(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_BUS_NAMESPACE') do
  its('properties.provisioningState') { should eq 'Succeeded' }
end

Matchers

This resource has the following special matchers.

exists

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

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

not_exists

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

describe azure_service_bus_namespace(resource_group: 'RESOURCE_GROUP', 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.