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.
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
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, refer to Azure documentation for other properties available.
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
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 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.