Microsoft Azure Node API

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 Spe

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