Microsoft Azure Services 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 Services. 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
9 operations
across 8 paths,
and defines 59 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.
ServicePlacementPolicyDescription
object
Describes the policy to be used for placement of a Service Fabric service.
1 property
1 required
ScalingPolicyDescription
object
Describes how the scaling should be performed
2 properties
2 required
HealthEvaluationWrapper
object
Wrapper object for health evaluation.
1 property
NodeTagsDescription
object
Describes the tags required for placement or running of the service.
2 properties
2 required
PartitionId
string
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is uni…
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…
ApplicationId
string
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.…
ServiceEndpointRole
string
The role of the replica where the endpoint is reported.
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
ServiceTypeHealthPolicy
object
Represents the health policy used to evaluate the health of services belonging to a service type.
3 properties
ServiceName
string
The full name of the service with 'fabric:' URI scheme.
ApplicationName
string
The name of the application, including the 'fabric:' URI scheme.
EntityHealthState
object
A base type for the health state of various entities in the cluster. It contains the aggregated health state.
1 property
MoveCost
string
Specifies the move cost for the service.
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
ServiceTypeName
string
Name of the service type as specified in the service manifest.
ServiceLoadMetricsList
array
The service load metrics is given as an array of ServiceLoadMetricDescription objects.
ScalingTriggerKind
string
Enumerates the ways that a service can be scaled.
ServiceTypeHealthPolicyMap
array
Defines a ServiceTypeHealthPolicy per service type name. The entries in the map replace the default service type health policy for each specified service type.…
ServiceDescription
object
A ServiceDescription contains all of the information necessary to create a service.
17 properties
4 required
ServicePlacementPolicyType
string
The type of placement policy for a service fabric service. Following are the possible values.
PartitionSchemeDescription
object
Describes how the service is partitioned.
1 property
1 required
ServiceHealth
object
Information about the health of a Service Fabric service.
2 properties
ServiceCorrelationDescription
object
Creates a particular correlation between services.
2 properties
2 required
ByteArray
array
Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255.
ApplicationNameInfo
object
Information about the application name.
2 properties
ServiceLoadMetricWeight
string
Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster…
ServiceLoadMetricDescription
object
Specifies a metric to load balance a service during runtime.
6 properties
1 required
HealthState
string
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
HealthStateCount
object
Represents information about how many health entities are in Ok, Warning and Error health state.
3 properties
ServicePackageActivationMode
string
The activation mode of service package to be used for a Service Fabric service. This is specified at the time of creating the Service.
PartitionInformation
object
Information about the partition identity, partitioning scheme and keys supported by it.
2 properties
1 required
ServiceTypeHealthPolicyMapItem
object
Defines an item in ServiceTypeHealthPolicyMap.
2 properties
2 required
ScalingMechanismKind
string
Enumerates the ways that a service can be scaled.
PartitionScheme
string
Enumerates the ways that a service can be partitioned.
ServiceUpdateDescription
object
A ServiceUpdateDescription contains all of the information necessary to update a service.
11 properties
1 required
ServiceCorrelationScheme
string
The service correlation scheme.
ResolvedServiceEndpointList
array
List of resolved service endpoints of a service partition.
PartitionHealthState
object
Represents the health state of a partition, which contains the partition identifier and its aggregated health state.
1 property
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
UnplacedReplicaInformation
object
Contains information for an unplaced replica.
3 properties
ScalingTriggerDescription
object
Describes the trigger for performing a scaling operation.
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
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
ServicePlacementPoliciesList
array
A list that describes the correlation of the service with other services.
ScalingPolicyDescriptionList
array
A list that describes the scaling policies.
ApplicationHealthPolicy
object
Defines a health policy used to evaluate the health of an application or one of its children entities.
4 properties
ResolvedServicePartition
object
Information about a service partition and its associated endpoints.
4 properties
4 required
ServiceKind
string
The kind of service (Stateless or Stateful).
CorrelationSchemeList
array
A list that describes the correlation of the service with other services.
ResolvedServiceEndpoint
object
Endpoint of a resolved service partition.
2 properties
ServicePartitionKind
string
The kind of partitioning scheme used to partition the service.
ScalingMechanismDescription
object
Describes the mechanism for performing a scaling operation.
1 property
1 required
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.
