azure_service_fabric_mesh_volumes Resource

[edit on GitHub]

Use the azure_service_fabric_mesh_volumes InSpec audit resource to test the properties of all Azure Service Fabric Mesh volumes.

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_fabric_mesh_volumes resource block returns all Azure Service Fabric Mesh volumes.

describe azure_service_fabric_mesh_volumes do
  #...
end

Parameters

resource_group (optional)

Azure resource group where the targeted resource resides.

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 Fabric Mesh volumes.

Field: properties

locations

A list of the Geo-locations.

Field: location

provisioningStates

A list of provisioning states of the Service Fabric Mesh volumes.

Field: provisioningState

providers

A list of providers of the volume.

Field: provider

shareNames

A list of the Name of the Azure Files file share that provides storage for the volume.

Field: shareName

Examples

Loop through Service Fabric Mesh volumes by their names

azure_service_fabric_mesh_volumes(resource_group: 'RESOURCE_GROUP').names.each do |name|
  describe azure_service_fabric_mesh_volume(resource_group: 'RESOURCE_GROUP', name: name) do
    it { should exist }
  end
end

Test that there are Service Fabric Mesh volumes that are successfully provisioned

describe azure_service_fabric_mesh_volumes(resource_group: 'RESOURCE_GROUP').where(provisioningState: 'Succeeded') 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 Fabric Mesh volumes are present.

describe azure_service_fabric_mesh_volumes(resource_group: 'RESOURCE_GROUP') do
  it { should_not exist }
end

not_exists

# Should exist if the filter returns at least one Service Fabric Mesh volume.

describe azure_service_fabric_mesh_volumes(resource_group: 'RESOURCE_GROUP') 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.