Microsoft Azure
Microsoft Azure Service Package API

The Service Package API from Microsoft Azure — 5 operation(s) for service package.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Service Package API
schemes:
- https
tags:
- name: Service Package
paths:
  /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages:
    get:
      operationId: microsoftAzureGetdeployedservicepackageinfolist
      summary: Microsoft Azure Gets The List Of Service Packages Deployed On A Service Fabric Node
      description: Returns the information about the service packages deployed on a Service Fabric node for the given application.
      tags:
      - Service Package
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the list of deployed service packages information.
          schema:
            $ref: '#/definitions/DeployedServicePackageInfoList'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}:
    get:
      operationId: microsoftAzureGetdeployedservicepackageinfolistbyname
      summary: Microsoft Azure Gets The List Of Service Packages Deployed On A Service Fabric Node Matching Exactly The Specified Name
      description: Returns the information about the service packages deployed on a Service Fabric node for the given application. These results are of service packages whose name match exactly the service package name specified as the parameter.
      tags:
      - Service Package
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/ServicePackageNameRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the list of deployed service packages information.
          schema:
            $ref: '#/definitions/DeployedServicePackageInfoList'
        '204':
          description: An empty response is returned if the specified service package from the application is not deployed on the node.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth:
    get:
      operationId: microsoftAzureGetdeployedservicepackagehealth
      summary: Microsoft Azure Gets The Information About Health Of A Service Package For A Specific Application Deployed For A Service Fabric Node And Application
      description: Gets the information about health of a service package for a specific application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state.
      tags:
      - Service Package
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/ServicePackageNameRequiredPathParam'
      - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application.
          schema:
            $ref: '#/definitions/DeployedServicePackageHealth'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
    post:
      operationId: microsoftAzureGetdeployedservicepackagehealthusingpolicy
      summary: Microsoft Azure Gets The Information About Health Of Service Package For A Specific Application Deployed On A Service Fabric Node Using The Specified Policy
      description: Gets the information about health of a service package for a specific application deployed on a Service Fabric node. using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed service package.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/ServicePackageNameRequiredPathParam'
      - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ApplicationHealthPolicyOptionalBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Service Package
      responses:
        '200':
          description: A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application.
          schema:
            $ref: '#/definitions/DeployedServicePackageHealth'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/ReportHealth:
    post:
      operationId: microsoftAzureReportdeployedservicepackagehealth
      summary: Microsoft Azure Sends A Health Report On The Service Fabric Deployed Service Package
      description: Reports health state of the service package of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.<br>The report is sent to a Service Fabric gateway Service, which forwards to the health store.<br>The report may be accepted by the gateway, but rejected by the health store after extra validation.<br>For example, the health store may reject the report because of an invalid parameter, like a stale sequence number.<br>To see whether the report was applied in the health store, get deployed service package health and check that the report appears in the HealthEvents section.
      tags:
      - Service Package
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/ServicePackageNameRequiredPathParam'
      - $ref: '#/parameters/HealthInformationRequiredBodyParam'
      - $ref: '#/parameters/ImmediateOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/DeployServicePackage:
    post:
      operationId: microsoftAzureDeployservicepackagetonode
      summary: Microsoft Azure Downloads All Of The Code Packages Associated With Specified Service Manifest On The Specified Node
      description: This API provides a way to download code packages including the container images on a specific node outside of the normal application deployment and upgrade path. This is useful for the large code packages and container images to be present on the node before the actual application deployment and upgrade, thus significantly reducing the total time required for the deployment or upgrade.
      tags:
      - Service Package
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/DeployServicePackageToNodeRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
definitions:
  FabricErrorError:
    description: Error object containing error code and error message.
    properties:
      Code:
        $ref: '#/definitions/FabricErrorCodes'
        description: "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n  - Possible values of the error code for HTTP status code 400 (Bad Request)\n    - \"FABRIC_E_INVALID_PARTITION_KEY\"\n    - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_ADDRESS\"\n    - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n    - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_CONFIGURATION\"\n    - \"FABRIC_E_INVALID_NAME_URI\"\n    - \"FABRIC_E_PATH_TOO_LONG\"\n    - \"FABRIC_E_KEY_TOO_LARGE\"\n    - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n    - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n    - \"FABRIC_E_VALUE_EMPTY\"\n    - \"FABRIC_E_BACKUP_IS_ENABLED\"\n    - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n    - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n    - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n    - \"E_INVALIDARG\"\n\n  - Possible values of the error code for HTTP status code 404 (Not Found)\n    - \"FABRIC_E_NODE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n    - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n    - \"FABRIC_E_PARTITION_NOT_FOUND\"\n    - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n    - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n    - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n    - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n    - \"FABRIC_E_FILE_NOT_FOUND\"\n    - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n    - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n    - \"FABRIC_E_ENUMERATION_COMPLETED\"\n    - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n    - \"FABRIC_E_KEY_NOT_FOUND\"\n    - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n    - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n    - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n    - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n    - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n  - Possible values of the error code for HTTP status code 409 (Conflict)\n    - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n    - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n    - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n    - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n    - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n    - \"FABRIC_E_NAME_NOT_EMPTY\"\n    - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n    - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n    - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n    - \"FABRIC_E_HEALTH_STALE_REPORT\"\n    - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n    - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n    - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n    - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n    - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n    - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n  - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n    - \"FABRIC_E_NODE_IS_UP\"\n    - \"E_FAIL\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n    - \"FABRIC_E_VOLUME_NOT_FOUND\"\n    - \"SerializationError\"\n\n  - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n    - \"FABRIC_E_NO_WRITE_QUORUM\"\n    - \"FABRIC_E_NOT_PRIMARY\"\n    - \"FABRIC_E_NOT_READY\"\n    - \"FABRIC_E_RECONFIGURATION_PENDING\"\n    - \"FABRIC_E_SERVICE_OFFLINE\"\n    - \"E_ABORT\"\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n    - \"FABRIC_E_COMMUNICATION_ERROR\"\n    - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n    - \"FABRIC_E_TIMEOUT\""
      Message:
        type: string
        description: Error message.
    required:
    - Code
  EntityKindHealthStateCount:
    description: Represents health state count for entities of the specified entity kind.
    properties:
      EntityKind:
        $ref: '#/definitions/EntityKind'
        description: The entity kind for which health states are evaluated.
      HealthStateCount:
        $ref: '#/definitions/HealthStateCount'
        description: The health state count for the entities of the specified kind.
  ServicePackageActivationId:
    type: string
    description: 'The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service

      is ''SharedProcess'' (or if it is not specified, in which case it defaults to ''SharedProcess''), then value of ServicePackageActivationId

      is always an empty string.'
  HealthInformation:
    description: Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries.
    required:
    - SourceId
    - Property
    - HealthState
    properties:
      SourceId:
        type: string
        description: The source name that identifies the client/watchdog/system component that generated the health information.
      Property:
        type: string
        description: 'The property of the health information. An entity can have health reports for different properties.

          The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report.

          For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node,

          so it can report "AvailableDisk" property on that node.

          The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node.

          In the health store, these reports are treated as separate health events for the specified node.


          Together with the SourceId, the property uniquely identifies the health information.'
      HealthState:
        $ref: '#/definitions/HealthState'
        description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
      TimeToLiveInMilliSeconds:
        type: string
        format: duration
        description: 'The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration.

          When clients report periodically, they should send reports with higher frequency than time to live.

          If clients report on transition, they can set the time to live to infinite.

          When time to live expires, the health event that contains the health information

          is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false.


          If not specified, time to live defaults to infinite value.'
      Description:
        type: string
        description: 'The description of the health information. It represents free text used to add human readable information about the report.

          The maximum string length for the description is 4096 characters.

          If the provided string is longer, it will be automatically truncated.

          When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters.

          The presence of the marker indicates to users that truncation occurred.

          Note that when truncated, the description has less than 4096 characters from the original string.'
      SequenceNumber:
        type: string
        description: 'The sequence number for this health report as a numeric string.

          The report sequence number is used by the health store to detect stale reports.

          If not specified, a sequence number is auto-generated by the health client when a report is added.'
      RemoveWhenExpired:
        type: boolean
        description: 'Value that indicates whether the report is removed from health store when it expires.

          If set to true, the report is removed from the health store after it expires.

          If set to false, the report is treated as an error when expired. The value of this property is false by default.

          When clients report periodically, they should set RemoveWhenExpired false (default).

          This way, if the reporter has issues (e.g. deadlock) and can''t report, the entity is evaluated at error when the health report expires.

          This flags the entity as being in Error health state.'
      HealthReportId:
        type: string
        description: 'A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at

          aka.ms/sfhealthid'
  HealthEvaluation:
    discriminator: Kind
    description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
    properties:
      Kind:
        $ref: '#/definitions/HealthEvaluationKind'
        description: The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.
      AggregatedHealthState:
        $ref: '#/definitions/HealthState'
        description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
      Description:
        type: string
        description: Description of the health evaluation, which represents a summary of the evaluation process.
    required:
    - Kind
  DeployedServicePackageInfoList:
    type: array
    items:
      $ref: '#/definitions/DeployedServicePackageInfo'
    description: List of deployed service package information.
  DeployedServicePackageHealth:
    description: Information about the health of a service package for a specific application deployed on a Service Fabric node.
    allOf:
    - $ref: '#/definitions/EntityHealth'
    properties:
      ApplicationName:
        $ref: '#/definitions/ApplicationName'
        description: The name of the application, including the 'fabric:' URI scheme.
      ServiceManifestName:
        $ref: '#/definitions/ServiceManifestName'
        description: Name of the service manifest.
      NodeName:
        $ref: '#/definitions/NodeName'
        description: Name of the node where this service package is deployed.
  HealthEvaluationWrapper:
    description: Wrapper object for health evaluation.
    properties:
      HealthEvaluation:
        $ref: '#/definitions/HealthEvaluation'
        description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
  HealthEvent:
    description: Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.
    allOf:
    - $ref: '#/definitions/HealthInformation'
    properties:
      IsExpired:
        type: boolean
        description: Returns true if the health event is expired, otherwise false.
      SourceUtcTimestamp:
        type: string
        format: date-time
        description: The date and time when the health report was sent by the source.
      LastModifiedUtcTimestamp:
        type: string
        format: date-time
        description: The date and time when the health report was last modified by the health store.
      LastOkTransitionAt:
        type: string
        format: date-time
        description: 'If the current health state is ''Ok'', this property returns the time at which the health report was first reported with ''Ok''.

          For periodic reporting, many reports with the same state may have been generated.

          This property returns the date and time when the first ''Ok'' health report was received.


          If the current health state is ''Error'' or ''Warning'', returns the date and time at which the health state was last in ''Ok'', before transitioning to a different state.


          If the health state was never ''Ok'', the value will be zero date-time.'
      LastWarningTransitionAt:
        type: string
        format: date-time
        description: 'If the current health state is ''Warning'', this property returns the time at which the health report was first reported with ''Warning''. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first ''Warning'' health report was received.


          If the current health state is ''Ok'' or ''Error'', returns the date and time at which the health state was last in ''Warning'', before transitioning to a different state.


          If the health state was never ''Warning'', the value will be zero date-time.'
      LastErrorTransitionAt:
        type: string
        format: date-time
        description: 'If the current health state is ''Error'', this property returns the time at which the health report was first reported with ''Error''. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first ''Error'' health report was received.


          If the current health state is ''Ok'' or ''Warning'', returns the date and time at which the health state was last in ''Error'', before transitioning to a different state.


          If the health state was never ''Error'', the value will be zero date-time.'
  HealthEvaluationKind:
    type: string
    description: The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.
    enum:
    - Invalid
    - Event
    - Replicas
    - Partitions
    - DeployedServicePackages
    - DeployedApplications
    - Services
    - Nodes
    - Applications
    - SystemApplication
    - UpgradeDomainDeployedApplications
    - UpgradeDomainNodes
    - Replica
    - Partition
    - DeployedServicePackage
    - DeployedApplication
    - Service
    - Node
    - Application
    - DeltaNodesCheck
    - UpgradeDomainDeltaNodesCheck
    - ApplicationTypeApplications
    - NodeTypeNodes
    x-ms-enum:
      name: HealthEvaluationKind
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates that the health evaluation is invalid. The value is zero.
      - value: Event
        description: Indicates that the health evaluation is for a health event. The value is 1.
      - value: Replicas
        description: Indicates that the health evaluation is for the replicas of a partition. The value is 2.
      - value: Partitions
        description: Indicates that the health evaluation is for the partitions of a service. The value is 3.
      - value: DeployedServicePackages
        description: Indicates that the health evaluation is for the deployed service packages of a deployed application. The value is 4.
      - value: DeployedApplications
        description: Indicates that the health evaluation is for the deployed applications of an application. The value is 5.
      - value: Services
        description: Indicates that the health evaluation is for services of an application. The value is 6.
      - value: Nodes
        description: Indicates that the health evaluation is for the cluster nodes. The value is 7.
      - value: Applications
        description: Indicates that the health evaluation is for the cluster applications. The value is 8.
      - value: SystemApplication
        description: Indicates that the health evaluation is for the system application. The value is 9.
      - value: UpgradeDomainDeployedApplications
        description: Indicates that the health evaluation is for the deployed applications of an application in an upgrade domain. The value is 10.
      - value: UpgradeDomainNodes
        description: Indicates that the health evaluation is for the cluster nodes in an upgrade domain. The value is 11.
      - value: Replica
        description: Indicates that the health evaluation is for a replica. The value is 13.
      - value: Partition
        description: Indicates that the health evaluation is for a partition. The value is 14.
      - value: DeployedServicePackage
        description: Indicates that the health evaluation is for a deployed service package. The value is 16.
      - value: DeployedApplication
        description: Indicates that the health evaluation is for a deployed application. The value is 17.
      - value: Service
        description: Indicates that the health evaluation is for a service. The value is 15.
      - value: Node
        description: Indicates that the health evaluation is for a node. The value is 12.
      - value: Application
        description: Indicates that the health evaluation is for an application. The value is 18.
      - value: DeltaNodesCheck
        description: Indicates that the health evaluation is for the delta of unhealthy cluster nodes. The value is 19.
      - value: UpgradeDomainDeltaNodesCheck
        description: Indicates that the health evaluation is for the delta of unhealthy upgrade domain cluster nodes. The value is 20.
      - value: ApplicationTypeApplications
        description: – Indicates that the health evaluation is for applications of an application type. The value is 21.
      - value: NodeTypeNodes
        description: – Indicates that the health evaluation is for nodes of a node type. The value is 22.
  ApplicationTypeName:
    type: string
    description: The application type name as defined in the application manifest.
  HealthStateCount:
    description: Represents information about how many health entities are in Ok, Warning and Error health state.
    properties:
      OkCount:
        type: integer
        format: int64
        description: The number of health entities with aggregated health state Ok.
        minimum: 0
      WarningCount:
        type: integer
        format: int64
        description: The number of health entities with aggregated health state Warning.
        minimum: 0
      ErrorCount:
        type: integer
        format: int64
        description: The number of health entities with aggregated health state Error.
        minimum: 0
  UnhealthyEvaluations:
    description: List of health evaluations that resulted in the current aggregated health state.
    type: array
    items:
      $ref: '#/definitions/HealthEvaluationWrapper'
  HealthState:
    type: string
    description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
    enum:
    - Invalid
    - Ok
    - Warning
    - Error
    - Unknown
    x-ms-enum:
      name: HealthState
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Ok
        description: Indicates the health state is okay. The value is 1.
      - value: Warning
        description: Indicates the health state is at a warning level. The value is 2.
      - value: Error
        description: 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.
      - value: Unknown
        description: Indicates an unknown health status. The value is 65535.
  ServiceTypeHealthPolicyMap:
    type: array
    items:
      $ref: '#/definitions/ServiceTypeHealthPolicyMapItem'
    description: 'Defines a ServiceTypeHealthPolicy per service type name.


      The entries in the map replace the default service type health policy for each specified service type. For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently. With policy per service type, there''s more granular control of the health of the service.


      If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.'
  ServiceManifestName:
    type: string
    description: The name of the service manifest.
  ApplicationTypeVersion:
    type: string
    description: The version of the application type as defined in the application manifest.
  DeployedServicePackageInfo:
    description: Information about service package deployed on a Service Fabric node.
    properties:
      Name:
        $ref: '#/definitions/ServiceManifestName'
        description: The name of the service package as specified in the service manifest.
      Version:
        type: string
        description: The version of the service package specified in service manifest.
      Status:
        $ref: '#/definitions/DeploymentStatus'
        description: Specifies the status of a deployed application or service package on a Service Fabric node.
      ServicePackageActivationId:
        $ref: '#/definitions/ServicePackageActivationId'
        description: 'The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service

          is ''SharedProcess'' (or if it is not specified, in which case it defaults to ''SharedProcess''), then value of ServicePackageActivationId

          is always an empty string.'
  DeploymentStatus:
    type: string
    description: Specifies the status of a deployed application or service package on a Service Fabric node.
    enum:
    - Invalid
    - Downloading
    - Activating
    - Active
    - Upgrading
    - Deactivating
    - RanToCompletion
    - Failed
    x-ms-enum:
      name: DeploymentStatus
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates status of the application or service package is not known or invalid. The value is 0.
      - value: Downloading
        description: Indicates the application or service package is being downloaded to the node from the ImageStore. The value is 1.
      - value: Activating
        description: Indicates the application or service package is being activated. The value is 2.
      - value: Active
        description: Indicates the application or service package is active the node. The value is 3.
      - value: Upgrading
        description: Indicates the application or service package is being upgraded. The value is 4.
      - value: Deactivating
        description: Indicates the application or service package is being deactivated. The value is 5.
      - value: RanToCompletion
        description: Indicates the application or service package has ran to completion successfully. The value is 6.
      - value: Failed
        description: Indicates th

# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-service-package-api-openapi.yml
Microsoft Azure Service Package API

Documentation

Specifications

Other Resources

OpenAPI Specification
