How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Partition API

The Partition API from Microsoft Azure — 17 operation(s) for partition.

Microsoft Azure Partition 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 Partition. 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 18 operations across 17 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

18 operations 17 paths 43 schemas 6 GET12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 18

Across 17 paths, the API surfaces 18 operations — 6 GET, 12 POST. Each is listed below with its method, path, parameters, and response codes.

Partition 18
GET
/$/GetLoadedPartitionInfoList
Microsoft Azure Gets Ordered List Of Partitions
microsoftAzureGetloadedpartitioninfolist 6 params → 200default
GET
/Services/{serviceId}/$/GetPartitions
Microsoft Azure Gets The List Of Partitions Of A Service Fabric Service
microsoftAzureGetpartitioninfolist 4 params → 200default
GET
/Partitions/{partitionId}
Microsoft Azure Gets The Information About A Service Fabric Partition
microsoftAzureGetpartitioninfo 3 params → 200204default
GET
/Partitions/{partitionId}/$/GetServiceName
Microsoft Azure Gets The Name Of The Service Fabric Service For A Partition
microsoftAzureGetservicenameinfo 3 params → 200default
GET
/Partitions/{partitionId}/$/GetHealth
Microsoft Azure Gets The Health Of The Specified Service Fabric Partition
microsoftAzureGetpartitionhealth 6 params → 200default
POST
/Partitions/{partitionId}/$/GetHealth
Microsoft Azure Gets The Health Of The Specified Service Fabric Partition, By Using The Specified Health Policy
microsoftAzureGetpartitionhealthusingpolicy 7 params → 200default
POST
/Partitions/{partitionId}/$/ReportHealth
Microsoft Azure Sends A Health Report On The Service Fabric Partition
microsoftAzureReportpartitionhealth 5 params → 200default
GET
/Partitions/{partitionId}/$/GetLoadInformation
Microsoft Azure Gets The Load Information Of The Specified Service Fabric Partition
microsoftAzureGetpartitionloadinformation 3 params → 200default
POST
/Partitions/{partitionId}/$/ResetLoad
Microsoft Azure Resets The Current Load Of A Service Fabric Partition
microsoftAzureResetpartitionload 3 params → 200default
POST
/Partitions/{partitionId}/$/Recover
Microsoft Azure Indicates To The Service Fabric Cluster That It Should Attempt To Recover A Specific Partition That Is Currently Stuck In Quorum Loss
microsoftAzureRecoverpartition 3 params → 200default
POST
/Services/$/{serviceId}/$/GetPartitions/$/Recover
Microsoft Azure Indicates To The Service Fabric Cluster That It Should Attempt To Recover The Specified Service That Is Currently Stuck In Quorum Loss
microsoftAzureRecoverservicepartitions 3 params → 200default
POST
/$/RecoverSystemPartitions
Microsoft Azure Indicates To The Service Fabric Cluster That It Should Attempt To Recover The System Services That Are Currently Stuck In Quorum Loss
microsoftAzureRecoversystempartitions 2 params → 200default
POST
/$/RecoverAllPartitions
Microsoft Azure Indicates To The Service Fabric Cluster That It Should Attempt To Recover Any Services Including System Services Which Are Currently Stuck In Quorum Loss
microsoftAzureRecoverallpartitions 2 params → 200default
POST
/Partitions/{partitionId}/$/MovePrimaryReplica
Microsoft Azure Moves The Primary Replica Of A Partition Of A Stateful Service
microsoftAzureMoveprimaryreplica 5 params → 200default
POST
/Partitions/{partitionId}/$/MoveSecondaryReplica
Microsoft Azure Moves The Secondary Replica Of A Partition Of A Stateful Service
microsoftAzureMovesecondaryreplica 6 params → 200default
POST
/$/UpdatePartitionLoad
Microsoft Azure Update The Loads Of Provided Partitions For Specific Metrics
microsoftAzureUpdatepartitionload 5 params → 200default
POST
/Services/{serviceId}/$/GetPartitions/{partitionId}/$/MoveInstance
Microsoft Azure Moves The Instance Of A Partition Of A Stateless Service
microsoftAzureMoveinstance 7 params → 200default
POST
/Services/{serviceId}/$/GetPartitions/{partitionId}/$/MoveAuxiliaryReplica
Microsoft Azure Moves The Auxiliary Replica Of A Partition Of A Stateful Service
microsoftAzureMoveauxiliaryreplica 7 params → 200default

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are HealthInformation (8 properties), HealthEvent (6 properties), PartitionMetricLoadDescription (6 properties), EntityHealth (4 properties). Each schema is shown below with its type and property counts.

UpdatePartitionLoadResult
object
Specifies result of updating load for specified partitions. The output will be ordered based on the partition ID.
2 properties
PagedUpdatePartitionLoadResultList
object
The list of results of the call UpdatePartitionLoad. The list is paged when all of the results cannot fit in a single message. The next set of results can be o…
2 properties
HealthEvaluationWrapper
object
Wrapper object for health evaluation.
1 property
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…
PartitionMetricLoadDescription
object
Represents load information for a partition, which contains the metrics load information about primary, all secondary replicas/instances or a specific secondar…
6 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…
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
MetricLoadDescription
object
Specifies metric load information.
3 properties
ServiceTypeHealthPolicy
object
Represents the health policy used to evaluate the health of services belonging to a service type.
3 properties
LoadedPartitionInformationResult
object
Represents partition information.
4 properties 4 required
ServiceName
string
The full name of the service with 'fabric:' URI scheme.
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…
EntityHealthState
object
A base type for the health state of various entities in the cluster. It contains the aggregated health state.
1 property
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
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
FabricErrorError
object
Error object containing error code and error message.
2 properties 1 required
ReplicaMetricLoadDescription
object
Specifies metric loads of a partition's specific secondary replica or instance.
2 properties
ServiceId
string
The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting…
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.…
ReplicaHealthState
object
Represents a base class for stateful service replica or stateless service instance health state.
2 properties 1 required
HealthState
string
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
ServicePartitionKind
string
The kind of partitioning scheme used to partition the service.
PartitionInformation
object
Information about the partition identity, partitioning scheme and keys supported by it.
2 properties 1 required
PagedServicePartitionInfoList
object
The list of partition in the cluster for a service. The list is paged when all of the results cannot fit in a single message. The next set of results can be ob…
2 properties
ServicePartitionStatus
string
The status of the service fabric service partition.
PartitionMetricLoadDescriptionList
array
List that contains load descriptions of each partition.
ServiceTypeHealthPolicyMapItem
object
Defines an item in ServiceTypeHealthPolicyMap.
2 properties 2 required
PartitionLoadInformation
object
Represents load information for a partition, which contains the primary, secondary and auxiliary reported load metrics. In case there is no load reported, Part…
4 properties
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
ServiceNameInfo
object
Information about the service name.
2 properties
LoadMetricReport
object
Represents the load metric report which contains the time metric was reported, its name and value.
4 properties
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
ServicePartitionInfo
object
Information about a partition of a Service Fabric service.
4 properties 1 required
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
LoadedPartitionInformationResultList
object
Represents data structure that contains top/least loaded partitions for a certain metric.
2 properties
ApplicationHealthPolicy
object
Defines a health policy used to evaluate the health of an application or one of its children entities.
4 properties
ServiceKind
string
The kind of service (Stateless or Stateful).
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…
PartitionHealth
object
Information about the health of a Service Fabric partition.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-partition-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Partition API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.