Microsoft Azure Partition API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Partition API
schemes:
- https
tags:
- name: Partition
paths:
  /$/GetLoadedPartitionInfoList:
    get:
      summary: Microsoft Azure Gets Ordered List Of Partitions
      description: Retrieves partitions which are most/least loaded according to specified metric.
      operationId: microsoftAzureGetloadedpartitioninfolist
      tags:
      - Partition
      parameters:
      - $ref: '#/parameters/ApiVersion_8-0_RequiredQueryParam'
      - $ref: '#/parameters/MetricNameRequiredQueryParam'
      - $ref: '#/parameters/ServiceNameOptionalQueryParam'
      - $ref: '#/parameters/OrderingOptionalQueryParam'
      - $ref: '#/parameters/MaxResultsOptionalQueryParam'
      - $ref: '#/parameters/ContinuationTokenOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster load information.
          schema:
            $ref: '#/definitions/LoadedPartitionInformationResultList'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Services/{serviceId}/$/GetPartitions:
    get:
      summary: Microsoft Azure Gets The List Of Partitions Of A Service Fabric Service
      description: The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.
      operationId: microsoftAzureGetpartitioninfolist
      parameters:
      - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/parameters/ContinuationTokenOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Partition
      responses:
        '200':
          description: List of partitions of a Service Fabric service.
          schema:
            $ref: '#/definitions/PagedServicePartitionInfoList'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Partitions/{partitionId}:
    get:
      summary: Microsoft Azure Gets The Information About A Service Fabric Partition
      description: Gets the information about the specified partition. The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.
      operationId: microsoftAzureGetpartitioninfo
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Partition
      responses:
        '200':
          description: Information about the specified partition.
          schema:
            $ref: '#/definitions/ServicePartitionInfo'
        '204':
          description: An empty response is returned if the specified partitionId is not found in the cluster.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Partitions/{partitionId}/$/GetServiceName:
    get:
      summary: Microsoft Azure Gets The Name Of The Service Fabric Service For A Partition
      description: Gets name of the service for the specified partition. A 404 error is returned if the partition ID does not exist in the cluster.
      operationId: microsoftAzureGetservicenameinfo
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Partition
      responses:
        '200':
          description: Information about the name of the service for the specified partition.
          schema:
            $ref: '#/definitions/ServiceNameInfo'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Partitions/{partitionId}/$/GetHealth:
    get:
      summary: Microsoft Azure Gets The Health Of The Specified Service Fabric Partition
      description: Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.<br>Use ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition.<br>If you specify a partition that does not exist in the health store, this request returns an error.
      operationId: microsoftAzureGetpartitionhealth
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ReplicasHealthStateFilerOptionalQueryParam'
      - $ref: '#/parameters/ExcludeHealthStatisticsOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Partition
      responses:
        '200':
          description: A successful operation will return 200 status code and the health information about the specified partition.
          schema:
            $ref: '#/definitions/PartitionHealth'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
    post:
      summary: Microsoft Azure Gets The Health Of The Specified Service Fabric Partition, By Using The Specified Health Policy
      description: Gets the health information of the specified partition.<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 partition based on the health state.<br>Use ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition. Use ApplicationHealthPolicy in the POST body to override the health policies used to evaluate the health.<br>If you specify a partition that does not exist in the health store, this request returns an error.
      operationId: microsoftAzureGetpartitionhealthusingpolicy
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ReplicasHealthStateFilerOptionalQueryParam'
      - $ref: '#/parameters/ApplicationHealthPolicyOptionalBodyParam'
      - $ref: '#/parameters/ExcludeHealthStatisticsOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Partition
      responses:
        '200':
          description: A successful operation will return 200 status code and the health information about the specified partition.
          schema:
            $ref: '#/definitions/PartitionHealth'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Partitions/{partitionId}/$/ReportHealth:
    post:
      operationId: microsoftAzureReportpartitionhealth
      summary: Microsoft Azure Sends A Health Report On The Service Fabric Partition
      description: Reports health state of the specified Service Fabric partition. 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 Partition, 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 GetPartitionHealth and check that the report appears in the HealthEvents section.
      tags:
      - Partition
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $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'
  /Partitions/{partitionId}/$/GetLoadInformation:
    get:
      summary: Microsoft Azure Gets The Load Information Of The Specified Service Fabric Partition
      description: Returns information about the load of a specified partition.<br>The response includes a list of load reports for a Service Fabric partition.<br>Each report includes the load metric name, value, and last reported time in UTC.
      operationId: microsoftAzureGetpartitionloadinformation
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Partition
      responses:
        '200':
          description: Information about the specified partition's last reported load metrics.
          schema:
            $ref: '#/definitions/PartitionLoadInformation'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Partitions/{partitionId}/$/ResetLoad:
    post:
      operationId: microsoftAzureResetpartitionload
      summary: Microsoft Azure Resets The Current Load Of A Service Fabric Partition
      description: Resets the current load of a Service Fabric partition to the default load for the service.
      tags:
      - Partition
      parameters:
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation request will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Partitions/{partitionId}/$/Recover:
    post:
      operationId: microsoftAzureRecoverpartition
      summary: Microsoft Azure Indicates To The Service Fabric Cluster That It Should Attempt To Recover A Specific Partition That Is Currently Stuck In Quorum Loss
      description: This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.
      tags:
      - Partition
      parameters:
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation request will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Services/$/{serviceId}/$/GetPartitions/$/Recover:
    post:
      operationId: microsoftAzureRecoverservicepartitions
      summary: Microsoft Azure Indicates To The Service Fabric Cluster That It Should Attempt To Recover The Specified Service That Is Currently Stuck In Quorum Loss
      description: Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.
      tags:
      - Partition
      parameters:
      - $ref: '#/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation request will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/RecoverSystemPartitions:
    post:
      operationId: microsoftAzureRecoversystempartitions
      summary: Microsoft Azure Indicates To The Service Fabric Cluster That It Should Attempt To Recover The System Services That Are Currently Stuck In Quorum Loss
      description: Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.
      tags:
      - Partition
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation request will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/RecoverAllPartitions:
    post:
      operationId: microsoftAzureRecoverallpartitions
      summary: Microsoft Azure Indicates To The Service Fabric Cluster That It Should Attempt To Recover Any Services Including System Services Which Are Currently Stuck In Quorum Loss
      description: This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.
      tags:
      - Partition
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation request will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Partitions/{partitionId}/$/MovePrimaryReplica:
    post:
      operationId: microsoftAzureMoveprimaryreplica
      summary: Microsoft Azure Moves The Primary Replica Of A Partition Of A Stateful Service
      description: This command moves the primary replica of a partition of a stateful service, respecting all constraints.<br>If NodeName parameter is specified, primary will be moved to the specified node (if constraints allow it).<br>If NodeName parameter is not specified, primary replica will be moved to a random node in the cluster.<br>If IgnoreConstraints parameter is specified and set to true, then primary will be moved regardless of the constraints.
      tags:
      - Partition
      parameters:
      - $ref: '#/parameters/ApiVersion_6-5_RequiredQueryParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/NodeNameOptionalParam'
      - $ref: '#/parameters/IgnoreConstraintsOptionalParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation request will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Partitions/{partitionId}/$/MoveSecondaryReplica:
    post:
      operationId: microsoftAzureMovesecondaryreplica
      summary: Microsoft Azure Moves The Secondary Replica Of A Partition Of A Stateful Service
      description: This command moves the secondary replica of a partition of a stateful service, respecting all constraints.<br>CurrentNodeName parameter must be specified to identify the replica that is moved.<br>Source node name must be specified, but new node name can be omitted, and in that case replica is moved to a random node.<br>If IgnoreConstraints parameter is specified and set to true, then secondary will be moved regardless of the constraints.
      tags:
      - Partition
      parameters:
      - $ref: '#/parameters/ApiVersion_6-5_RequiredQueryParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/CurrentNodeNameRequiredParam'
      - $ref: '#/parameters/NewNodeNameOptionalParam'
      - $ref: '#/parameters/IgnoreConstraintsOptionalParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation request will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/UpdatePartitionLoad:
    post:
      operationId: microsoftAzureUpdatepartitionload
      summary: Microsoft Azure Update The Loads Of Provided Partitions For Specific Metrics
      description: Updates the load value and predicted load value for all the partitions provided for specified metrics.
      tags:
      - Partition
      parameters:
      - $ref: '#/parameters/ApiVersion_7-2_RequiredQueryParam'
      - $ref: '#/parameters/PartitionMetricLoadDescriptionListRequiredParam'
      - $ref: '#/parameters/ContinuationTokenOptionalQueryParam'
      - $ref: '#/parameters/MaxResultsOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: List UpdatePartitionLoadResults.
          schema:
            $ref: '#/definitions/PagedUpdatePartitionLoadResultList'
        default:
          description: The error code response per specified partition.
          schema:
            $ref: '#/definitions/FabricError'
  /Services/{serviceId}/$/GetPartitions/{partitionId}/$/MoveInstance:
    post:
      operationId: microsoftAzureMoveinstance
      summary: Microsoft Azure Moves The Instance Of A Partition Of A Stateless Service
      description: This command moves the instance of a partition of a stateless service, respecting all constraints.<br>Partition id and service name must be specified to be able to move the instance.<br>CurrentNodeName when specified identifies the instance that is moved. If not specified, random instance will be moved <br>New node name can be omitted, and in that case instance is moved to a random node.<br>If IgnoreConstraints parameter is specified and set to true, then instance will be moved regardless of the constraints.
      tags:
      - Partition
      parameters:
      - $ref: '#/parameters/ApiVersion_8-0_RequiredQueryParam'
      - $ref: '#/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/CurrentNodeNameOptionalParam'
      - $ref: '#/parameters/NewNodeNameOptionalParam'
      - $ref: '#/parameters/IgnoreConstraintsOptionalParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation request will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Services/{serviceId}/$/GetPartitions/{partitionId}/$/MoveAuxiliaryReplica:
    post:
      operationId: microsoftAzureMoveauxiliaryreplica
      summary: Microsoft Azure Moves The Auxiliary Replica Of A Partition Of A Stateful Service
      description: This command moves the auxiliary replica of a partition of a stateful service, respecting all constraints.<br>CurrentNodeName can be omitted, and in that case a random auxiliary replica is chosen.<br>NewNodeName can be omitted, and in that case the auxiliary replica is moved to a random node.<br>If IgnoreConstraints parameter is specified and set to true, then auxiliary will be moved regardless of the constraints.
      tags:
      - Partition
      parameters:
      - $ref: '#/parameters/ApiVersion_8-1_RequiredQueryParam'
      - $ref: '#/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/CurrentNodeNameOptionalParam'
      - $ref: '#/parameters/NewNodeNameOptionalParam'
      - $ref: '#/parameters/IgnoreConstraintsOptionalParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation request 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.
  PartitionMetricLoadDescriptionList:
    type: array
    items:
      $ref: '#/definitions/PartitionMetricLoadDescription'
    description: List that contains load descriptions of each partition.
  PagedUpdatePartitionLoadResultList:
    description: The list of results of the call UpdatePartitionLoad. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
    properties:
      ContinuationToken:
        $ref: '#/definitions/ContinuationToken'
        description: The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
      Items:
        type: array
        description: List of partition load update information.
        items:
          $ref: '#/definitions/UpdatePartitionLoadResult'
  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'
  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 service. If the same service was deleted and recreated the IDs of its partitions would be different.
  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
  HealthEvaluationWrapper:
    description: Wrapper object for health evaluation.
    properties:
      HealthEvaluation:
        $re

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