ServiceResourceProperties interface

This type describes properties of a service resource.

Extends

Inherited Properties

autoScalingPolicies

Auto scaling policies

codePackages

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

description

User readable description of the service.

diagnostics

Reference to sinks in DiagnosticsDescription.

healthState

Describes the health state of an application resource. NOTE: This property will not be serialized. It can only be populated by the server.

networkRefs

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

osType

The operation system required by the code in service.

provisioningState

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

replicaCount

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

status

Status of the service. NOTE: This property will not be serialized. It can only be populated by the server.

statusDetails

Gives additional information about the current status of the service. NOTE: This property will not be serialized. It can only be populated by the server.

unhealthyEvaluation

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. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Property Details

autoScalingPolicies

Auto scaling policies

autoScalingPolicies?: AutoScalingPolicy[]

Property Value

Inherited From ServiceProperties.autoScalingPolicies

codePackages

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

codePackages: ContainerCodePackageProperties[]

Property Value

Inherited From ServiceReplicaProperties.codePackages

description

User readable description of the service.

description?: string

Property Value

string

Inherited From ServiceProperties.description

diagnostics

Reference to sinks in DiagnosticsDescription.

diagnostics?: DiagnosticsRef

Property Value

Inherited From ServiceReplicaProperties.diagnostics

healthState

Describes the health state of an application resource. NOTE: This property will not be serialized. It can only be populated by the server.

healthState?: string

Property Value

string

Inherited From ServiceProperties.healthState

networkRefs

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

networkRefs?: NetworkRef[]

Property Value

Inherited From ServiceReplicaProperties.networkRefs

osType

The operation system required by the code in service.

osType: string

Property Value

string

Inherited From ServiceReplicaProperties.osType

provisioningState

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

provisioningState?: string

Property Value

string

Inherited From ProvisionedResourceProperties.provisioningState

replicaCount

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

replicaCount?: number

Property Value

number

Inherited From ServiceProperties.replicaCount

status

Status of the service. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

Inherited From ServiceProperties.status

statusDetails

Gives additional information about the current status of the service. NOTE: This property will not be serialized. It can only be populated by the server.

statusDetails?: string

Property Value

string

Inherited From ServiceProperties.statusDetails

unhealthyEvaluation

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. NOTE: This property will not be serialized. It can only be populated by the server.

unhealthyEvaluation?: string

Property Value

string

Inherited From ServiceProperties.unhealthyEvaluation