ServiceResourceProperties

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
healthState string (enum) No
status string (enum) No

osType

Type: string (enum)
Required: Yes

The Operating system type required by the code in service.


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.


healthState

Type: string (enum)
Required: No

Describes the health state of an services resource.

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.

status

Type: string (enum)
Required: No