azure_service_fabric_mesh_services resource

Use the azure_service_fabric_mesh_services InSpec audit resource to test the properties of all Azure Service Fabric Mesh services within a project.

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

An azure_service_fabric_mesh_services resource block returns all Azure service Fabric Mesh services within a project.

describe azure_service_fabric_mesh_services 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 services.
Field: properties
osTypes: The Operating system type required by the code in services.
Field: replicaCount
replicaCounts: The number of replicas of the service to create. Defaults to 1 if not specified.
Field: metricId
healthStates: The health state of a services resource.
Field: healthState

Note

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

Examples

Loop through service Fabric Mesh services by their names:

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

Test that there are service Fabric Mesh services that are healthy:

describe azure_service_fabric_mesh_services(resource_group: 'RESOURCE_GROUP').where(replicaCounts: 2) do
  it { should exist }
end

Matchers

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

This resource has the following special matchers.

exists

# Should not exist if no service Fabric Mesh services are present.

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

not_exists

# Should exist if the filter returns at least one service Fabric Mesh services.

describe azure_service_fabric_mesh_services(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.