Microsoft Azure Node API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Node. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.
This API exposes
15 operations
across 14 paths,
and defines 45 schemas.
It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.
The identity and technical contract details declared by the specification.
NodeDeactivationTaskId
object
Identity of the task related to deactivation operation on the node.
2 properties
NodeDeactivationTaskType
string
The type of the task that performed the node deactivation. Following are the possible values.
SafetyCheckWrapper
object
A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availabilit…
1 property
NodeDeactivationTask
object
The task representing the deactivation operation on the node.
2 properties
HealthEvaluationWrapper
object
Wrapper object for health evaluation.
1 property
SafetyCheckInfoList
array
List of pending safety checks
NodeDeactivationInfo
object
Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.
4 properties
NodeLoadInfo
object
Information about load on a Service Fabric node. It holds a summary of all metrics and their load on a node.
2 properties
EntityKind
string
The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
FabricErrorCodes
string
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…
NodeLoadMetricInformation
object
Represents data structure that contains load information for a certain metric on a node.
11 properties
HealthStatistics
object
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…
1 property
ClusterHealthPolicy
object
Defines a health policy used to evaluate the health of the cluster or of a cluster node.
5 properties
NodeTypeHealthPolicyMap
array
Defines a map with max percentage unhealthy nodes for specific node types. Each entry specifies as key the node type name and as value an integer that represen…
PagedNodeInfoList
object
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 executin…
2 properties
NodeHealth
object
Information about the health of a Service Fabric node.
1 property
NodeTypeHealthPolicyMapItem
object
Defines an item in NodeTypeHealthPolicyMap.
2 properties
2 required
DeactivationIntentDescription
object
Describes the intent or reason for deactivating the node.
1 property
ContinuationToken
string
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…
NodeName
string
The name of a Service Fabric node.
NodeDeactivationTaskList
array
List of tasks representing the deactivation operation on the node.
FabricErrorError
object
Error object containing error code and error message.
2 properties
1 required
HealthInformation
object
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.
8 properties
3 required
HealthEvent
object
Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.
6 properties
ApplicationTypeHealthPolicyMapItem
object
Defines an item in ApplicationTypeHealthPolicyMap.
2 properties
2 required
NodeTagsList
array
List that contains tags, which will be applied to the nodes.
NodeDeactivationStatus
string
The status of node deactivation operation. Following are the possible values.
RestartNodeDescription
object
Describes the parameters to restart a Service Fabric node.
2 properties
1 required
NodeDeactivationIntent
string
The intent or the reason for deactivating the node. Following are the possible values for it.
ApplicationTypeHealthPolicyMap
array
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…
ConfigParameterOverride
object
Information about a configuration parameter override.
5 properties
3 required
ConfigParameterOverrideList
array
List that contains parameters, sections that they belong and their values.
HealthState
string
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
NodeInfo
object
Information about a node in Service Fabric cluster.
21 properties
SafetyCheckKind
string
The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliabi…
UnhealthyEvaluations
array
List of health evaluations that resulted in the current aggregated health state.
HealthEvaluation
object
Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
3 properties
1 required
SafetyCheck
object
Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliab…
1 property
1 required
NodeId
object
An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
1 property
NodeStatus
string
The status of the node.
FabricError
object
The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API…
1 property
1 required
EntityHealth
object
Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.
4 properties
EntityKindHealthStateCount
object
Represents health state count for entities of the specified entity kind.
2 properties
HealthStateCount
object
Represents information about how many health entities are in Ok, Warning and Error health state.
3 properties
HealthEvaluationKind
string
The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Microsoft Azure publishes across the network.
