ServiceResourceDescription.yml

### YamlMime:TSType
name: ServiceResourceDescription
uid: '@azure/arm-servicefabricmesh.ServiceResourceDescription'
package: '@azure/arm-servicefabricmesh'
summary: This type describes a service resource.
fullName: ServiceResourceDescription
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: autoScalingPolicies
    uid: >-
      @azure/arm-servicefabricmesh.ServiceResourceDescription.autoScalingPolicies
    package: '@azure/arm-servicefabricmesh'
    summary: Auto scaling policies
    fullName: autoScalingPolicies
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'autoScalingPolicies?: AutoScalingPolicy[]'
      return:
        description: ''
        type: <xref uid="@azure/arm-servicefabricmesh.AutoScalingPolicy" />[]
  - name: codePackages
    uid: '@azure/arm-servicefabricmesh.ServiceResourceDescription.codePackages'
    package: '@azure/arm-servicefabricmesh'
    summary: >-
      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.).
    fullName: codePackages
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'codePackages: ContainerCodePackageProperties[]'
      return:
        description: ''
        type: >-
          <xref
          uid="@azure/arm-servicefabricmesh.ContainerCodePackageProperties" />[]
  - name: description
    uid: '@azure/arm-servicefabricmesh.ServiceResourceDescription.description'
    package: '@azure/arm-servicefabricmesh'
    summary: User readable description of the service.
    fullName: description
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'description?: string'
      return:
        description: ''
        type: string
  - name: diagnostics
    uid: '@azure/arm-servicefabricmesh.ServiceResourceDescription.diagnostics'
    package: '@azure/arm-servicefabricmesh'
    summary: Reference to sinks in DiagnosticsDescription.
    fullName: diagnostics
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'diagnostics?: DiagnosticsRef'
      return:
        description: ''
        type: <xref uid="@azure/arm-servicefabricmesh.DiagnosticsRef" />
  - name: healthState
    uid: '@azure/arm-servicefabricmesh.ServiceResourceDescription.healthState'
    package: '@azure/arm-servicefabricmesh'
    summary: >-
      Describes the health state of an application resource.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: healthState
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'healthState?: string'
      return:
        description: ''
        type: string
  - name: networkRefs
    uid: '@azure/arm-servicefabricmesh.ServiceResourceDescription.networkRefs'
    package: '@azure/arm-servicefabricmesh'
    summary: The names of the private networks that this service needs to be part of.
    fullName: networkRefs
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'networkRefs?: NetworkRef[]'
      return:
        description: ''
        type: <xref uid="@azure/arm-servicefabricmesh.NetworkRef" />[]
  - name: osType
    uid: '@azure/arm-servicefabricmesh.ServiceResourceDescription.osType'
    package: '@azure/arm-servicefabricmesh'
    summary: The operation system required by the code in service.
    fullName: osType
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'osType: string'
      return:
        description: ''
        type: string
  - name: provisioningState
    uid: '@azure/arm-servicefabricmesh.ServiceResourceDescription.provisioningState'
    package: '@azure/arm-servicefabricmesh'
    summary: >-
      State of the resource.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: provisioningState
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'provisioningState?: string'
      return:
        description: ''
        type: string
  - name: replicaCount
    uid: '@azure/arm-servicefabricmesh.ServiceResourceDescription.replicaCount'
    package: '@azure/arm-servicefabricmesh'
    summary: >-
      The number of replicas of the service to create. Defaults to 1 if not
      specified.
    fullName: replicaCount
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'replicaCount?: number'
      return:
        description: ''
        type: number
  - name: status
    uid: '@azure/arm-servicefabricmesh.ServiceResourceDescription.status'
    package: '@azure/arm-servicefabricmesh'
    summary: >-
      Status of the service.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: status
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'status?: string'
      return:
        description: ''
        type: string
  - name: statusDetails
    uid: '@azure/arm-servicefabricmesh.ServiceResourceDescription.statusDetails'
    package: '@azure/arm-servicefabricmesh'
    summary: >-
      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.
    fullName: statusDetails
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'statusDetails?: string'
      return:
        description: ''
        type: string
  - name: unhealthyEvaluation
    uid: >-
      @azure/arm-servicefabricmesh.ServiceResourceDescription.unhealthyEvaluation
    package: '@azure/arm-servicefabricmesh'
    summary: >-
      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.
    fullName: unhealthyEvaluation
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'unhealthyEvaluation?: string'
      return:
        description: ''
        type: string
inheritedProperties:
  - name: id
    uid: '@azure/arm-servicefabricmesh.ServiceResourceDescription.id'
    package: '@azure/arm-servicefabricmesh'
    summary: >-
      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.
    fullName: id
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'id?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ManagedProxyResource.id](xref:@azure/arm-servicefabricmesh.ManagedProxyResource.id)
  - name: name
    uid: '@azure/arm-servicefabricmesh.ServiceResourceDescription.name'
    package: '@azure/arm-servicefabricmesh'
    summary: The name of the resource
    fullName: name
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'name?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ManagedProxyResource.name](xref:@azure/arm-servicefabricmesh.ManagedProxyResource.name)
  - name: type
    uid: '@azure/arm-servicefabricmesh.ServiceResourceDescription.type'
    package: '@azure/arm-servicefabricmesh'
    summary: >-
      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.
    fullName: type
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'type?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ManagedProxyResource.type](xref:@azure/arm-servicefabricmesh.ManagedProxyResource.type)
extends: <xref uid="@azure/arm-servicefabricmesh.ManagedProxyResource" />