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 Service Package API

The Service Package API from Microsoft Azure — 5 operation(s) for service package.

Microsoft Azure Service Package 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 Service Package. 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 6 operations across 5 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

6 operations 5 paths 33 schemas 3 GET3 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 6

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

Service Package 6
GET
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages
Microsoft Azure Gets The List Of Service Packages Deployed On A Service Fabric Node
microsoftAzureGetdeployedservicepackageinfolist 4 params → 200default
GET
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}
Microsoft Azure Gets The List Of Service Packages Deployed On A Service Fabric Node Matching Exactly The Specified Name
microsoftAzureGetdeployedservicepackageinfolistbyname 5 params → 200204default
GET
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth
Microsoft Azure Gets The Information About Health Of A Service Package For A Specific Application Deployed For A Service Fabric Node And Application
microsoftAzureGetdeployedservicepackagehealth 6 params → 200default
POST
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth
Microsoft Azure Gets The Information About Health Of Service Package For A Specific Application Deployed On A Service Fabric Node Using The Specified Policy
microsoftAzureGetdeployedservicepackagehealthusingpolicy 7 params → 200default
POST
/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/ReportHealth
Microsoft Azure Sends A Health Report On The Service Fabric Deployed Service Package
microsoftAzureReportdeployedservicepackagehealth 7 params → 200default
POST
/Nodes/{nodeName}/$/DeployServicePackage
Microsoft Azure Downloads All Of The Code Packages Associated With Specified Service Manifest On The Specified Node
microsoftAzureDeployservicepackagetonode 4 params → 200default

Schemas 33

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

ApplicationTypeName
string
The application type name as defined in the application manifest.
DeployedServicePackageHealth
object
Information about the health of a service package for a specific application deployed on a Service Fabric node.
3 properties
ApplicationTypeVersion
string
The version of the application type as defined in the application manifest.
DeployedServicePackageInfoList
array
List of deployed service package information.
HealthEvaluationWrapper
object
Wrapper object for health evaluation.
1 property
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…
ServicePackageActivationId
string
The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is n…
DeploymentStatus
string
Specifies the status of a deployed application or service package on a Service Fabric node.
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
DeployServicePackageToNodeDescription
object
Defines description for downloading packages associated with a service manifest to image cache on a Service Fabric node.
5 properties 4 required
ServiceTypeHealthPolicy
object
Represents the health policy used to evaluate the health of services belonging to a service type.
3 properties
PackageSharingPolicyInfoList
array
List of package sharing policy information.
NodeName
string
The name of a Service Fabric node.
ApplicationName
string
The name of the application, including the 'fabric:' URI scheme.
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
ServiceManifestName
string
The name of the service manifest.
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
PackageSharingPolicyScope
string
Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation.
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.…
PackageSharingPolicyInfo
object
Represents a policy for the package sharing.
2 properties
HealthState
string
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
ServiceTypeHealthPolicyMapItem
object
Defines an item in ServiceTypeHealthPolicyMap.
2 properties 2 required
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
EntityHealth
object
Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.
4 properties
ApplicationHealthPolicy
object
Defines a health policy used to evaluate the health of an application or one of its children entities.
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
DeployedServicePackageInfo
object
Information about service package deployed on a Service Fabric node.
4 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…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-service-package-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 Service Package 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.