StatefulServiceUpdateDescription Class

Describes an update for a stateful service.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.servicefabric.models._models_py3.ServiceUpdateDescription

StatefulServiceUpdateDescription

Constructor

StatefulServiceUpdateDescription(*, flags: Optional[str] = None, placement_constraints: Optional[str] = None, correlation_scheme=None, load_metrics=None, service_placement_policies=None, default_move_cost=None, scaling_policies=None, service_dns_name: Optional[str] = None, tags_for_placement=None, tags_for_running=None, target_replica_set_size: Optional[int] = None, min_replica_set_size: Optional[int] = None, replica_restart_wait_duration_seconds: Optional[str] = None, quorum_loss_wait_duration_seconds: Optional[str] = None, stand_by_replica_keep_duration_seconds: Optional[str] = None, service_placement_time_limit_seconds: Optional[str] = None, drop_source_replica_on_move: Optional[bool] = None, replica_lifecycle_description=None, auxiliary_replica_count: Optional[int] = None, **kwargs)

Parameters

flags

str

Required

Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise 'OR' operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set.

• None - Does not indicate any other properties are set. The value is zero.
• TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1.
• ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2.
• QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4.
• StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8.
• MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16.
• PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32.
• PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64.
• Correlation - Indicates the CorrelationScheme property is set. The value is 128.
• Metrics - Indicates the ServiceLoadMetrics property is set. The value is

• DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512.
• ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024.
• ServicePlacementTimeLimit - Indicates the ServicePlacementTimeLimit property is set. The value is 2048.
• MinInstanceCount - Indicates the MinInstanceCount property is set. The value is 4096.
• MinInstancePercentage - Indicates the MinInstancePercentage property is set. The value is 8192.
• InstanceCloseDelayDuration - Indicates the InstanceCloseDelayDuration property is set. The value is 16384.
• InstanceRestartWaitDuration - Indicates the InstanceCloseDelayDuration property is set. The value is 32768.
• DropSourceReplicaOnMove - Indicates the DropSourceReplicaOnMove property is set. The value is 65536.
• ServiceDnsName - Indicates the ServiceDnsName property is set. The value is 131072.
• TagsForPlacement - Indicates the TagsForPlacement property is set. The value is 1048576.
• TagsForRunning - Indicates the TagsForRunning property is set. The value is 2097152.

placement_constraints

str

Required

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

correlation_scheme

list[ServiceCorrelationDescription]

Required

The correlation scheme.

load_metrics

list[ServiceLoadMetricDescription]

Required

The service load metrics.

service_placement_policies

list[ServicePlacementPolicyDescription]

Required

The service placement policies.

default_move_cost

str or MoveCost

Required

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

scaling_policies

list[ScalingPolicyDescription]

Required

Scaling policies for this service.

service_dns_name

str

Required

The DNS name of the service.

tags_for_placement

NodeTagsDescription

Required

Tags for placement of this service.

tags_for_running

NodeTagsDescription

Required

Tags for running of this service.

service_kind

str

Required

Required. Constant filled by server.

target_replica_set_size

int

Required

The target replica set size as a number.

min_replica_set_size

int

Required

The minimum replica set size as a number.

replica_restart_wait_duration_seconds

str

Required

The duration, in seconds, between when a replica goes down and when a new replica is created.

quorum_loss_wait_duration_seconds

str

Required

The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss.

stand_by_replica_keep_duration_seconds

str

Required

The definition on how long StandBy replicas should be maintained before being removed.

service_placement_time_limit_seconds

str

Required

The duration for which replicas can stay InBuild before reporting that build is stuck.

drop_source_replica_on_move

bool

Required

Indicates whether to drop source Secondary replica even if the target replica has not finished build. If desired behavior is to drop it as soon as possible the value of this property is true, if not it is false.

replica_lifecycle_description

ReplicaLifecycleDescription

Required

Defines how replicas of this service will behave during their lifecycle.

auxiliary_replica_count

int

Required

The auxiliary replica count as a number. To use Auxiliary replicas, the following must be true: AuxiliaryReplicaCount < (TargetReplicaSetSize+1)/2 and TargetReplicaSetSize >=3.