StatelessServiceProperties interface

The properties of a stateless service resource.

Extends

Properties

instanceCount

The instance count.

minInstanceCount

MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.

minInstancePercentage

MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.

serviceKind

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

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

instanceCount

The instance count.

instanceCount: number

Property Value

number

minInstanceCount

MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.

minInstanceCount?: number

Property Value

number

minInstancePercentage

MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service.

minInstancePercentage?: number

Property Value

number

serviceKind

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

serviceKind: "Stateless"

Property Value

"Stateless"

Inherited Property Details

correlationScheme

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

correlationScheme?: ServiceCorrelation[]

Property Value

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

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

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

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

Inherited From ServiceResourceProperties.servicePlacementPolicies

serviceTypeName

The name of the service type

serviceTypeName: string

Property Value

string

Inherited From ServiceResourceProperties.serviceTypeName