swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Node API
schemes:
- https
tags:
- name: Node
paths:
  /Nodes:
    get:
      summary: Microsoft Azure Gets The List Of Nodes In The Service Fabric Cluster
      description: The response includes the name, status, ID, health, uptime, and other details about the nodes.
      operationId: microsoftAzureGetnodeinfolist
      parameters:
      - $ref: '#/parameters/ApiVersion_6-3_RequiredQueryParam'
      - $ref: '#/parameters/ContinuationTokenOptionalQueryParam'
      - $ref: '#/parameters/NodeStatusFilterOptionalQueryParam'
      - $ref: '#/parameters/MaxResultsOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Node
      x-ms-examples:
        Get information about all nodes:
          $ref: ./examples/GetNodeInfoList.json
        Limit maximum results:
          $ref: ./examples/GetNodeInfoList-1.json
        Page using continuation token:
          $ref: ./examples/GetNodeInfoList-2.json
      responses:
        '200':
          description: List of nodes in the cluster.
          schema:
            $ref: '#/definitions/PagedNodeInfoList'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}:
    get:
      summary: Microsoft Azure Gets The Information About A Specific Node In The Service Fabric Cluster
      description: The response includes the name, status, ID, health, uptime, and other details about the node.
      operationId: microsoftAzureGetnodeinfo
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Node
      x-ms-examples:
        Get a specific node by node name:
          $ref: ./examples/GetNodeInfo-1.json
      responses:
        '200':
          description: A successful operation will return information about the node with the specified nodeName.
          schema:
            $ref: '#/definitions/NodeInfo'
        '204':
          description: An empty response is returned if the specified nodeName is not found.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/GetHealth:
    get:
      operationId: microsoftAzureGetnodehealth
      summary: Microsoft Azure Gets The Health Of A Service Fabric Node
      description: Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. If the node that you specify by name does not exist in the health store, this returns an error.
      tags:
      - Node
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested node health information.
          schema:
            $ref: '#/definitions/NodeHealth'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
    post:
      operationId: microsoftAzureGetnodehealthusingpolicy
      summary: Microsoft Azure Gets The Health Of A Service Fabric Node, By Using The Specified Health Policy
      description: Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicy in the POST body to override the health policies used to evaluate the health. If the node that you specify by name does not exist in the health store, this returns an error.
      tags:
      - Node
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ClusterHealthPolicyOptionalBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested node health information.
          schema:
            $ref: '#/definitions/NodeHealth'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/ReportHealth:
    post:
      operationId: microsoftAzureReportnodehealth
      summary: Microsoft Azure Sends A Health Report On The Service Fabric Node
      description: Reports health state of the specified Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.<br>The report is sent to a Service Fabric gateway node, 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 GetNodeHealth and check that the report appears in the HealthEvents section.
      tags:
      - Node
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/HealthInformationRequiredBodyParam'
      - $ref: '#/parameters/ImmediateOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/GetLoadInformation:
    get:
      operationId: microsoftAzureGetnodeloadinfo
      summary: Microsoft Azure Gets The Load Information Of A Service Fabric Node
      description: Retrieves the load information of a Service Fabric node for all the metrics that have load or capacity defined.
      tags:
      - Node
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested node load information.
          schema:
            $ref: '#/definitions/NodeLoadInfo'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/Deactivate:
    post:
      operationId: microsoftAzureDisablenode
      summary: Microsoft Azure Deactivate A Service Fabric Cluster Node With The Specified Deactivation Intent
      description: Deactivate a Service Fabric cluster node with the specified deactivation intent. Once the deactivation is in progress, the deactivation intent can be increased, but not decreased (for example, a node that is deactivated with the Pause intent can be deactivated further with Restart, but not the other way around. Nodes may be reactivated using the Activate a node operation any time after they are deactivated. If the deactivation is not complete, this will cancel the deactivation. A node that goes down and comes back up while deactivated will still need to be reactivated before services will be placed on that node.
      tags:
      - Node
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/DeactivationIntentDescriptionRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/Activate:
    post:
      operationId: microsoftAzureEnablenode
      summary: Microsoft Azure Activate A Service Fabric Cluster Node That Is Currently Deactivated
      description: Activates a Service Fabric cluster node that is currently deactivated. Once activated, the node will again become a viable target for placing new replicas, and any deactivated replicas remaining on the node will be reactivated.
      tags:
      - Node
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/RemoveNodeState:
    post:
      operationId: microsoftAzureRemovenodestate
      summary: Microsoft Azure Notifies Service Fabric That The Persisted State On A Node Has Been Permanently Removed Or Lost
      description: This implies that it is not possible to recover the persisted state of that node. This generally happens if a hard disk has been wiped clean, or if a hard disk crashes. The node has to be down for this operation to be successful. This operation lets Service Fabric know that the replicas on that node no longer exist, and that Service Fabric should stop waiting for those replicas to come back up. Do not run this cmdlet if the state on the node has not been removed and the node can come back up with its state intact. Starting from Service Fabric 6.5, in order to use this API for seed nodes, please change the seed nodes to regular (non-seed) nodes and then invoke this API to remove the node state. If the cluster is running on Azure, after the seed node goes down, Service Fabric will try to change it to a non-seed node automatically. To make this happen, make sure the number of non-seed nodes in the primary node type is no less than the number of Down seed nodes. If necessary, add more nodes to the primary node type to achieve this. For standalone cluster, if the Down seed node is not expected to come back up with its state intact, please remove the node from the cluster, see https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-windows-server-add-remove-nodes
      tags:
      - Node
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/Restart:
    post:
      operationId: microsoftAzureRestartnode
      summary: Microsoft Azure Restarts A Service Fabric Cluster Node
      description: Restarts a Service Fabric cluster node that is already started.
      tags:
      - Node
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/RestartNodeDescriptionRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code. A successful operation means that the restart command was received by the node and it is in the process of restarting. Check the status of the node by calling GetNode operation.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/RemoveConfigurationOverrides:
    delete:
      operationId: microsoftAzureRemoveconfigurationoverrides
      summary: Microsoft Azure Removes Configuration Overrides On The Specified Node
      description: This api allows removing all existing configuration overrides on specified node.
      tags:
      - Node
      parameters:
      - $ref: '#/parameters/ApiVersion_7-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/GetConfigurationOverrides:
    get:
      operationId: microsoftAzureGetconfigurationoverrides
      summary: Microsoft Azure Gets The List Of Configuration Overrides On The Specified Node
      description: This api allows getting all existing configuration overrides on the specified node.
      tags:
      - Node
      parameters:
      - $ref: '#/parameters/ApiVersion_7-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: List of configuration overrides on the node.
          schema:
            $ref: '#/definitions/ConfigParameterOverrideList'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/AddConfigurationParameterOverrides:
    post:
      operationId: microsoftAzureAddconfigurationparameteroverrides
      summary: Microsoft Azure Adds The List Of Configuration Overrides On The Specified Node
      description: This api allows adding all existing configuration overrides on the specified node.
      tags:
      - Node
      parameters:
      - $ref: '#/parameters/ApiVersion_7-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/ConfigurationOverrideListRequiredParam'
      - $ref: '#/parameters/ForceConfigurationOverrideOptionalParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/RemoveNodeTags:
    post:
      operationId: microsoftAzureRemovenodetags
      summary: Microsoft Azure Removes The List Of Tags From The Specified Node
      description: This api allows removing set of tags from the specified node.
      tags:
      - Node
      parameters:
      - $ref: '#/parameters/ApiVersion_7-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/NodeTagsListRequiredParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/AddNodeTags:
    post:
      operationId: microsoftAzureAddnodetags
      summary: Microsoft Azure Adds The List Of Tags On The Specified Node
      description: This api allows adding tags to the specified node.
      tags:
      - Node
      parameters:
      - $ref: '#/parameters/ApiVersion_7-2_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/NodeTagsListRequiredParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
definitions:
  RestartNodeDescription:
    description: Describes the parameters to restart a Service Fabric node.
    properties:
      NodeInstanceId:
        type: string
        description: The instance ID of the target node. If instance ID is specified the node is restarted only if it matches with the current instance of the node. A default value of "0" would match any instance ID. The instance ID can be obtained using get node query.
        default: '0'
      CreateFabricDump:
        type: string
        description: Specify True to create a dump of the fabric node process. This is case-sensitive.
        enum:
        - 'False'
        - 'True'
        default: 'False'
        x-ms-enum:
          name: CreateFabricDump
          modelAsString: true
          values:
          - value: 'False'
          - value: 'True'
    required:
    - NodeInstanceId
  NodeDeactivationIntent:
    type: string
    description: The intent or the reason for deactivating the node. Following are the possible values for it.
    enum:
    - Invalid
    - Pause
    - Restart
    - RemoveData
    - RemoveNode
    x-ms-enum:
      name: NodeDeactivationIntent
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the node deactivation intent is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used.
      - value: Pause
        description: Indicates that the node should be paused. The value is 1.
      - value: Restart
        description: Indicates that the intent is for the node to be restarted after a short period of time. Service Fabric does not restart the node, this action is done outside of Service Fabric. The value is 2.
      - value: RemoveData
        description: Indicates that the intent is to reimage the node. Service Fabric does not reimage the node, this action is done outside of Service Fabric. The value is 3.
      - value: RemoveNode
        description: Indicates that the node is being decommissioned and is not expected to return. Service Fabric does not decommission the node, this action is done outside of Service Fabric. The value is 4.
  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.
  NodeDeactivationTask:
    description: The task representing the deactivation operation on the node.
    properties:
      NodeDeactivationTaskId:
        $ref: '#/definitions/NodeDeactivationTaskId'
        description: Identity of the task related to deactivation operation on the node.
      NodeDeactivationIntent:
        $ref: '#/definitions/NodeDeactivationIntent'
        description: The intent or the reason for deactivating the node. Following are the possible values for it.
  NodeInfo:
    description: Information about a node in Service Fabric cluster.
    properties:
      Name:
        $ref: '#/definitions/NodeName'
        description: The name of a Service Fabric node.
      IpAddressOrFQDN:
        type: string
        description: The IP address or fully qualified domain name of the node.
      Type:
        type: string
        description: The type of the node.
      CodeVersion:
        type: string
        description: The version of Service Fabric binaries that the node is running.
      ConfigVersion:
        type: string
        description: The version of Service Fabric cluster manifest that the node is using.
      NodeStatus:
        $ref: '#/definitions/NodeStatus'
        description: The status of the node.
      NodeUpTimeInSeconds:
        type: string
        description: Time in seconds since the node has been in NodeStatus Up. Value zero indicates that the node is not Up.
      HealthState:
        $ref: '#/definitions/HealthState'
        description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
      IsSeedNode:
        type: boolean
        description: Indicates if the node is a seed node or not. Returns true if the node is a seed node, otherwise false. A quorum of seed nodes are required for proper operation of Service Fabric cluster.
      UpgradeDomain:
        type: string
        description: The upgrade domain of the node.
      FaultDomain:
        type: string
        description: The fault domain of the node.
      Id:
        $ref: '#/definitions/NodeId'
        description: An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
      InstanceId:
        type: string
        description: The ID representing the node instance. While the ID of the node is deterministically generated from the node name and remains same across restarts, the InstanceId changes every time node restarts.
      NodeDeactivationInfo:
        $ref: '#/definitions/NodeDeactivationInfo'
        description: Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.
      IsStopped:
        type: boolean
        description: Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false.
      NodeDownTimeInSeconds:
        type: string
        description: Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down.
      NodeUpAt:
        type: string
        format: date-time
        description: Date time in UTC when the node came up. If the node has never been up then this value will be zero date time.
      NodeDownAt:
        type: string
        format: date-time
        description: Date time in UTC when the node went down. If node has never been down then this value will be zero date time.
      NodeTags:
        $ref: '#/definitions/NodeTagsList'
        description: List that contains tags, which will be applied to the nodes.
      IsNodeByNodeUpgradeInProgress:
        type: boolean
        description: Indicates if a node-by-node upgrade is currently being performed on this node.
      InfrastructurePlacementID:
        type: string
        description: PlacementID used by the InfrastructureService.
  ClusterHealthPolicy:
    description: Defines a health policy used to evaluate the health of the cluster or of a cluster node.
    properties:
      ConsiderWarningAsError:
        type: boolean
        description: Indicates whether warnings are treated with the same severity as errors.
        default: false
      MaxPercentUnhealthyNodes:
        type: integer
        description: 'The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.


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

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

          The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.

          The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.


          In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.'
        default: 0
      MaxPercentUnhealthyApplications:
        type: integer
        description: 'The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.


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

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

          This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.

          The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.'
        default: 0
      ApplicationTypeHealthPolicyMap:
        $ref: '#/definitions/ApplicationTypeHealthPolicyMap'
        description: 'Defines a map with max percentage unhealthy applications for specific application types.

          Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.


          The application type health policy map can be used during cluster health evaluation to describe special application types.

          The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.

          The applications of application types specified in the map are not counted against the global pool of applications.

          For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type

          and assign it a value of 0% (that is, do not tolerate any failures).

          All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.

          The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation.'
      NodeTypeHealthPolicyMap:
        $ref: '#/definitions/NodeTypeHealthPolicyMap'
        description: "Defines a map with max percentage unhealthy nodes for specific node types.\nEach entry specifies as key the node type name and as value an integer that represents the MaxPercentUnhealthyNodes percentage used to evaluate the nodes of the specified node type.\n\nThe node type health policy map can be used during cluster health evaluation to describe special node types. \nThey are evaluated against the percentages associated with their node type name in the map. \nSetting this has no impact on the global pool of nodes used for MaxPercentUnhealthyNodes. \nThe node type health policy map is used only if the cluster manifest enables node type health evaluation using the configuration entry for HealthManager/EnableNodeTypeHealthEvaluation.\n\nFor example, given a cluster with many nodes of different types, with important work hosted on node type \"SpecialNodeType\" that should not tolerate any nodes down. \nYou can specify global MaxPercentUnhealthyNodes to 20% to tolerate some failures for all nodes, but for the node type \"SpecialNodeType\", set the MaxPercentUnhealthyNodes to 0 by \nsetting the value in the key value pair in NodeTypeHealthPolicyMapItem. The key is the node type name. \nThis way, as long as no nodes of type \"SpecialNodeType\" are in Error state, \neven if some of the many nodes in the global pool are in Error state, but below the global unhealthy percentage, the cluster would be evaluated to Warning. \nA Warning health state does not impact cluster upgrade or other monitoring triggered by Error health state. \nBut even one node of type SpecialNodeType in Error would make cluster unhealthy (in Error rather than Warning/Ok), which triggers rollback or pauses the cluster upgrade, depending on the upgrade configuration. \n\nConversely, setting the global MaxPercentUnhealthyNodes to 0, and setting SpecialNodeType's max percent unhealthy nodes to 100, \nwith one node of type SpecialNodeType in Error state would still put the cluster in an Error state, since the global restriction is more strict in this case."
  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'
  PagedNodeInfoList:
    description: The list of nodes in the cluster. 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 node information.
        items:
          $ref: '#/definitions/NodeInfo'
  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:
        $ref: '#/definitions/HealthEvaluation'
        description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
  ApplicationTypeHealthPolicyMap:
    type: array
    items:
      $ref: '#/definitions/ApplicationTypeHealthPolicyMapItem'
    description: 'Defines a map with max percentage unhealthy applications for specific application types.

      Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.


      The application type health policy map can be used during cluster health evaluation to describe special application types.

      The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.

      The applications of application types specified in the map are not counted against the global pool of applications.

      For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type

      and assign it a value of 0% (that is, do not tolerate any failures).

      All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.

      The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation.'
  HealthEvent:
    description: Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.
    allOf:
    - $ref: '#/definitions/HealthInformation'
    properties:
      IsExpired:
        type: boolean
        description: Returns true if the health event is expired, otherwise false.
      SourceUtcTimestamp:
        type: string
        format: date-time
        description: The date and time when the health report was sent by the source.
      LastModifiedUtcTimestamp:
        type: string
        format: date-time
        description: The date and time when the health report was last modified by the health store.
      LastOkTransitionAt:
        type: string
        format: date-time
        description: 'If the current health state is ''Ok'', this property returns the time at which the health report was first reported with ''Ok''.

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

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


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


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


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


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


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


          If the health state was never ''Error'', the value will be zero date-time.'
  HealthEvaluationKind:
    type: string
    description: The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.
    enum:
    - Invalid
    - Event
    - Replicas
    - Partitions
    - DeployedServicePackages
    - DeployedApplications
    - Services
    - Nodes
    - Applications
    - SystemApplication
    - UpgradeDomainDeployedApplications
    - UpgradeDomainNodes
    - Replica
    - Partition
    - DeployedServicePackage
    - DeployedApplication
    - Service
    - Node
    - Application
    - DeltaNodesCheck
    - UpgradeDomainDeltaNodesCheck
    - ApplicationTypeApplications
    - NodeTypeNodes
    x-ms-enum:
      name: HealthEvaluationKind
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates that the health evaluation is invalid. The value is zero.
      - value: Event
        description: Indicates that the health evaluation is for a health event. The value is 1.
      - value: Replicas
        description: Indicates that the health evaluation is for the replicas of a partition. The value is 2.
      - value: Partitions
        description: Indicates that the health evaluation is for the partitions of a service. The value is 3.
      - value: DeployedServicePackages
        description: Indicates that the health evaluation is for the deployed service packages of a deployed application. The value is 4.
      - value: DeployedApplications
        description: Indicates that the health evaluation is for the deployed applications of an application. The value is 5.
      - value: Services
        description: Indicates that the health evaluation is for services of an application. The value is 6.
      - value: Nodes
        description: Indicates that the health evaluation is for the cluster nodes. The value is 7.
      - value: Applications
        description: Indicates that the health evaluation is for the cluster applications. The value is 8.
      - value: SystemApplication
        description: Indicates that the health evaluation is for the system application. The value is 9.
      - value: UpgradeDomainDeployedApplications
        description: Indicates that the health evaluation is for the deployed applications of an application in an upgrade domain. The value is 10.
      - value: UpgradeDomainNodes
        description: Indicates that the health evaluation is for the cluster nodes in an upgrade domain. The value is 11.
      - value: Replica
        description: Indicates that the health evaluation is for a replica. The value is 13.
      - value: Partition
        description: Indicates that the health evaluation is for a partition. The value is 14.
      - value: DeployedServicePackage
        description: Indicates that the health evaluation is for a deployed service package. The value is 16.
      - value: DeployedApplication
        description: Indicates that the health evaluation is for a deployed application. The value is 17.
      - value: Service
        description: Indicates that the health evaluation is for a service. The value is 15.
      - value: Node
        description: Indicates that the health evaluation is for a node. The value is 12.
      - value: Application
        description: Indicates that the health evaluation is for an application. The value is 18.
      - value: DeltaNodesCheck
        description: Indicates that the health evaluation is for the delta of unhealthy cluster nodes. The value is 19.
      - value: UpgradeDomainDeltaNodesCheck
        description: Indicates that the health evaluation is for the delta of unhealthy upgrade domain cluster nodes. The value is 20.
      - value: ApplicationTypeApplications
        description: – Indicates that the health evaluation is for applications of an application type. The value is 21.
      - value: NodeTypeNodes
        description: – Indicates that the health evaluation is for nodes of a node type. The value is 22.
  SafetyCheck:
    discriminator: Kind
    description: Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
    properties:
      Kind:
        $ref: '#/definitions/SafetyCheckKind'
        description: The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks.
    required:
    - Kind
  SafetyCheckWrapper:
    description: A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
    properties:
      SafetyCheck:
        $ref: '#/definitions/SafetyCheck'
        description: Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
  NodeDeactivationStatus:
    type: string
    description: The status of node deactivation operation. Following are the possible values.
    enum:
    - None
    - SafetyCheckInProgress
    - SafetyCheckComplete
    - Completed
    x-ms-enum:
      name: NodeDeactivationStatus
      modelAsString: true
      values:
      - value: None
        description: No status is associated with the task. The value is zero.
      - value: SafetyCheckInProgress
        description: When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that one or more safety checks are in progress. The value is 1.
      - value: SafetyCheckComplete
        description: When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that all safety checks have been completed. The value is 2.
      - value: Completed
        description: The task is completed. The value is 3.
  HealthStateCount:
    description: Represents information about how many health entities are in Ok, Warning and Error health state.
    properties:
      OkCount:
        type: integer
        format: int64
        description: The number of health entities with aggregated health state Ok.
        minimum: 0
      WarningCount:
        type: integer
        format: int64
        description: The number of health entities with aggregated health state Warning.
        minimum: 0
      ErrorCount:
        type: integer
        format: int64
        description: The number of health entities with aggregated health state Error.
        minimum: 0
  UnhealthyEvaluations:
    description: List of health evaluations that resulted in the current aggregated health state.
    type: array
    items:
      $ref: '#/definitions/HealthEvaluationWrapper'
  HealthState:
    type: string
    description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
    enum:
    - Invalid
    - Ok
    - Warning
    - Error
    - Unknown
    x-ms-enum:
      name: HealthState
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Ok
        description: Indicates the health state is okay. The value is 1.
      - value: Warning
        description: Indicates the health state is at a warning level. The value is 2.
      - value: Error
        description: Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.
      - value: Unknown
        description: Indicates an unknown health status. The value is 65535.
  NodeHealth:
    description: Information about the health of a Service Fabric node.
    allOf:
    - $ref: '#/definitions/EntityHealth'
    properties:
      Name:
        $ref: '#/definitions/NodeName'
        description: Name of the node whose health information is described by this object.
  ConfigParameterOverride:
    description: Information about a configuration parameter override.
    properties:
      SectionName:
        type: string
        description: Name of the section for the parameter override.
      ParameterName:
        type: string
        description: Name of the parameter that has been overridden.
      ParameterValue:
        type: string
        description: Value of the overridden parameter.
      Timeout:
        type: string
        format: duration
        description: The duration until config override is considered as valid.
      PersistAcrossUpgrade:
        type: boolean
        description: A value that indicates whether config override will be removed on upgrade or will still be considered as valid.
    required:
    - SectionName
    - ParameterName
    - ParameterValue
  NodeId:
    description: An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
    properties:
      Id:
        type: string
        description: Value of the node Id. This is a 128 bit integer.
  NodeTypeHealthPolicyMap:
    type: array
    items:
      $ref: '#/definitions/NodeTypeHealthPolicyMapItem'
    description: "Defines a map with max percentage unhealthy nodes for specific node types.\nEach entry specifies as key the node type name and as value an integer that represents the MaxPercentUnhealthyNodes percentage used to evaluate the nodes of the specified node type.\n\nThe node type health policy map can be used during cluster health evaluation to describe special node types. \nThey are evaluated against the percentages associated with their node type name in the map. \nSetting this has no impact on the global pool of nodes used for MaxPercentUnhealthyNodes. \nThe node type health policy map is used only if the cluster manifest enables node type health evaluation using the configuration entry for HealthManager/EnableNodeTypeHealthEvaluation.\n\nFor example, given a cluster with many nodes of different types, with important work hosted on node type \"SpecialNodeType\" that should not tolerate any nodes down. \nYou can specify global MaxPercentUnhealthyNodes to 20% to tolerate some failures for all nodes, but for the node type \"SpecialNodeType\", set the MaxPercentUnhealthyNodes to 0 by \nsetting the value in the key value pair in NodeTypeHealthPolicyMapItem. The key is the node type name. \nThis way, as long as no nodes of type \"SpecialNodeType\" are in Error state, \neven if some of the many nodes in the global pool are in Error state, but below the global unhealthy percentage, the cluster would be evaluated to Warning. \nA Warning health state does not impact cluster upgrade or other monitoring triggered by Error health state. \nBut even one node of type SpecialNodeType in Error would make cluster unhealthy (in Error rather than Warning/Ok), which triggers rollback or pauses the cluster upgrade, depending on the upgrade configuration. \n\nConversely, setting the global MaxPercentUnhealthyNodes to 0, and setting SpecialNodeType's max percent unhealthy nodes to 100, \nwith one node of type SpecialNodeType in Error state would still put the cluster in an Error state, since the global restriction is more strict in this case."
  NodeLoadInfo:
    description: Information about load on a Service Fabric node. It holds a summary of all metrics and their load on a node.
    properties:
      NodeName:
        $ref: '#/definitions/NodeName'
        description: Name of the node for which the load information is provided by this object.
      NodeLoadMetricInformation:
        type: array
        items:
          $ref: '#/definitions/NodeLoadMetricInformation'
        description: List that contains metrics and their load information on this node.
  DeactivationIntentDescription:
    description: Describes the intent or reason for deactivating the node.
    properties:
      DeactivationIntent:
        type: string
        description: Describes the intent or reason for deactivating the node. The possible values are following.
        enum:
        - Pause
        - Restart
        - RemoveData
        x-ms-enum:
          name: DeactivationIntent
          modelAsString: true
          values:
          - value: Pause
            description: Indicates that the node should be paused. The value is 1.
          - value: Restart
            description: Indicates that the intent is for the node to be restarted after a short period of time. The value is 2.
          - value: RemoveData
            description: Indicates the intent is for the node to remove data. The value is 3.
  EntityHealth:
    description: Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.
    properties:
      AggregatedHealthState:
        $ref: '#/definitions/HealthState'
        description: 'The HealthState representing the aggregated health state of the entity computed by Health Manager.

          The health evaluation of the entity reflects all events reported on the entity and its children (if any).

          The aggregation is done by applying the desired health policy.'
      HealthEvents:
        type: array
        items:
          $ref: '#/definitions/HealthEvent'
        description: The list of health events reported on the entity.
      UnhealthyEvaluations:
        $ref: '#/definitions/UnhealthyEvaluations'
        description: The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
      HealthStatistics:
        $ref: '#/definitions/HealthStatistics'
        description: Shows the health statistics for all children types of the queried entity.
  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
  NodeDeactivationTaskList:
    type: array
    items:
      $ref: '#/definitions/NodeDeactivationTask'
    description: List of tasks representing the deactivation operation on the node.
  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: '#/definitions/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.
  ContinuationToken:
    type: string
    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.
  FabricError:
    description: The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.
    properties:
      Error:
        $ref: '#/definitions/FabricErrorError'
        description: Error object containing error code and error message.
    required:
    - Error
  NodeDeactivationInfo:
    description: Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.
    properties:
      NodeDeactivationIntent:
        $ref: '#/definitions/NodeDeactivationIntent'
        description: The intent or the reason for deactivating the node. Following are the possible values for it.
      NodeDeactivationStatus:
        $ref: '#/definitions/NodeDeactivationStatus'
        description: The status of node deactivation operation. Following are the possible values.
      NodeDeactivationTask:
        $ref: '#/definitions/NodeDeactivationTaskList'
        description: List of tasks representing the deactivation operation on the node.
      PendingSafetyChecks:
        $ref: '#/definitions/SafetyCheckInfoList'
        description: List of pending safety checks
  NodeTypeHealthPolicyMapItem:
    description: Defines an item in NodeTypeHealthPolicyMap.
    required:
    - Key
    - Value
    properties:
      Key:
        type: string
        description: The key of the node type health policy map item. This is the name of the node type.
      Value:
        type: integer
        description: "The value of the node type health policy map item.\nIf the percentage is respected but there is at least one unhealthy node in the node type, the health is evaluated as Warning. \nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the node type. \nThe computation rounds up to tolerate one failure on small numbers of nodes.\nThe max percent unhealthy nodes allowed for the node type. Must be between zero and 100."
  SafetyCheckKind:
    type: string
    description: The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks.
    enum:
    - Invalid
    - EnsureSeedNodeQuorum
    - EnsurePartitionQuorum
    - WaitForPrimaryPlacement
    - WaitForPrimarySwap
    - WaitForReconfiguration
    - WaitForInbuildReplica
    - EnsureAvailability
    x-ms-enum:
      name: SafetyCheckKind
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates that the upgrade safety check kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: EnsureSeedNodeQuorum
        description: Indicates that if we bring down the node then this will result in global seed node quorum loss. The value is 1.
      - value: EnsurePartitionQuorum
        description: Indicates that there is some partition for which if we bring down the replica on the node, it will result in quorum loss for that partition. The value is 2.
      - value: WaitForPrimaryPlacement
        description: Indicates that there is some replica on the node that was moved out of this node due to upgrade. Service Fabric is now waiting for the primary to be moved back to this node. The value is 3.
      - value: WaitForPrimarySwap
        description: Indicates that Service Fabric is waiting for a primary replica to be moved out of the node before starting upgrade on that node. The value is 4.
      - value: WaitForReconfiguration
        description: Indicates that there is some replica on the node that is involved in a reconfiguration. Service Fabric is waiting for the reconfiguration to be complete before staring upgrade on that node. The value is 5.
      - value: WaitForInbuildReplica
        description: Indicates that there is either a replica on the node that is going through copy, or there is a primary replica on the node that is copying data to some other replica. In both cases, bringing down the replica on the node due to upgrade will abort the copy. The value is 6.
      - value: EnsureAvailability
        description: Indicates that there is either a stateless service partition on the node having exactly one instance, or there is a primary replica on the node for which the partition is quorum loss. In both cases, bringing down the replicas due to upgrade will result in loss of availability. The value is 7.
  NodeDeactivationTaskType:
    type: string
    description: The type of the task that performed the node deactivation. Following are the possible values.
    enum:
    - Invalid
    - Infrastructure
    - Repair
    - Client
    x-ms-enum:
      name: NodeDeactivationTaskType
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the node deactivation task type is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used.
      - value: Infrastructure
        description: Specifies the task created by Infrastructure hosting the nodes. The value is 1.
      - value: Repair
        description: Specifies the task that was created by the Repair Manager service. The value is 2.
      - value: Client
        description: Specifies that the task was created by using the public API. The value is 3.
  NodeStatus:
    type: string
    description: The status of the node.
    enum:
    - Invalid
    - Up
    - Down
    - Enabling
    - Disabling
    - Disabled
    - Unknown
    - Removed
    x-ms-enum:
      name: NodeStatus
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the node status is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Up
        description: Indicates the node is up. The value is 1.
      - value: Down
        description: Indicates the node is down. The value is 2.
      - value: Enabling
        description: Indicates the node is in process of being enabled. The value is 3.
      - value: Disabling
        description: Indicates the node is in the process of being disabled. The value is 4.
      - value: Disabled
        description: Indicates the node is disabled. The value is 5.
      - value: Unknown
        description: Indicates the node is unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime.The value is 6.
      - value: Removed
        description: Indicates the node is removed. A node would be in Removed state if NodeStateRemoved API has been called for this node. In other words, Service Fabric has been informed that the persisted state on the node has been permanently lost. The value is 7.
  NodeName:
    type: string
    description: The name of a Service Fabric node.
  NodeLoadMetricInformation:
    description: Represents data structure that contains load information for a certain metric on a node.
    properties:
      Name:
        type: string
        description: Name of the metric for which this load information is provided.
      NodeCapacity:
        type: string
        description: Total capacity on the node for this metric.
      NodeLoad:
        type: string
        description: Current load on the node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentNodeLoad.
      NodeRemainingCapacity:
        type: string
        description: The remaining capacity on the node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of NodeCapacityRemaining.
      IsCapacityViolation:
        type: boolean
        description: Indicates if there is a capacity violation for this metric on the node.
      NodeBufferedCapacity:
        type: string
        description: The value that indicates the reserved capacity for this metric on the node.
      NodeRemainingBufferedCapacity:
        type: string
        description: The remaining reserved capacity for this metric on the node. In future releases of Service Fabric this parameter will be deprecated in favor of BufferedNodeCapacityRemaining.
      CurrentNodeLoad:
        type: string
        format: double
        description: Current load on the node for this metric.
      NodeCapacityRemaining:
        type: string
        format: double
        description: The remaining capacity on the node for the metric.
      BufferedNodeCapacityRemaining:
        type: string
        format: double
        description: The remaining capacity which is not reserved by NodeBufferPercentage for this metric on the node.
      PlannedNodeLoadRemoval:
        type: string
        format: double
        description: 'This value represents the load of the replicas that are planned to be removed in the future.

          This kind of load is reported for replicas that are currently being moving to other nodes and for replicas that are currently being dropped but still use the load on the source node.'
  ConfigParameterOverrideList:
    type: array
    items:
      $ref: '#/definitions/ConfigParameterOverride'
    description: List that contains parameters, sections that they belong and their values.
  NodeDeactivationTaskId:
    description: Identity of the task related to deactivation operation on the node.
    properties:
      Id:
        type: string
        description: Value of the task id.
      NodeDeactivationTaskType:
        $ref: '#/definitions/NodeDeactivationTaskType'
        description: The type of the task that performed the node deactivation. Following are the possible values.
  SafetyCheckInfoList:
    type: array
    description: List of pending safety checks
    items:
      $ref: '#/definitions/SafetyCheckWrapper'
  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.
  ApplicationTypeHealthPolicyMapItem:
    description: Defines an item in ApplicationTypeHealthPolicyMap.
    required:
    - Key
    - Value
    properties:
      Key:
        type: string
        description: The key of the application type health policy map item. This is the name of the application type.
      Value:
        type: integer
        description: 'The value of the application type health policy map item.

          The max percent unhealthy applications allowed for the application type. Must be between zero and 100.'
  NodeTagsList:
    type: array
    items:
      type: string
    description: List that contains tags, which will be applied to the nodes.
parameters:
  DeactivationIntentDescriptionRequiredBodyParam:
    name: DeactivationIntentDescription
    in: body
    description: Describes the intent or reason for deactivating the node.
    required: true
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/DeactivationIntentDescription'
  ImmediateOptionalQueryParam:
    name: Immediate
    in: query
    x-ms-parameter-location: method
    type: boolean
    required: false
    default: false
    description: 'A flag that indicates whether the report should be sent immediately.

      A health report is sent to a Service Fabric gateway Application, which forwards to the health store.

      If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using.

      This is useful for critical reports that should be sent as soon as possible.

      Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn''t reach the Gateway.

      If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration.

      This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing.

      By default, reports are not sent immediately.'
  ApiVersion_7-0_RequiredQueryParam:
    name: api-version
    in: query
    x-ms-parameter-location: method
    type: string
    enum:
    - '7.0'
    required: true
    default: '7.0'
    description: 'The version of the API. This parameter is required and its value must be ''7.0''.


      Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.


      Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.'
    x-ms-enum:
      name: ApiVersion_7-0_RequiredQueryParam
      modelAsString: true
      values:
      - value: '7.0'
        description: The 7.0 version of the API.
  HealthInformationRequiredBodyParam:
    name: HealthInformation
    in: body
    description: Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.
    required: true
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/HealthInformation'
  ForceConfigurationOverrideOptionalParam:
    name: Force
    in: query
    x-ms-parameter-location: method
    type: boolean
    required: false
    description: Force adding configuration overrides on specified nodes.
  RestartNodeDescriptionRequiredBodyParam:
    name: RestartNodeDescription
    in: body
    description: The instance of the node to be restarted and a flag indicating the need to take dump of the fabric process.
    required: true
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/RestartNodeDescription'
  ApiVersion_7-2_RequiredQueryParam:
    name: api-version
    in: query
    x-ms-parameter-location: method
    type: string
    enum:
    - '7.2'
    required: true
    default: '7.2'
    description: 'The version of the API. This parameter is required and its value must be ''7.2''.


      Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.


      Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.'
    x-ms-enum:
      name: ApiVersion_7-2_RequiredQueryParam
      modelAsString: true
      values:
      - value: '7.2'
        description: The 7.2 version of the API.
  NodeNameRequiredPathParam:
    name: nodeName
    in: path
    x-ms-parameter-location: method
    type: string
    required: true
    description: The name of the node.
  ConfigurationOverrideListRequiredParam:
    name: ConfigParameterOverrideList
    in: body
    description: Description for adding list of configuration overrides.
    required: true
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/ConfigParameterOverrideList'
  ApiVersion_6-3_RequiredQueryParam:
    name: api-version
    in: query
    x-ms-parameter-location: method
    type: string
    enum:
    - '6.3'
    required: true
    default: '6.3'
    description: 'The version of the API. This parameter is required and its value must be ''6.3''.


      Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.


      Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.'
    x-ms-enum:
      name: ApiVersion_6-3_RequiredQueryParam
      modelAsString: true
      values:
      - value: '6.3'
        description: The 6.3 version of the API.
  EventsHealthStateFilterOptionalQueryParam:
    name: EventsHealthStateFilter
    description: 'Allows filtering the collection of HealthEvent objects returned based on health state.

      The possible values for this parameter include integer value of one of the following health states.

      Only events that match the filter are returned. All events are used to evaluate the aggregated health state.

      If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ''OR'' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.


      - Default - Default value. Matches any HealthState. The value is zero.

      - None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.

      - Ok - Filter that matches input with HealthState value Ok. The value is 2.

      - Warning - Filter that matches input with HealthState value Warning. The value is 4.

      - Error - Filter that matches input with HealthState value Error. The value is 8.

      - All - Filter that matches input with any HealthState value. The value is 65535.'
    in: query
    x-ms-parameter-location: method
    type: integer
    required: false
    default: 0
  TimeoutOptionalQueryParam:
    name: timeout
    in: query
    x-ms-parameter-location: method
    type: integer
    format: int64
    required: false
    minimum: 1
    maximum: 4294967295
    default: 60
    description: The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
  ApiVersion_6-0_RequiredQueryParam:
    name: api-version
    in: query
    x-ms-parameter-location: method
    type: string
    enum:
    - '6.0'
    required: true
    default: '6.0'
    description: 'The version of the API. This parameter is required and its value must be ''6.0''.


      Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.


      Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.'
    x-ms-enum:
      name: ApiVersion_6-0_RequiredQueryParam
      modelAsString: true
      values:
      - value: '6.0'
        description: The 6.0 version of the API.
  MaxResultsOptionalQueryParam:
    name: MaxResults
    in: query
    x-ms-parameter-location: method
    type: integer
    format: int64
    minimum: 0
    default: 0
    required: false
    description: The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.
  ContinuationTokenOptionalQueryParam:
    name: ContinuationToken
    in: query
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
    type: string
    required: false
    description: The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value 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 does not contain a value. The value of this parameter should not be URL encoded.
  NodeTagsListRequiredParam:
    name: NodeTags
    in: body
    description: Description for adding list of node tags.
    required: true
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/NodeTagsList'
  ClusterHealthPolicyOptionalBodyParam:
    name: ClusterHealthPolicy
    in: body
    description: Describes the health policies used to evaluate the health of a cluster or node. If not present, the health evaluation uses the health policy from cluster manifest or the default health policy.
    required: false
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/ClusterHealthPolicy'
  NodeStatusFilterOptionalQueryParam:
    name: NodeStatusFilter
    description: Allows filtering the nodes based on the NodeStatus. Only the nodes that are matching the specified filter value will be returned. The filter value can be one of the following.
    in: query
    x-ms-parameter-location: method
    type: string
    enum:
    - default
    - all
    - up
    - down
    - enabling
    - disabling
    - disabled
    - unknown
    - removed
    required: false
    default: default
    x-ms-enum:
      name: NodeStatusFilter
      modelAsString: true
      values:
      - value: default
        description: This filter value will match all of the nodes excepts the ones with status as Unknown or Removed.
      - value: all
        description: This filter value will match all of the nodes.
      - value: up
        description: This filter value will match nodes that are Up.
      - value: down
        description: This filter value will match nodes that are Down.
      - value: enabling
        description: This filter value will match nodes that are in the process of being enabled with status as Enabling.
      - value: disabling
        description: This filter value will match nodes that are in the process of being disabled with status as Disabling.
      - value: disabled
        description: This filter value will match nodes that are Disabled.
      - value: unknown
        description: This filter value will match nodes whose status is Unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime.
      - value: removed
        description: This filter value will match nodes whose status is Removed. These are the nodes that are removed from the cluster using the RemoveNodeState API.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'