Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ServiceResourceDescription

Package version

interface

An interface representing ServiceResourceDescription. This type describes a service resource.

extends

ManagedProxyResource

Hierarchy

Index

Properties

Properties

Optional autoScalingPolicies

autoScalingPolicies: AutoScalingPolicy[]
member

{AutoScalingPolicy[]} [autoScalingPolicies] Auto scaling policies

codePackages

codePackages: ContainerCodePackageProperties[]
member

{ContainerCodePackageProperties[]} 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.).

Optional description

description: undefined | string
member

{string} [description] User readable description of the service.

Optional diagnostics

diagnostics: DiagnosticsRef
member

{DiagnosticsRef} [diagnostics] Reference to sinks in DiagnosticsDescription.

Optional healthState

healthState: HealthState
member

{HealthState} [healthState] Describes the health state of an application resource. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [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.

Optional name

name: undefined | string
member

{string} [name] The name of the resource

Optional networkRefs

networkRefs: NetworkRef[]
member

{NetworkRef[]} [networkRefs] The names of the private networks that this service needs to be part of.

osType

osType: OperatingSystemType
member

{OperatingSystemType} osType The operation system required by the code in service. Possible values include: 'Linux', 'Windows'

Optional provisioningState

provisioningState: undefined | string
member

{string} [provisioningState] State of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional replicaCount

replicaCount: undefined | number
member

{number} [replicaCount] The number of replicas of the service to create. Defaults to 1 if not specified.

Optional status

status: ResourceStatus
member

{ResourceStatus} [status] Status of the service. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional statusDetails

statusDetails: undefined | string
member

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

Optional type

type: undefined | string
member

{string} [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.

Optional unhealthyEvaluation

unhealthyEvaluation: undefined | string
member

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

Generated using TypeDoc