Share via

StatefulServiceProperties interface

  • Reference
Package:
@azure/arm-servicefabricmanagedclusters

The properties of a stateful service resource.

Extends
ServiceResourceProperties

Properties

hasPersistedState

A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false.
minReplicaSetSize

The minimum replica set size as a number.
quorumLossWaitDuration

The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format "hh:mm:ss".
replicaRestartWaitDuration

The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss".
serviceKind

Polymorphic discriminator, which specifies the different types this object can be
servicePlacementTimeLimit

The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss".
standByReplicaKeepDuration

The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss".
targetReplicaSetSize

The target replica set size as a number.

Inherited Properties

correlationScheme

A list that describes the correlation of the service with other services.
defaultMoveCost

Specifies the move cost for the service.
partitionDescription

Describes how the service is partitioned.
placementConstraints

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)".
provisioningState

The current deployment or provisioning state, which only appears in the response NOTE: This property will not be serialized. It can only be populated by the server.
scalingPolicies

Scaling policies for this service.
serviceDnsName

Dns name used for the service. If this is specified, then the DNS name can be used to return the IP addresses of service endpoints for application layer protocols (e.g., HTTP). When updating serviceDnsName, old name may be temporarily resolvable. However, rely on new name. When removing serviceDnsName, removed name may temporarily be resolvable. Do not rely on the name being unresolvable.
serviceLoadMetrics

The service load metrics is given as an array of ServiceLoadMetric objects.
servicePackageActivationMode

The activation Mode of the service package
servicePlacementPolicies

A list that describes the correlation of the service with other services.
serviceTypeName

The name of the service type

Property Details

hasPersistedState

A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false.

hasPersistedState?: boolean

Property Value

boolean

minReplicaSetSize

The minimum replica set size as a number.

minReplicaSetSize?: number

Property Value

number

quorumLossWaitDuration

The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format "hh:mm:ss".

quorumLossWaitDuration?: string

Property Value

string

replicaRestartWaitDuration

The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss".

replicaRestartWaitDuration?: string

Property Value

string

serviceKind

Polymorphic discriminator, which specifies the different types this object can be

serviceKind: "Stateful"

Property Value

"Stateful"

servicePlacementTimeLimit

The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss".

servicePlacementTimeLimit?: string

Property Value

string

standByReplicaKeepDuration

The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss".

standByReplicaKeepDuration?: string

Property Value

string

targetReplicaSetSize

The target replica set size as a number.

targetReplicaSetSize?: number

Property Value

number

Inherited Property Details

correlationScheme

A list that describes the correlation of the service with other services.

correlationScheme?: ServiceCorrelation[]

Property Value

ServiceCorrelation[]

Inherited From ServiceResourceProperties.correlationScheme

defaultMoveCost

Specifies the move cost for the service.

defaultMoveCost?: string

Property Value

string

Inherited From ServiceResourceProperties.defaultMoveCost

partitionDescription

Describes how the service is partitioned.

partitionDescription: PartitionUnion

Property Value

PartitionUnion

Inherited From ServiceResourceProperties.partitionDescription

placementConstraints

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)".

placementConstraints?: string

Property Value

string

Inherited From ServiceResourceProperties.placementConstraints

provisioningState

The current deployment or provisioning state, which only appears in the response NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

Inherited From ServiceResourceProperties.provisioningState

scalingPolicies

Scaling policies for this service.

scalingPolicies?: ScalingPolicy[]

Property Value

ScalingPolicy[]

Inherited From ServiceResourceProperties.scalingPolicies

serviceDnsName

Dns name used for the service. If this is specified, then the DNS name can be used to return the IP addresses of service endpoints for application layer protocols (e.g., HTTP). When updating serviceDnsName, old name may be temporarily resolvable. However, rely on new name. When removing serviceDnsName, removed name may temporarily be resolvable. Do not rely on the name being unresolvable.

serviceDnsName?: string

Property Value

string

Inherited From ServiceResourceProperties.serviceDnsName

serviceLoadMetrics

The service load metrics is given as an array of ServiceLoadMetric objects.

serviceLoadMetrics?: ServiceLoadMetric[]

Property Value

ServiceLoadMetric[]

Inherited From ServiceResourceProperties.serviceLoadMetrics

servicePackageActivationMode

The activation Mode of the service package

servicePackageActivationMode?: string

Property Value

string

Inherited From ServiceResourceProperties.servicePackageActivationMode

servicePlacementPolicies

A list that describes the correlation of the service with other services.

servicePlacementPolicies?: ServicePlacementPolicyUnion[]

Property Value

ServicePlacementPolicyUnion[]

Inherited From ServiceResourceProperties.servicePlacementPolicies

serviceTypeName

The name of the service type

serviceTypeName: string

Property Value

string

Inherited From ServiceResourceProperties.serviceTypeName