azure_service_bus_regions resource

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

Note

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

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

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