ServiceDescription Class

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

You probably want to use the sub-classes and not this class directly. Known sub-classes are: StatefulServiceDescription, StatelessServiceDescription

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

Inheritance

Model

ServiceDescription

Constructor

ServiceDescription(*, service_name: str, service_type_name: str, partition_description, application_name: Optional[str] = None, initialization_data=None, placement_constraints: Optional[str] = None, correlation_scheme=None, service_load_metrics=None, service_placement_policies=None, default_move_cost=None, is_default_move_cost_specified: Optional[bool] = None, service_package_activation_mode=None, service_dns_name: Optional[str] = None, scaling_policies=None, tags_required_to_place=None, tags_required_to_run=None, **kwargs)

Parameters

application_name

str

Required

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

service_name

str

Required

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

service_type_name

str

Required

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

initialization_data

list[int]

Required

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

partition_description

PartitionSchemeDescription

Required

Required. The partition description as an object.

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.

service_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'

is_default_move_cost_specified

bool

Required

Indicates if the DefaultMoveCost property is specified.

service_package_activation_mode

str or ServicePackageActivationMode

Required

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

service_dns_name

str

Required

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

scaling_policies

list[ScalingPolicyDescription]

Required

Scaling policies for this service.

tags_required_to_place

NodeTagsDescription

Required

Tags for placement of this service.

tags_required_to_run

NodeTagsDescription

Required

Tags for running of this service.

service_kind

str

Required

Required. Constant filled by server.