azure_service_fabric_mesh_service Resource
Use the azure_service_fabric_mesh_service
InSpec audit resource to test the 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.
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
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 where the targeted resource resides.
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 a services resource.
For properties applicable to all resources, such as type
, name
, id
, and 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
For a full list of available matchers, see our Universal Matchers page.This resource has the following special matchers.
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
not_exists
# 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.