ServiceResourceProperties interface

The service resource properties.

Extends

Properties

partitionDescription

Describes how the service is partitioned.

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.

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.

serviceKind

The kind of service (Stateless or Stateful).

servicePackageActivationMode

The activation Mode of the service package

serviceTypeName

The name of the service type

Inherited Properties

correlationScheme

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

defaultMoveCost

Specifies the move cost for the service.

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

scalingPolicies

Scaling policies for this service.

serviceLoadMetrics

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

servicePlacementPolicies

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

Property Details

partitionDescription

Describes how the service is partitioned.

partitionDescription: PartitionUnion

Property Value

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

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

serviceKind

The kind of service (Stateless or Stateful).

serviceKind: string

Property Value

string

servicePackageActivationMode

The activation Mode of the service package

servicePackageActivationMode?: string

Property Value

string

serviceTypeName

The name of the service type

serviceTypeName: string

Property Value

string

Inherited Property Details

correlationScheme

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

correlationScheme?: ServiceCorrelation[]

Property Value

Inherited From ServiceResourcePropertiesBase.correlationScheme

defaultMoveCost

Specifies the move cost for the service.

defaultMoveCost?: string

Property Value

string

Inherited From ServiceResourcePropertiesBase.defaultMoveCost

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 ServiceResourcePropertiesBase.placementConstraints

scalingPolicies

Scaling policies for this service.

scalingPolicies?: ScalingPolicy[]

Property Value

Inherited From ServiceResourcePropertiesBase.scalingPolicies

serviceLoadMetrics

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

serviceLoadMetrics?: ServiceLoadMetric[]

Property Value

Inherited From ServiceResourcePropertiesBase.serviceLoadMetrics

servicePlacementPolicies

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

servicePlacementPolicies?: ServicePlacementPolicyUnion[]

Property Value

Inherited From ServiceResourcePropertiesBase.servicePlacementPolicies