ServiceResource interface

The service resource.

Extends

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.

serviceDnsName

Dns name used for the service. If this is specified, then the service can be accessed via its DNS name instead of service name.

serviceKind

The kind of service (Stateless or Stateful).

serviceLoadMetrics

The service load metrics is given as an array of ServiceLoadMetricDescription 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

Inherited Properties

etag

Azure resource etag. NOTE: This property will not be serialized. It can only be populated by the server.

id

Azure resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

location

It will be deprecated in New API, resource location depends on the parent resource.

name

Azure resource name. NOTE: This property will not be serialized. It can only be populated by the server.

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

tags

Azure resource tags.

type

Azure resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

correlationScheme

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

correlationScheme?: ServiceCorrelationDescription[]

Property Value

defaultMoveCost

Specifies the move cost for the service.

defaultMoveCost?: string

Property Value

string

partitionDescription

Describes how the service is partitioned.

partitionDescription?: PartitionSchemeDescriptionUnion

Property Value

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

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 service can be accessed via its DNS name instead of service name.

serviceDnsName?: string

Property Value

string

serviceKind

The kind of service (Stateless or Stateful).

serviceKind?: string

Property Value

string

serviceLoadMetrics

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

serviceLoadMetrics?: ServiceLoadMetricDescription[]

Property Value

servicePackageActivationMode

The activation Mode of the service package

servicePackageActivationMode?: string

Property Value

string

servicePlacementPolicies

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

servicePlacementPolicies?: ServicePlacementPolicyDescription[]

Property Value

serviceTypeName

The name of the service type

serviceTypeName?: string

Property Value

string

Inherited Property Details

etag

Azure resource etag. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

Inherited From ProxyResource.etag

id

Azure resource identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

location

It will be deprecated in New API, resource location depends on the parent resource.

location?: string

Property Value

string

Inherited From ProxyResource.location

name

Azure resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

Inherited From ProxyResource.systemData

tags

Azure resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From ProxyResource.tags

type

Azure resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type