ServiceResourceDescription interface

This type describes a service resource.

Extends

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 Properties

id

Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

name

The name of the resource

type

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

autoScalingPolicies

Auto scaling policies

autoScalingPolicies?: AutoScalingPolicy[]

Property Value

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

description

User readable description of the service.

description?: string

Property Value

string

diagnostics

Reference to sinks in DiagnosticsDescription.

diagnostics?: DiagnosticsRef

Property Value

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

networkRefs

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

networkRefs?: NetworkRef[]

Property Value

osType

The operation system required by the code in service.

osType: string

Property Value

string

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

replicaCount

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

replicaCount?: number

Property Value

number

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

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

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 Property Details

id

Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ManagedProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ManagedProxyResource.name

type

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ManagedProxyResource.type