mesh_service

Creates, updates, deletes, gets or lists a mesh_service resource.

Overview

Name	mesh_service
Type	Resource
Id	azure.service_fabric_dataplane.mesh_service

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string
autoScalingPolicies	array
codePackages	array
description	string
diagnostics	object	Reference to sinks in DiagnosticsDescription.
dnsName	string
executionPolicy	object	The execution policy of the service. You probably want to use the sub-classes and not this class directly. Known sub-classes are: DefaultExecutionPolicy, RunToCompletionExecutionPolicy All required parameters must be populated in order to send to Azure.
healthState	string	Describes the health state of an application resource. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
identityRefs	array
networkRefs	array
osType	string
replicaCount	integer
status	string	Status of the service. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'
statusDetails	string	Gives additional information about the current status of the service.
unhealthyEvaluation	string	When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy.

list

Name	Datatype	Description
ContinuationToken	string
Items	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	application_resource_name, service_resource_name, endpoint		Gets the Service resource with the given name. Gets the information about the Service resource with the given name. The information include the description and other properties of the Service.
list	select	application_resource_name, endpoint		Lists all the service resources. Gets the information about all services of an application resource. The information include the description and other properties of the Service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application_resource_name	string	The identity of the application.
endpoint	string	The service endpoint host (no scheme). (default: )
service_resource_name	string	The identity of the service.

SELECT examples

get

Gets the Service resource with the given name. Gets the information about the Service resource with the given name. The information include the description and other properties of the Service.

SELECT
name,
autoScalingPolicies,
codePackages,
description,
diagnostics,
dnsName,
executionPolicy,
healthState,
identityRefs,
networkRefs,
osType,
replicaCount,
status,
statusDetails,
unhealthyEvaluation
FROM azure.service_fabric_dataplane.mesh_service
WHERE application_resource_name = '{{ application_resource_name }}' -- required
AND service_resource_name = '{{ service_resource_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

Lists all the service resources. Gets the information about all services of an application resource. The information include the description and other properties of the Service.

SELECT
ContinuationToken,
Items
FROM azure.service_fabric_dataplane.mesh_service
WHERE application_resource_name = '{{ application_resource_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;