azure_storage_account_blob_containers Resource

[edit on GitHub]

Use the azure_storage_account_blob_containers InSpec audit resource to test properties and configuration of Blob Containers within an Azure Storage Account.

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

The resource_group, and storage_account_name must be given as a parameter.

describe azurerm_storage_account_blob_containers(resource_group: 'rg', storage_account_name: 'production') do
  its('names') { should include 'my-container'}
end

Parameters

resource_group

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

storage_account_name

The name of the storage account within the specified resource group. accountName.

Properties

ids

A list of the unique resource ids.

Field: id

locations

A list of locations for all the resources being interrogated.

Field: location

names

A list of names of all the resources being interrogated.

Field: name

tags

A list of tag:value pairs defined on the resources being interrogated.

Field: tags

etags

A list of etags defined on the resources.

Field: etag

Examples

Check If a Specific Container Exists.

describe azurerm_storage_account_blob_containers(resource_group: 'rg', storage_account_name: 'production') do
  its('names') { should include('my-container') }
end

exists.

The control will pass if the filter returns at least one result. Use should_not if you expect zero matches.

**If we expect at least one resource to exists on a specified account.**

describe azurerm_storage_account_blob_containers(resource_group: 'rg', storage_account_name: 'production') do
  it { should exist }
end

**If we expect not to exist any containers on a specified account.**

describe azurerm_storage_account_blob_containers(resource_group: 'rg', storage_account_name: 'production') do
  it { should_not exist }
end

Azure Permissions

Your Service Principal must be set up with at least a contributor role on the subscription you wish to test.