azure_service_fabric_mesh_replicas Resource

[edit on GitHub]

Use the azure_service_fabric_mesh_replicas InSpec audit resource to test the properties of all Azure Service Fabric Mesh replicas.

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

describe azure_service_fabric_mesh_replicas(resource_group: 'RESOURCE_GROUP', application_name: 'SERVICE_FABRIC_MESH_APPLICATION_NAME', service_name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do
  #...
end

Parameters

resource_group (required)

Azure resource group where the targeted resource resides.

application_name (required)

The identity of the application.

service_name (required)

The identity of the service.

Properties

osTypes

A list of OS Types.

Field: osType

codePackages

A list of code packages.

Field: codePackages

networkRefs

A list of the network refs.

Field: networkRefs

replicaNames

A list of the replica names.

Field: replicaName

Examples

Test that there are Service Fabric Mesh replicas with at least one replica

describe azure_service_fabric_mesh_replicas(resource_group: 'RESOURCE_GROUP', application_name: 'SERVICE_FABRIC_MESH_APPLICATION_NAME', service_name: 'SERVICE_FABRIC_MESH_SERVICE_NAME').where{ replicaName > 1 } 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 replicas are present.

describe azure_service_fabric_mesh_replicas(resource_group: 'RESOURCE_GROUP', application_name: 'SERVICE_FABRIC_MESH_APPLICATION_NAME', service_name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do
  it { should_not exist }
end

not_exists

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

describe azure_service_fabric_mesh_replicas(resource_group: 'RESOURCE_GROUP', application_name: 'SERVICE_FABRIC_MESH_APPLICATION_NAME', service_name: 'SERVICE_FABRIC_MESH_SERVICE_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.