azure_service_bus_regions Resource

[edit on GitHub]

Use the azure_service_bus_regions InSpec audit resource to test the properties related to all Azure Service Bus regions.

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

An azure_service_bus_regions resource block returns all Azure Service Bus regions.

describe azure_service_bus_regions(sku: 'SKU_NAME') do
  #...
end

Parameters

sku (required)

The sku type.

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 regions.

Field: properties

locations

A list of the resource locations.

Field: location

codes

A list of region codes.

Field: code

fullNames

A list of full names of the regions.

Field: fullName

Examples

Test that there are Service Bus regions that are successfully provisioned

describe azure_service_bus_regions(sku: 'SKU_NAME').where(code: 'Central US') do
  it { should exist }
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

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

describe azure_service_bus_regions(sku: 'SKU_NAME') do
  it { should_not exist }
end

not_exists

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

describe azure_service_bus_regions(sku: 'SKU_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.