Microsoft Azure Services API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Services API
schemes:
- https
tags:
- name: Services
paths:
  /Services/{serviceId}/$/GetApplicationName:
    get:
      summary: Microsoft Azure Gets The Name Of The Service Fabric Application For A Service
      description: Gets the name of the application for the specified service. A 404 FABRIC_E_SERVICE_DOES_NOT_EXIST error is returned if a service with the provided service ID does not exist.
      operationId: microsoftAzureGetapplicationnameinfo
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Services
      responses:
        '200':
          description: Information about the name of the application for the specified service.
          schema:
            $ref: '#/definitions/ApplicationNameInfo'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Services/{serviceId}/$/Delete:
    post:
      summary: Microsoft Azure Deletes An Existing Service Fabric Service
      description: A service must be created before it can be deleted. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if the service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the service.
      operationId: microsoftAzureDeleteservice
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/parameters/ForceRemoveOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Services
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Services/{serviceId}/$/Update:
    post:
      operationId: microsoftAzureUpdateservice
      summary: Microsoft Azure Updates A Service Fabric Service Using The Specified Update Description
      description: This API allows updating properties of a running Service Fabric service. The set of properties that can be updated are a subset of the properties that were specified at the time of creating the service. The current set of properties can be obtained using `GetServiceDescription` API. Note that updating the properties of a running service is different than upgrading your application using `StartApplicationUpgrade` API. The upgrade is a long running background operation that involves moving the application from one version to another, one upgrade domain at a time, whereas update applies the new properties immediately to the service.
      x-ms-examples:
        Stateless service:
          $ref: ./examples/UpdateService-1.json
        Stateful service:
          $ref: ./examples/UpdateService-2.json
      tags:
      - Services
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/parameters/ServiceUpdateDescriptionRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 202 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Services/{serviceId}/$/GetDescription:
    get:
      summary: Microsoft Azure Gets The Description Of An Existing Service Fabric Service
      description: Gets the description of an existing Service Fabric service. A service must be created before its description can be obtained.
      operationId: microsoftAzureGetservicedescription
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Services
      responses:
        '200':
          description: A successful operation will return 200 status code.
          schema:
            $ref: '#/definitions/ServiceDescription'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Services/{serviceId}/$/GetHealth:
    get:
      summary: Microsoft Azure Gets The Health Of The Specified Service Fabric Service
      description: Gets the health information of the specified service.<br>Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.<br>Use PartitionsHealthStateFilter to filter the collection of partitions returned.<br>If you specify a service that does not exist in the health store, this request returns an error.
      operationId: microsoftAzureGetservicehealth
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/PartitionsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ExcludeHealthStatisticsOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Services
      responses:
        '200':
          description: A successful operation will return 200 status code and the health information of the specified service.
          schema:
            $ref: '#/definitions/ServiceHealth'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
    post:
      summary: Microsoft Azure Gets The Health Of The Specified Service Fabric Service, By Using The Specified Health Policy
      description: Gets the health information of the specified service.<br>If the application health policy is specified, the health evaluation uses it to get the aggregated health state.<br>If the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest.<br>Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.<br>Use PartitionsHealthStateFilter to filter the collection of partitions returned.<br>If you specify a service that does not exist in the health store, this request returns an error.
      operationId: microsoftAzureGetservicehealthusingpolicy
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/PartitionsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ApplicationHealthPolicyOptionalBodyParam'
      - $ref: '#/parameters/ExcludeHealthStatisticsOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Services
      responses:
        '200':
          description: A successful operation will return 200 status code and the health information of the specified service.
          schema:
            $ref: '#/definitions/ServiceHealth'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Services/{serviceId}/$/ReportHealth:
    post:
      operationId: microsoftAzureReportservicehealth
      summary: Microsoft Azure Sends A Health Report On The Service Fabric Service
      description: Reports health state of the specified Service Fabric service. 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, run GetServiceHealth and check that the report appears in the HealthEvents section.
      tags:
      - Services
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ServiceIdRequiredPathParam'
      - $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'
  /Services/{serviceId}/$/ResolvePartition:
    get:
      operationId: microsoftAzureResolveservice
      summary: Microsoft Azure Resolve A Service Fabric Partition
      description: Resolve a Service Fabric service partition to get the endpoints of the service replicas.
      tags:
      - Services
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/parameters/PartitionKeyTypeOptionalQueryParam'
      - $ref: '#/parameters/PartitionKeyValueOptionalQueryParam'
      - $ref: '#/parameters/PreviousRspVersionOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
          schema:
            $ref: '#/definitions/ResolvedServicePartition'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Services/{serviceId}/$/GetUnplacedReplicaInformation:
    get:
      summary: Microsoft Azure Gets The Information About Unplaced Replica Of The Service
      description: Returns the information about the unplaced replicas of the service.<br>If PartitionId is specified, then result will contain information only about unplaced replicas for that partition.<br>If PartitionId is not specified, then result will contain information about unplaced replicas for all partitions of that service.<br>If OnlyQueryPrimaries is set to true, then result will contain information only about primary replicas, and will ignore unplaced secondary replicas.
      operationId: microsoftAzureGetunplacedreplicainformation
      parameters:
      - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/parameters/PartitionIdOptionalQueryParam'
      - $ref: '#/parameters/OnlyQueryPrimariesOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Services
      responses:
        '200':
          description: Information about the specified service.
          schema:
            $ref: '#/definitions/UnplacedReplicaInformation'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
definitions:
  ScalingPolicyDescriptionList:
    type: array
    items:
      $ref: '#/definitions/ScalingPolicyDescription'
    description: A list that describes the scaling policies.
  CorrelationSchemeList:
    type: array
    items:
      $ref: '#/definitions/ServiceCorrelationDescription'
    description: A list that describes the correlation of the service with other services.
  PartitionScheme:
    type: string
    description: Enumerates the ways that a service can be partitioned.
    enum:
    - Invalid
    - Singleton
    - UniformInt64Range
    - Named
    x-ms-enum:
      name: PartitionScheme
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Singleton
        description: Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1.
      - value: UniformInt64Range
        description: Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2.
      - value: Named
        description: Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3
  ServicePlacementPolicyType:
    type: string
    description: The type of placement policy for a service fabric service. Following are the possible values.
    enum:
    - Invalid
    - InvalidDomain
    - RequireDomain
    - PreferPrimaryDomain
    - RequireDomainDistribution
    - NonPartiallyPlaceService
    - AllowMultipleStatelessInstancesOnNode
    x-ms-enum:
      name: ServicePlacementPolicyType
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: InvalidDomain
        description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 1.
      - value: RequireDomain
        description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2.
      - value: PreferPrimaryDomain
        description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3.
      - value: RequireDomainDistribution
        description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 4.
      - value: NonPartiallyPlaceService
        description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 5.
      - value: AllowMultipleStatelessInstancesOnNode
        description: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementAllowMultipleStatelessInstancesOnNodePolicyDescription, which indicates that multiple stateless instances of a particular partition of the service can be placed on a node. The value is 6.
  ScalingTriggerKind:
    type: string
    description: Enumerates the ways that a service can be scaled.
    enum:
    - Invalid
    - AveragePartitionLoad
    - AverageServiceLoad
    x-ms-enum:
      name: ScalingTriggerKind
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the scaling trigger is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: AveragePartitionLoad
        description: Indicates a trigger where scaling decisions are made based on average load of a partition. The value is 1.
      - value: AverageServiceLoad
        description: Indicates a trigger where scaling decisions are made based on average load of a service. The value is 2.
  ServiceEndpointRole:
    type: string
    description: The role of the replica where the endpoint is reported.
    enum:
    - Invalid
    - Stateless
    - StatefulPrimary
    - StatefulSecondary
    x-ms-enum:
      name: ServiceEndpointRole
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the service endpoint role is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Stateless
        description: Indicates that the service endpoint is of a stateless service. The value is 1.
      - value: StatefulPrimary
        description: Indicates that the service endpoint is of a primary replica of a stateful service. The value is 2.
      - value: StatefulSecondary
        description: Indicates that the service endpoint is of a secondary replica of a stateful service. The value is 3.
  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
  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.
  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.
  ServicePlacementPoliciesList:
    type: array
    items:
      $ref: '#/definitions/ServicePlacementPolicyDescription'
    description: A list that describes the correlation of the service with other services.
  ResolvedServiceEndpointList:
    type: array
    items:
      $ref: '#/definitions/ResolvedServiceEndpoint'
    description: List of resolved service endpoints of a service partition.
  UnplacedReplicaInformation:
    description: Contains information for an unplaced replica.
    properties:
      ServiceName:
        $ref: '#/definitions/ServiceName'
        description: The name of the service.
      PartitionId:
        $ref: '#/definitions/PartitionId'
        description: The ID of the partition.
      UnplacedReplicaDetails:
        type: array
        items:
          type: string
        description: List of reasons due to which a replica cannot be placed.
  ServiceHealth:
    description: Information about the health of a Service Fabric service.
    allOf:
    - $ref: '#/definitions/EntityHealth'
    properties:
      Name:
        $ref: '#/definitions/ServiceName'
        description: The name of the service whose health information is described by this object.
      PartitionHealthStates:
        type: array
        items:
          $ref: '#/definitions/PartitionHealthState'
        description: The list of partition health states associated with the service.
  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'
  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
  PartitionId:
    type: string
    format: uuid
    description: An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the serv

# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-services-api-openapi.yml