azure_blob_services Resource

Use the azure_blob_services Chef InSpec audit resource to test the properties and configuration of multiple Azure storage accounts’ Blob services.

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

An azure_blob_services resource block returns all Azure Blob Service, either within a Resource Group (if provided) or within an entire Subscription.

describe azure_blob_services(resource_group: 'RESOURCE_GROUP_NAME', storage_account_name: 'STORAGE_ACCOUNT_NAME') do
  it { should exist }
end

Parameters

resource_group: Azure resource group where the targeted resource resides.
storage_account_name: Name of the Storage account to test.

Properties

ids: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}; Field: id
names: The name of the resource.; Field: name
properties: The property of the resource.; Field: properties
skus: Sku name and tier.; Field: sku
types: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”; Field: type

Note

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

See Azure’s documentation on Blob services for a full list of available properties.

Examples

Test that an example Resource Group has the named storage account

describe azure_blob_services(resource_group: 'RESOURCE_GROUP_NAME', storage_account_name: 'STORAGE_ACCOUNT_NAME') do
  its('names') { should include('STORAGE_ACCOUNT_NAME') }
end

See integration tests for more examples.

Matchers

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

exist

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

describe azure_blob_services(resource_group: 'RESOURCE_GROUP_NAME', storage_account_name: 'STORAGE_ACCOUNT_NAME') do
  it { should exist }
end

describe azure_blob_services(resource_group: 'RESOURCE_GROUP_NAME', storage_account_name: 'STORAGE_ACCOUNT_NAME') 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.