azure_service_fabric_mesh_network resource

Use the azure_service_fabric_mesh_network InSpec audit resource to test the properties of an Azure Service Fabric Mesh network.

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

name and resource_group are required parameters.

describe azure_service_fabric_mesh_network(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_NETWORK_NAME') do
  it                                      { should exist }
  its('type')                             { should eq 'Microsoft.ServiceFabricMesh/networks' }
  its('location')                         { should eq 'eastus' }
end

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

Parameters

name

Name of the Azure Service Fabric Mesh networks to test.

resource_group

Azure resource group where the targeted resource resides.

The parameter set that should be provided for a valid query is resource_group and name.

Properties

id

Resource ID.

name

Resource name.

type

Resource type. Microsoft.ServiceFabricMesh/networks.

location

The Geo-location where the resource lives.

properties

The properties of the Service Fabric Mesh network.

properties.addressPrefix

the address prefix for this network.

properties.provisioningState

State of the resource.

properties.ingressConfig.qosLevel

The QoS tier for ingress.

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

Also, see the Azure documentation for other available properties.

Examples

Test that the Service Fabric Mesh network is provisioned successfully:

describe azure_service_fabric_mesh_network(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_NETWORK_NAME') do
  its('properties.provisioningState') { should eq 'Succeeded' }
end

Matchers

This resource has the following special matchers.

exists

# If a Service Fabric Mesh network is found, it will exist.

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

not_exists

# If a Service Fabric Mesh network is not found, it will not exist.

describe azure_service_fabric_mesh_network(resource_group: 'RESOURCE_GROUP', name: 'SERVICE_FABRIC_MESH_NETWORK_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.