Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceDescription

Package version

A ServiceDescription contains all of the information necessary to create a service.

Hierarchy

  • ServiceDescription

Index

Properties

Optional applicationName

applicationName: undefined | string

The name of the application, including the 'fabric:' URI scheme.

Optional correlationScheme

correlationScheme: ServiceCorrelationDescription[]

The correlation scheme.

Optional defaultMoveCost

defaultMoveCost: MoveCost

The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High'

Optional initializationData

initializationData: number[]

The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created.

Optional isDefaultMoveCostSpecified

isDefaultMoveCostSpecified: undefined | false | true

Indicates if the DefaultMoveCost property is specified.

partitionDescription

partitionDescription: PartitionSchemeDescriptionUnion

The partition description as an object.

Optional placementConstraints

placementConstraints: undefined | string

The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".

Optional scalingPolicies

scalingPolicies: ScalingPolicyDescription[]

Scaling policies for this service.

Optional serviceDnsName

serviceDnsName: undefined | string

The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.

serviceKind

serviceKind: "ServiceDescription"

Polymorphic Discriminator

Optional serviceLoadMetrics

serviceLoadMetrics: ServiceLoadMetricDescription[]

The service load metrics.

serviceName

serviceName: string

The full name of the service with 'fabric:' URI scheme.

Optional servicePackageActivationMode

servicePackageActivationMode: ServicePackageActivationMode

The activation mode of service package to be used for a service. Possible values include: 'SharedProcess', 'ExclusiveProcess'

Optional servicePlacementPolicies

servicePlacementPolicies: ServicePlacementPolicyDescriptionUnion[]

The service placement policies.

serviceTypeName

serviceTypeName: string

Name of the service type as specified in the service manifest.

Generated using TypeDoc