Microsoft Azure Services API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Services API
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: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Services
      responses:
        '200':
          description: Information about the name of the application for the specified service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationNameInfo'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/ForceRemoveOptionalQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Services
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/ServiceUpdateDescriptionRequiredBodyParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 202 status code.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Services
      responses:
        '200':
          description: A successful operation will return 200 status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceDescription'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/components/parameters/PartitionsHealthStateFilterOptionalQueryParam'
      - $ref: '#/components/parameters/ExcludeHealthStatisticsOptionalQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Services
      responses:
        '200':
          description: A successful operation will return 200 status code and the health information of the specified service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceHealth'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/components/parameters/PartitionsHealthStateFilterOptionalQueryParam'
      - $ref: '#/components/parameters/ApplicationHealthPolicyOptionalBodyParam'
      - $ref: '#/components/parameters/ExcludeHealthStatisticsOptionalQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Services
      responses:
        '200':
          description: A successful operation will return 200 status code and the health information of the specified service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceHealth'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/HealthInformationRequiredBodyParam'
      - $ref: '#/components/parameters/ImmediateOptionalQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/PartitionKeyTypeOptionalQueryParam'
      - $ref: '#/components/parameters/PartitionKeyValueOptionalQueryParam'
      - $ref: '#/components/parameters/PreviousRspVersionOptionalQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResolvedServicePartition'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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: '#/components/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/components/parameters/ServiceIdRequiredPathParam'
      - $ref: '#/components/parameters/PartitionIdOptionalQueryParam'
      - $ref: '#/components/parameters/OnlyQueryPrimariesOptionalQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Services
      responses:
        '200':
          description: Information about the specified service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnplacedReplicaInformation'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
components:
  schemas:
    ServicePlacementPolicyDescription:
      discriminator:
        propertyName: Type
      description: Describes the policy to be used for placement of a Service Fabric service.
      required:
      - Type
      properties:
        Type:
          $ref: '#/components/schemas/ServicePlacementPolicyType'
          description: The type of placement policy for a service fabric service. Following are the possible values.
    ScalingPolicyDescription:
      description: Describes how the scaling should be performed
      required:
      - ScalingTrigger
      - ScalingMechanism
      properties:
        ScalingTrigger:
          $ref: '#/components/schemas/ScalingTriggerDescription'
          description: Specifies the trigger associated with this scaling policy
        ScalingMechanism:
          $ref: '#/components/schemas/ScalingMechanismDescription'
          description: Specifies the mechanism associated with this scaling policy
    HealthEvaluationWrapper:
      description: Wrapper object for health evaluation.
      properties:
        HealthEvaluation:
          $ref: '#/components/schemas/HealthEvaluation'
          description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
    NodeTagsDescription:
      description: Describes the tags required for placement or running of the service.
      required:
      - Count
      - Tags
      properties:
        Count:
          type: integer
          description: The number of tags.
        Tags:
          type: array
          items:
            type: string
          description: Array of size specified by the ‘Count’ parameter, for the placement tags of the service.
    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.
    EntityKind:
      type: string
      description: The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
      enum:
      - Invalid
      - Node
      - Partition
      - Service
      - Application
      - Replica
      - DeployedApplication
      - DeployedServicePackage
      - Cluster
      x-ms-enum:
        name: EntityKind
        modelAsString: true
        values:
        - value: Invalid
          description: Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type. The value is zero.
        - value: Node
          description: Indicates the entity is a Service Fabric node. The value is 1.
        - value: Partition
          description: Indicates the entity is a Service Fabric partition. The value is 2.
        - value: Service
          description: Indicates the entity is a Service Fabric service. The value is 3.
        - value: Application
          description: Indicates the entity is a Service Fabric application. The value is 4.
        - value: Replica
          description: Indicates the entity is a Service Fabric replica. The value is 5.
        - value: DeployedApplication
          description: Indicates the entity is a Service Fabric deployed application. The value is 6.
        - value: DeployedServicePackage
          description: Indicates the entity is a Service Fabric deployed service package. The value is 7.
        - value: Cluster
          description: Indicates the entity is a Service Fabric cluster. The value is 8.
    FabricErrorCodes:
      type: string
      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\""
      enum:
      - FABRIC_E_INVALID_PARTITION_KEY
      - FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
      - FABRIC_E_INVALID_ADDRESS
      - FABRIC_E_APPLICATION_NOT_UPGRADING
      - FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
      - FABRIC_E_FABRIC_NOT_UPGRADING
      - FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
      - FABRIC_E_INVALID_CONFIGURATION
      - FABRIC_E_INVALID_NAME_URI
      - FABRIC_E_PATH_TOO_LONG
      - FABRIC_E_KEY_TOO_LARGE
      - FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
      - FABRIC_E_INVALID_ATOMIC_GROUP
      - FABRIC_E_VALUE_EMPTY
      - FABRIC_E_NODE_NOT_FOUND
      - FABRIC_E_APPLICATION_TYPE_NOT_FOUND
      - FABRIC_E_APPLICATION_NOT_FOUND
      - FABRIC_E_SERVICE_TYPE_NOT_FOUND
      - FABRIC_E_SERVICE_DOES_NOT_EXIST
      - FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
      - FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
      - FABRIC_E_PARTITION_NOT_FOUND
      - FABRIC_E_REPLICA_DOES_NOT_EXIST
      - FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
      - FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
      - FABRIC_E_DIRECTORY_NOT_FOUND
      - FABRIC_E_FABRIC_VERSION_NOT_FOUND
      - FABRIC_E_FILE_NOT_FOUND
      - FABRIC_E_NAME_DOES_NOT_EXIST
      - FABRIC_E_PROPERTY_DOES_NOT_EXIST
      - FABRIC_E_ENUMERATION_COMPLETED
      - FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
      - FABRIC_E_KEY_NOT_FOUND
      - FABRIC_E_HEALTH_ENTITY_NOT_FOUND
      - FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
      - FABRIC_E_APPLICATION_ALREADY_EXISTS
      - FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
      - FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
      - FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
      - FABRIC_E_SERVICE_ALREADY_EXISTS
      - FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
      - FABRIC_E_APPLICATION_TYPE_IN_USE
      - FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
      - FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
      - FABRIC_E_FABRIC_VERSION_IN_USE
      - FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
      - FABRIC_E_NAME_ALREADY_EXISTS
      - FABRIC_E_NAME_NOT_EMPTY
      - FABRIC_E_PROPERTY_CHECK_FAILED
      - FABRIC_E_SERVICE_METADATA_MISMATCH
      - FABRIC_E_SERVICE_TYPE_MISMATCH
      - FABRIC_E_HEALTH_STALE_REPORT
      - FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
      - FABRIC_E_NODE_HAS_NOT_STOPPED_YET
      - FABRIC_E_INSTANCE_ID_MISMATCH
      - FABRIC_E_VALUE_TOO_LARGE
      - FABRIC_E_NO_WRITE_QUORUM
      - FABRIC_E_NOT_PRIMARY
      - FABRIC_E_NOT_READY
      - FABRIC_E_RECONFIGURATION_PENDING
      - FABRIC_E_SERVICE_OFFLINE
      - E_ABORT
      - FABRIC_E_COMMUNICATION_ERROR
      - FABRIC_E_OPERATION_NOT_COMPLETE
      - FABRIC_E_TIMEOUT
      - FABRIC_E_NODE_IS_UP
      - E_FAIL
      - FABRIC_E_BACKUP_IS_ENABLED
      - FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
      - FABRIC_E_INVALID_FOR_STATELESS_SERVICES
      - FABRIC_E_BACKUP_NOT_ENABLED
      - FABRIC_E_BACKUP_POLICY_NOT_EXISTING
      - FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
      - FABRIC_E_BACKUP_IN_PROGRESS
      - FABRIC_E_RESTORE_IN_PROGRESS
      - FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
      - FABRIC_E_INVALID_SERVICE_SCALING_POLICY
      - E_INVALIDARG
      - FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
      - FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
      - FABRIC_E_VOLUME_ALREADY_EXISTS
      - FABRIC_E_VOLUME_NOT_FOUND
      - SerializationError
      - FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
      x-ms-enum:
        name: FabricErrorCodes
        modelAsString: true
        values:
        - value: FABRIC_E_INVALID_PARTITION_KEY
        - value: FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
        - value: FABRIC_E_INVALID_ADDRESS
        - value: FABRIC_E_APPLICATION_NOT_UPGRADING
        - value: FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
        - value: FABRIC_E_FABRIC_NOT_UPGRADING
        - value: FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
        - value: FABRIC_E_INVALID_CONFIGURATION
        - value: FABRIC_E_INVALID_NAME_URI
        - value: FABRIC_E_PATH_TOO_LONG
        - value: FABRIC_E_KEY_TOO_LARGE
        - value: FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
        - value: FABRIC_E_INVALID_ATOMIC_GROUP
        - value: FABRIC_E_VALUE_EMPTY
        - value: FABRIC_E_NODE_NOT_FOUND
        - value: FABRIC_E_APPLICATION_TYPE_NOT_FOUND
        - value: FABRIC_E_APPLICATION_NOT_FOUND
        - value: FABRIC_E_SERVICE_TYPE_NOT_FOUND
        - value: FABRIC_E_SERVICE_DOES_NOT_EXIST
        - value: FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
        - value: FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
        - value: FABRIC_E_PARTITION_NOT_FOUND
        - value: FABRIC_E_REPLICA_DOES_NOT_EXIST
        - value: FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
        - value: FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
        - value: FABRIC_E_DIRECTORY_NOT_FOUND
        - value: FABRIC_E_FABRIC_VERSION_NOT_FOUND
        - value: FABRIC_E_FILE_NOT_FOUND
        - value: FABRIC_E_NAME_DOES_NOT_EXIST
        - value: FABRIC_E_PROPERTY_DOES_NOT_EXIST
        - value: FABRIC_E_ENUMERATION_COMPLETED
        - value: FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
        - value: FABRIC_E_KEY_NOT_FOUND
        - value: FABRIC_E_HEALTH_ENTITY_NOT_FOUND
        - value: FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
        - value: FABRIC_E_APPLICATION_ALREADY_EXISTS
        - value: FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
        - value: FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
        - value: FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
        - value: FABRIC_E_SERVICE_ALREADY_EXISTS
        - value: FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
        - value: FABRIC_E_APPLICATION_TYPE_IN_USE
        - value: FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
        - value: FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
        - value: FABRIC_E_FABRIC_VERSION_IN_USE
        - value: FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
        - value: FABRIC_E_NAME_ALREADY_EXISTS
        - value: FABRIC_E_NAME_NOT_EMPTY
        - value: FABRIC_E_PROPERTY_CHECK_FAILED
        - value: FABRIC_E_SERVICE_METADATA_MISMATCH
        - value: FABRIC_E_SERVICE_TYPE_MISMATCH
        - value: FABRIC_E_HEALTH_STALE_REPORT
        - value: FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
        - value: FABRIC_E_NODE_HAS_NOT_STOPPED_YET
        - value: FABRIC_E_INSTANCE_ID_MISMATCH
        - value: FABRIC_E_VALUE_TOO_LARGE
        - value: FABRIC_E_NO_WRITE_QUORUM
        - value: FABRIC_E_NOT_PRIMARY
        - value: FABRIC_E_NOT_READY
        - value: FABRIC_E_RECONFIGURATION_PENDING
        - value: FABRIC_E_SERVICE_OFFLINE
        - value: E_ABORT
        - value: FABRIC_E_COMMUNICATION_ERROR
        - value: FABRIC_E_OPERATION_NOT_COMPLETE
        - value: FABRIC_E_TIMEOUT
        - value: FABRIC_E_NODE_IS_UP
        - value: E_FAIL
        - value: FABRIC_E_BACKUP_IS_ENABLED
        - value: FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
        - value: FABRIC_E_INVALID_FOR_STATELESS_SERVICES
        - value: FABRIC_E_BACKUP_NOT_ENABLED
        - value: FABRIC_E_BACKUP_POLICY_NOT_EXISTING
        - value: FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
        - value: FABRIC_E_BACKUP_IN_PROGRESS
        - value: FABRIC_E_RESTORE_IN_PROGRESS
        - value: FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
        - value: FABRIC_E_INVALID_SERVICE_SCALING_POLICY
        - value: E_INVALIDARG
        - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
        - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
        - value: FABRIC_E_VOLUME_ALREADY_EXISTS
        - value: FABRIC_E_VOLUME_NOT_FOUND
        - value: SerializationError
        - value: FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
    ApplicationId:
      type: string
      description: 'The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.

        Starting in version 6.0, hierarchical names are delimited with the "\~" character. For example, if the application name is "fabric:/myapp/app1",

        the application identity would be "myapp\~app1" in 6.0+ and "myapp/app1" in previous versions.'
    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.
    HealthStatistics:
      description: 'The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics.

        The statistics include health state counts for all children types of the current entity.

        For example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages.

        For partition, the health statistics include health counts for replicas.'
      properties:
        HealthStateCountList:
          type: array
          items:
            $ref: '#/components/schemas/EntityKindHealthStateCount'
          description: List of health state counts per entity kind, which keeps track of how many children of the queried entity are in Ok, Warning and Error state.
    ServiceTypeHealthPolicy:
      description: Represents the health policy used to evaluate the health of services belonging to a service type.
      properties:
        MaxPercentUnhealthyPartitionsPerService:
          type: integer
          description: 'The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100


            The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.

            If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.

            The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.

            The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero.'
          default: 0
        MaxPercentUnhealthyReplicasPerPartition:
          type: integer
          description: 'The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.


            The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.

            If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.

            The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.

            The computation rounds up to tolerate one fa

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