azure_service_fabric_mesh_service Resource

[edit on GitHub]

Use the azure_service_fabric_mesh_service InSpec audit resource to test properties of an Azure Service Fabric Mesh service.

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

describe azure_service_fabric_mesh_service(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do
  it                                      { should exist }
  its('type')                             { should eq 'Microsoft.ServiceFabricMesh/applications' }
end

describe azure_service_fabric_mesh_service(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do
  it  { should exist }
end

Parameters

name (required)

Name of the Azure Service Fabric Mesh service to test.

resource_group (required)

Azure resource group that the targeted resource resides in.

Properties

id

Resource Id.

name

Resource name.

type

Resource type. Microsoft.ServiceFabricMesh/services.

properties

The properties of the SERVICE FABRIC MESH SERVICE.

properties.osType

The Operating system type required by the code in service.

properties.replicaCount

The number of replicas of the service to create. Defaults to 1 if not specified.

properties.healthState

Describes the health state of an services resource.

For properties applicable to all resources, such as type, name, id, properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available.

Examples

Test that the SERVICE FABRIC MESH SERVICE is healthy.

describe azure_service_fabric_mesh_service(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do
  its('properties.healthState') { should eq 'Ok' }
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 a SERVICE FABRIC MESH SERVICE is found it will exist

describe azure_service_fabric_mesh_service(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do
  it { should exist }
end
# if SERVICE FABRIC MESH SERVICE is not found it will not exist

describe azure_service_fabric_mesh_service(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_SERVICE_NAME') do
  it { should_not exist }
end

Azure Permissions

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