StatefulServiceProperties
The properties of a stateful service resource.
Properties
| Name | Type | Required |
|---|---|---|
| serviceKind | string | Yes |
| placementConstraints | string | No |
| correlationScheme | array of ServiceCorrelationDescription | No |
| serviceLoadMetrics | array of ServiceLoadMetricDescription | No |
| servicePlacementPolicies | array of ServicePlacementPolicyDescription | No |
| defaultMoveCost | string (enum) | No |
| provisioningState | string | No |
| serviceTypeName | string | No |
| partitionDescription | PartitionSchemeDescription | No |
| hasPersistedState | boolean | No |
| targetReplicaSetSize | integer | No |
| minReplicaSetSize | integer | No |
| replicaRestartWaitDuration | string (date-time) | No |
| quorumLossWaitDuration | string (date-time) | No |
| standByReplicaKeepDuration | string (date-time) | No |
serviceKind
Type: string
Required: Yes
A discriminator property. Its value must be 'Stateful' for objects of type 'StatefulServiceProperties'.
placementConstraints
Type: string
Required: No
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)".
correlationScheme
Type: array of ServiceCorrelationDescription
Required: No
A list that describes the correlation of the service with other services.
serviceLoadMetrics
Type: array of ServiceLoadMetricDescription
Required: No
The service load metrics is given as an array of ServiceLoadMetricDescription objects.
servicePlacementPolicies
Type: array of ServicePlacementPolicyDescription
Required: No
A list that describes the correlation of the service with other services.
defaultMoveCost
Type: string (enum)
Required: No
Specifies the move cost for the service.
Possible values are:
- Zero - Zero move cost. This value is zero.
- Low - Specifies the move cost of the service as Low. The value is 1.
- Medium - Specifies the move cost of the service as Medium. The value is 2.
- High - Specifies the move cost of the service as High. The value is 3.
provisioningState
Type: string
Required: No
The current deployment or provisioning state, which only appears in the response
serviceTypeName
Type: string
Required: No
The name of the service type
partitionDescription
Type: PartitionSchemeDescription
Required: No
Describes how the service is partitioned.
hasPersistedState
Type: boolean
Required: No
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.
targetReplicaSetSize
Type: integer
Required: No
InclusiveMinimum: 1
The target replica set size as a number.
minReplicaSetSize
Type: integer
Required: No
InclusiveMinimum: 1
The minimum replica set size as a number.
replicaRestartWaitDuration
Type: string (date-time)
Required: No
The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format (hh:mm:ss.s).
quorumLossWaitDuration
Type: string (date-time)
Required: No
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.s).
standByReplicaKeepDuration
Type: string (date-time)
Required: No
The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format (hh:mm:ss.s).