Share via

ServiceResourceProperties

  • Article

This type describes properties of a service resource.

Properties

Name Type Required
osType string (enum) Yes
codePackages array of ContainerCodePackageProperties Yes
networkRefs array of NetworkRef No
diagnostics DiagnosticsRef No
description string No
replicaCount integer No
executionPolicy ExecutionPolicy No
autoScalingPolicies array of AutoScalingPolicy No
status string (enum) No
statusDetails string No
healthState string (enum) No
unhealthyEvaluation string No
identityRefs array of ServiceIdentity No
dnsName string No

osType

Type: string (enum)
Required: Yes

The operation system required by the code in service.

Possible values are:

  • Linux - The required operating system is Linux.
  • Windows - The required operating system is Windows.

codePackages

Type: array of ContainerCodePackageProperties
Required: Yes

Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).

networkRefs

Type: array of NetworkRef
Required: No

The names of the private networks that this service needs to be part of.

diagnostics

Type: DiagnosticsRef
Required: No

Reference to sinks in DiagnosticsDescription.

description

Type: string
Required: No

User readable description of the service.

replicaCount

Type: integer
Required: No

The number of replicas of the service to create. Defaults to 1 if not specified.

executionPolicy

Type: ExecutionPolicy
Required: No

The execution policy of the service

autoScalingPolicies

Type: array of AutoScalingPolicy
Required: No

Auto scaling policies

status

Type: string (enum)
Required: No

Status of the resource.

Possible values are:

  • Unknown - Indicates the resource status is unknown. The value is zero.
  • Ready - Indicates the resource is ready. The value is 1.
  • Upgrading - Indicates the resource is upgrading. The value is 2.
  • Creating - Indicates the resource is being created. The value is 3.
  • Deleting - Indicates the resource is being deleted. The value is 4.
  • Failed - Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5.

statusDetails

Type: string
Required: No

Gives additional information about the current status of the service.

healthState

Type: string (enum)
Required: No

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.

Possible values are:

  • Invalid - Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
  • Ok - Indicates the health state is okay. The value is 1.
  • Warning - Indicates the health state is at a warning level. The value is 2.
  • Error - Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.
  • Unknown - Indicates an unknown health status. The value is 65535.

unhealthyEvaluation

Type: string
Required: No

When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy.

identityRefs

Type: array of ServiceIdentity
Required: No

The service identity list.

dnsName

Type: string
Required: No

Dns name of the service.