azure_storage_account_blob_container Resource
Use the azure_storage_account_blob_container
InSpec audit resource to test the properties related to a Blob Container in 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.
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
resource_group
, storage_account_name
, and name
or the resource_id
are required parameters.
describe azure_storage_account_blob_container(resource_group: 'RESOURCE_GROUP', storage_account_name: 'ACCOUNT_NAME', name: 'LOGS') do
it { should exist }
end
describe azure_storage_account_blob_container(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}') do
it { should exist }
end
Parameters
resource_group
- Azure resource group where the targeted resource resides.
storage_account_name
- The name of the storage account within the specified resource group.
name
- The name of the blob container within the specified storage account.
blob_container_name
- Alias for the
name
parameter. resource_id
- The unique resource ID.
Either one of the parameter sets can be provided for a valid query:
resource_id
resource_group
,storage_account_name
andname
resource_group
,storage_account_name
andblob_container_name
Properties
properties.deleted
- Indicates whether the Blob Container was deleted.
properties.lastModifiedTime
- Returns the date and time the container was last modified.
properties.remainingRetentionDays
- Remaining retention days for soft deleted blob container.
properties.publicAccess
- Specifies whether data in the container may be accessed publicly and the level of access. See here for valid values.
For properties applicable to all resources, such as type
, tags
, id
, and properties
, refer to azure_generic_resource
.
Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed with the key names separated by dots (.
).
Examples
Test if a Blob Container is deleted
describe azure_storage_account_blob_container(resource_group: 'RESOURCE_GROUP', storage_account_name: 'DEFAULT', name: 'LOGS') do
its('properties.deleted') { should be true }
end
Ensure that the Blob Container is private
describe azure_storage_account_blob_container(resource_group: 'RESOURCE_GROUP', storage_account_name: 'PRODUCTION', name: 'LOGS') do
its('properties') { should have_attributes(publicAccess: 'None') }
end
Loop through resources via ‘resource_id’
azure_storage_account_blob_containers.(resource_group: 'RESOURCE_GROUP', storage_account_name: 'PRODUCTION').ids.each do |id|
describe azure_storage_account_blob_container(resource_id: id) do
its('properties') { should have_attributes(publicAccess: 'None') }
end
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
# If we expect the resource to always exist.
describe azure_storage_account_blob_container(resource_group: 'RESOURCE_GROUP', storage_account_name: 'PRODUCTION', name: 'LOGS') do
it { should exist }
end
not_exists
# If we expect the resource to never exist.
describe azure_storage_account_blob_container(resource_group: 'RESOURCE_GROUP', storage_account_name: 'PRODUCTION', name: 'LOGS') 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.