service_descriptions

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

Overview

Name	service_descriptions
Type	Resource
Id	azure.service_fabric_dataplane.service_descriptions

Fields

The following fields are returned by SELECT queries:

get_service_description

Name	Datatype	Description
ApplicationName	string
CorrelationScheme	array
DefaultMoveCost	string
InitializationData	array
IsDefaultMoveCostSpecified	boolean
PartitionDescription	object	Describes how the service is partitioned. You probably want to use the sub-classes and not this class directly. Known sub-classes are: NamedPartitionSchemeDescription, SingletonPartitionSchemeDescription, UniformInt64RangePartitionSchemeDescription All required parameters must be populated in order to send to Azure.
PlacementConstraints	string
ScalingPolicies	array
ServiceDnsName	string
ServiceKind	string
ServiceLoadMetrics	array
ServiceName	string
ServicePackageActivationMode	string
ServicePlacementPolicies	array
ServiceTypeName	string
TagsRequiredToPlace	object	Describes the tags required for placement or running of the service. All required parameters must be populated in order to send to Azure.
TagsRequiredToRun	object	Describes the tags required for placement or running of the service. All required parameters must be populated in order to send to Azure.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_service_description	select	service_id, endpoint	timeout	Gets the description of an existing Service Fabric service. Gets the description of an existing Service Fabric service. A service must be created before its description can be obtained.

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
endpoint	string	The service endpoint host (no scheme). (default: )
service_id	string	The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myappapp1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
timeout	integer (int64)	The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

SELECT examples

get_service_description

Gets the description of an existing Service Fabric service. Gets the description of an existing Service Fabric service. A service must be created before its description can be obtained.

SELECT
ApplicationName,
CorrelationScheme,
DefaultMoveCost,
InitializationData,
IsDefaultMoveCostSpecified,
PartitionDescription,
PlacementConstraints,
ScalingPolicies,
ServiceDnsName,
ServiceKind,
ServiceLoadMetrics,
ServiceName,
ServicePackageActivationMode,
ServicePlacementPolicies,
ServiceTypeName,
TagsRequiredToPlace,
TagsRequiredToRun
FROM azure.service_fabric_dataplane.service_descriptions
WHERE service_id = '{{ service_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND timeout = '{{ timeout }}'
;