Service Fabric is a distributed systems platform that makes it easy to package, deploy, and manage scalable and reliable microservices.
Service Fabric Client APIs allows deploying and managing microservices based applications and containers in a Service Fabric cluster on Azure, on-premise, on local development machine or in other cloud. This document provides a reference for these APIs.
Important
These APIs work with Service Fabric clusters running runtime version 6.0 and above.
All task operations conform to the HTTP/1.1 protocol specification. All task operations return standard HTTP status codes and may also return additional Status and Error Codes in the response body. See Service Fabric Names and JSON Serialization for special considerations when serializing and de-serializing names and identities of various entities such as nodes, applications, services, partitions and replicas in the Service Fabric cluster, to and from request and response. You must make sure that requests and responses are secure. For more information, see Authenticating Service Fabric REST Requests.
The REST APIs are versioned using the api-version query parameter in the URI. All the REST APIs will always support api-version=MajorVersion.MinorVersion where the Major and Minor version number correspond to the version of the Service Fabric cluster runtime being targeted. For instance, while sending requests to a 6.0 cluster, api-version=6.0 is always guaranteed to work, with the latest contract supported by the REST API. However, requests with api-version=6.0 will fail against a 5.5 cluster. To maintain backward compatibility, the cluster will always support any previously supported api-version. So requests with api-version=1.0 or 2.0 or 3.0 will succeed against a 6.0 cluster. The response output will depend on the contract specified for the specific api-version.
To connect to the local development cluster, you must use the correct URI with the correct client connection port, identified by {connection-port} in the URIs listed below. The client connection port is specified by HttpGatewayEndpoint in the cluster manifest file.
Though the examples show http, both http and https protocols are supported by Service Fabric. The protocol is specified by HttpGatewayEndpoint in the cluster manifest file.
To connect to the local development cluster, use the following URI:
http://localhost:{connection-port}
To connect to a cluster by fully-qualified domain name, use a URI similar to the following:
http://MyCluster.cloudapp.net:{connection-port}
To connect to a cluster by IP address, use a URI similar to the following:
http://65.52.117.43:{connection-port}
Following is a list of Service Fabric Client REST APIs.
Cluster APIs
| Name | Description |
|---|---|
| Get Cluster Manifest | Get the Service Fabric cluster manifest. |
| Get Cluster Health | Gets the health of a Service Fabric cluster. |
| Get Cluster Health Using Policy | Gets the health of a Service Fabric cluster using the specified policy. |
| Get Cluster Health Chunk | Gets the health of a Service Fabric cluster using health chunks. |
| Get Cluster Health Chunk Using Policy And Advanced Filters | Gets the health of a Service Fabric cluster using health chunks. |
| Report Cluster Health | Sends a health report on the Service Fabric cluster. |
| Get Provisioned Fabric Code Version Info List | Gets a list of fabric code versions that are provisioned in a Service Fabric cluster. |
| Get Provisioned Fabric Config Version Info List | Gets a list of fabric config versions that are provisioned in a Service Fabric cluster. |
| Get Cluster Upgrade Progress | Gets the progress of the current cluster upgrade. |
| Get Cluster Configuration | Get the Service Fabric standalone cluster configuration. |
| Get Cluster Configuration Upgrade Status | Get the cluster configuration upgrade status of a Service Fabric standalone cluster. |
| Provision Cluster | Provision the code or configuration packages of a Service Fabric cluster. |
| Unprovision Cluster | Unprovision the code or configuration packages of a Service Fabric cluster. |
| Rollback Cluster Upgrade | Rollback the upgrade of a Service Fabric cluster. |
| Resume Cluster Upgrade | Make the cluster upgrade move on to the next upgrade domain. |
| Start Cluster Upgrade | Start upgrading the code or configuration version of a Service Fabric cluster. |
| Start Cluster Configuration Upgrade | Start upgrading the configuration of a Service Fabric standalone cluster. |
| Update Cluster Upgrade | Update the upgrade parameters of a Service Fabric cluster upgrade. |
| Get Aad Metadata | Gets the Azure Active Directory metadata used for secured connection to cluster. |
Node APIs
| Name | Description |
|---|---|
| Get Node Info List | Gets the list of nodes in the Service Fabric cluster. |
| Get Node Info | Gets the list of nodes in the Service Fabric cluster. |
| Get Node Health | Gets the health of a Service Fabric node. |
| Get Node Health Using Policy | Gets the health of a Service Fabric node, by using the specified health policy. |
| Report Node Health | Sends a health report on the Service Fabric node. |
| Get Node Load Info | Gets the load information of a Service Fabric node. |
| Disable Node | Deactivate a Service Fabric cluster node with the specified deactivation intent. |
| Enable Node | Activate a Service Fabric cluster node which is currently deactivated. |
| Remove Node State | Notifies Service Fabric that the persisted state on a node has been permanently removed or lost. |
| Restart Node | Restarts a Service Fabric cluster node. |
ApplicationType APIs
| Name | Description |
|---|---|
| Get Application Type Info List | Gets the list of application types in the Service Fabric cluster. |
| Get Application Type Info List By Name | Gets the list of application types in the Service Fabric cluster matching exactly the specified name. |
| Provision Application Type | Provisions or registers a Service Fabric application type with the cluster. |
| Unprovision Application Type | Removes or unregisters a Service Fabric application type from the cluster. |
| Get Application Manifest | Gets the manifest describing an application type. |
ServiceType APIs
| Name | Description |
|---|---|
| Get Service Type Info List | Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. |
| Get Service Manifest | Gets the manifest describing a service type. |
| Get Deployed Service Type Info List | Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. |
| Get Deployed Service Type Info By Name | Gets the information about a specified service type of the application deployed on a node in a Service Fabric cluster. |
Application APIs
| Name | Description |
|---|---|
| Create Application | Creates a Service Fabric application. |
| Delete Application | Deletes an existing Service Fabric application. |
| Get Application Load Info | Gets load information about a Service Fabric application. |
| Get Application Info List | Gets the list of applications created in the Service Fabric cluster that match filters specified as the parameter. |
| Get Application Info | Gets information about a Service Fabric application. |
| Get Application Health | Gets the health of the service fabric application. |
| Get Application Health Using Policy | Gets the health of a Service Fabric application using the specified policy. |
| Report Application Health | Sends a health report on the Service Fabric application. |
| Start Application Upgrade | Starts upgrading an application in the Service Fabric cluster. |
| Get Application Upgrade | Gets details for the latest upgrade performed on this application. |
| Update Application Upgrade | Updates an ongoing application upgrade in the Service Fabric cluster. |
| Resume Application Upgrade | Resumes upgrading an application in the Service Fabric cluster. |
| Rollback Application Upgrade | Starts rolling back the currently on-going upgrade of an application in the Service Fabric cluster. |
| Get Deployed Application Info List | Gets the list of applications deployed on a Service Fabric node. |
| Get Deployed Application Info | Gets the information about an application deployed on a Service Fabric node. |
| Get Deployed Application Health | Gets the information about health of an application deployed on a Service Fabric node. |
| Get Deployed Application Health Using Policy | Gets the information about health of an application deployed on a Service Fabric node. using the specified policy. |
| Report Deployed Application Health | Sends a health report on the Service Fabric application deployed on a Service Fabric node. |
Service APIs
| Name | Description |
|---|---|
| Get Service Info List | Gets the information about all services belonging to the application specified by the application id. |
| Get Service Info | Gets the information about the specific service belonging to a Service Fabric application. |
| Get Application Name Info | Gets the name of the Service Fabric application for a service. |
| Create Service | Creates the specified service. |
| Create Service From Template | Creates a Service Fabric service from the service template defined in the application manifest. |
| Delete Service | Deletes an existing Service Fabric service. |
| Update Service | Updates the specified service using the given update description. |
| Get Service Description | Gets the description of an existing Service Fabric service. |
| Get Service Health | Gets the health of the specified Service Fabric service. |
| Get Service Health Using Policy | Gets the health of the specified Service Fabric service, by using the specified health policy. |
| Report Service Health | Sends a health report on the Service Fabric service. |
| Resolve Service | Resolve a Service Fabric partition. |
Partition APIs
| Name | Description |
|---|---|
| Get Partition Info List | Gets the list of partitions of a Service Fabric service. |
| Get Partition Info | Gets the information about a Service Fabric partition. |
| Get Service Name Info | Gets the name of the Service Fabric service for a partition. |
| Get Partition Health | Gets the health of the specified Service Fabric partition. |
| Get Partition Health Using Policy | Gets the health of the specified Service Fabric partition, by using the specified health policy. |
| Report Partition Health | Sends a health report on the Service Fabric partition. |
| Get Partition Load Information | Gets the load of the specified Service Fabric partition. |
| Reset Partition Load | Resets the current load of a Service Fabric partition. |
| Recover Partition | Indicates to the Service Fabric cluster that it should attempt to recover a specific partition which is currently stuck in quorum loss. |
| Recover Service Partitions | Indicates to the Service Fabric cluster that it should attempt to recover the specified service which is currently stuck in quorum loss. |
| Recover System Partitions | Indicates to the Service Fabric cluster that it should attempt to recover the system services which are currently stuck in quorum loss. |
| Recover All Partitions | Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss. |
RepairManagement APIs
| Name | Description |
|---|---|
| Create Repair Task | Creates a new repair task. |
| Cancel Repair Task | Requests the cancellation of the given repair task. |
| Delete Repair Task | Deletes a completed repair task. |
| Get Repair Task List | Gets a list of repair tasks matching the given filters. |
| Force Approve Repair Task | Forces the approval of the given repair task. |
| Update Repair Task Health Policy | Updates the health policy of the given repair task. |
| Update Repair Execution State | Updates the execution state of a repair task. |
Replica APIs
| Name | Description |
|---|---|
| Get Replica Info List | Gets the information about replicas of a Service Fabric service partition. |
| Get Replica Info | Gets the information about a replica of a Service Fabric partition. |
| Get Replica Health | Gets the health of a Service Fabric stateful service replica or stateless service instance. |
| Get Replica Health Using Policy | Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy. |
| Report Replica Health | Sends a health report on the Service Fabric replica. |
| Get Deployed Service Replica Info List | Gets the list of replicas deployed on a Service Fabric node. |
| Get Deployed Service Replica Detail Info | Gets the details of replica deployed on a Service Fabric node. |
| Get Deployed Service Replica Detail Info By Partition Id | Gets the details of replica deployed on a Service Fabric node. |
| Restart Replica | Restarts a service replica of a persisted service running on a node. |
| Remove Replica | Removes a service replica running on a node. |
Service Package APIs
| Name | Description |
|---|---|
| Get Deployed Service Package Info List | Gets the list of service packages deployed on a Service Fabric node. |
| Get Deployed Service Package Info List By Name | Gets the list of service packages deployed on a Service Fabric node matching exactly the specified name. |
| Get Deployed Service Package Health | Gets the information about health of an service package for a specific application deployed for a Service Fabric node and application. |
| Get Deployed Service Package Health Using Policy | Gets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy. |
| Report Deployed Service Package Health | Sends a health report on the Service Fabric deployed service package. |
| Deployed Service Package To Node | Downloads packages associated with specified service manifest to image cache on specified node. |
Code Package APIs
| Name | Description |
|---|---|
| Get Deployed Code Package Info List | Gets the list of code packages deployed on a Service Fabric node. |
| Restart Deployed Code Package | Restarts a code package deployed on a Service Fabric node in a cluster. |
Compose Deployment APIs
| Name | Description |
|---|---|
| Create Compose Deployment | Creates a Service Fabric compose deployment. |
| Get Compose Deployment Status | Gets information about a Service Fabric compose deployment. |
| Get Compose Deployment Status List | Gets the list of compose deployments created in the Service Fabric cluster. |
| Get Compose Deployment Upgrade Progress | Gets details for the latest upgrade performed on this Service Fabric compose deployment. |
| Remove Compose Deployment | Deletes an existing Service Fabric compose deployment from cluster. |
| Start Compose Deployment Upgrade | Starts upgrading a compose deployment in the Service Fabric cluster. |
Chaos APIs
| Name | Description |
|---|---|
| Start Chaos | Starts Chaos in the cluster. |
| Stop Chaos | Stops Chaos in the cluster if it is already running, otherwise it does nothing. |
| Get Chaos Report | Gets the next segment of the Chaos report based on the passed-in continuation token or the passed-in time-range. |
ImageStore APIs
| Name | Description |
|---|---|
| Upload File | Uploads contents of the file to the image store. |
| Get Image Store Content | Gets the image store content information. |
| Delete Image Store Content | Deletes existing image store content. |
| Get Image Store Root Content | Gets the content information at the root of the image store. |
| Copy Image Store Content | Copies image store content internally |
Infrastructure APIs
| Name | Description |
|---|---|
| Invoke Infrastructure Command | Invokes an administrative command on the given Infrastructure Service instance. |
| Invoke Infrastructure Query | Invokes a read-only query on the given infrastructure service instance. |
Faults APIs
| Name | Description |
|---|---|
| Start Data Loss | This API will induce data loss for the specified partition. It will trigger a call to the OnDataLossAsync API of the partition. |
| Get Data Loss Progress | Gets the progress of a partition data loss operation started using the StartDataLoss API. |
| Start Quorum Loss | Induces quorum loss for a given stateful service partition. |
| Get Quorum Loss Progress | Gets the progress of a quorum loss operation on a partition started using the StartQuorumLoss API. |
| Start Partition Restart | This API will restart some or all replicas or instances of the specified partition. |
| Get Partition Restart Progress | Gets the progress of a PartitionRestart operation started using StartPartitionRestart. |
| Start Node Transition | Starts or stops a cluster node. |
| Get Node Transition Progress | Gets the progress of an operation started using StartNodeTransition. |
| Get Fault Operation List | Gets a list of user-induced fault operations filtered by provided input. |
| Cancel Operation | Cancels a user-induced fault operation. |
Models
| Name | Description |
|---|---|
| AadMetadata | Azure Active Directory metadata used for secured connection to cluster. |
| AadMetadataObject | Azure Active Directory metadata object used for secured connection to cluster. |
| ApplicationCapacityDescription | Describes capacity information for services of this application. This description can be used for describing the following. - Reserving the capacity for the services on the nodes - Limiting the total number of nodes that services of this application can run on - Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application |
| ApplicationDescription | Describes a Service Fabric application. |
| ApplicationHealth | Represents the health of the application. Contains the application aggregated health state and the service and deployed application health states. |
| ApplicationHealthEvaluation | Represents health evaluation for an application, containing information about the data and the algorithm used by the health store to evaluate health. |
| ApplicationHealthPolicies | Defines the application health policy map used to evaluate the health of an application or one of its children entities. |
| ApplicationHealthPolicy | Defines a health policy used to evaluate the health of an application or one of its children entities. |
| ApplicationHealthPolicyMapItem | Defines an item in ApplicationHealthPolicyMap. |
| ApplicationHealthState | Represents the health state of an application, which contains the application identifier and the aggregated health state. |
| ApplicationHealthStateChunk | Represents the health state chunk of a application. The application health state chunk contains the application name, its aggregated health state and any children services and deployed applications that respect the filters in cluster health chunk query description. |
| ApplicationHealthStateChunkList | The list of application health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query. |
| ApplicationHealthStateFilter | Defines matching criteria to determine whether a application should be included in the cluster health chunk. One filter can match zero, one or multiple applications, depending on its properties. |
| ApplicationInfo | Information about a Service Fabric application. |
| ApplicationLoadInfo | Load Information about a Service Fabric application. |
| ApplicationMetricDescription | Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application. |
| ApplicationNameInfo | Information about the application name. |
| ApplicationParameter | Describes an application parameter override to be applied when creating or upgrading an application. |
| ApplicationsHealthEvaluation | Represents health evaluation for applications, containing health evaluations for each unhealthy application that impacted current aggregated health state. |
| ApplicationTypeApplicationsHealthEvaluation | Represents health evaluation for applications of a particular application type. The application type applications evaluation can be returned when cluster health evaluation returns unhealthy aggregated health state, either Error or Warning. It contains health evaluations for each unhealthy application of the included application type that impacted current aggregated health state. |
| ApplicationTypeHealthPolicyMapItem | Defines an item in ApplicationTypeHealthPolicyMap. |
| ApplicationTypeImageStorePath | Path description for the application package in the image store specified during the prior copy operation. |
| ApplicationTypeImageStoreVersion | A version description for the application type |
| ApplicationTypeInfo | Information about an application type. |
| ApplicationTypeManifest | Contains the manifest describing an application type registered in a Service Fabric cluster. |
| ApplicationUpgradeDescription | Describes the parameters for an application upgrade. Please note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would results in application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription. |
| ApplicationUpgradeProgressInfo | Describes the parameters for an application upgrade. |
| ApplicationUpgradeUpdateDescription | Describes the parameters for updating an ongoing application upgrade. |
| ChaosContext | Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about the Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long. This map is set by the starter of the Chaos run to optionally store the context about the specific run. |
| ChaosContextMapItem | Describes an item in the ChaosContextMap in ChaosParameters. |
| ChaosEvent | Represents an event generated during a Chaos run. |
| ChaosEventWrapper | Wrapper object for Chaos event. |
| ChaosParameters | Defines all the parameters to configure a Chaos run. |
| ChaosReport | Contains detailed Chaos report. |
| ClusterConfiguration | Information about the standalone cluster configuration. |
| ClusterConfigurationUpgradeDescription | Describes the parameters for a standalone cluster configuration upgrade. |
| ClusterConfigurationUpgradeStatusInfo | Information about a standalone cluster configuration upgrade status. |
| ClusterHealth | Represents the health of the cluster. Contains the cluster aggregated health state, the cluster application and node health states as well as the health events and the unhealthy evaluations. |
| ClusterHealthChunk | Represents the health chunk of the cluster. Contains the cluster aggregated health state, and the cluster entities that respect the input filter. |
| ClusterHealthChunkQueryDescription | The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response. |
| ClusterHealthPolicies | Health policies to evaluate cluster health. |
| ClusterHealthPolicy | Defines a health policy used to evaluate the health of the cluster or of a cluster node. |
| ClusterManifest | Information about the cluster manifest. |
| ClusterUpgradeDescriptionObject | Represents a ServiceFabric cluster upgrade |
| ClusterUpgradeHealthPolicyObject | Defines a health policy used to evaluate the health of the cluster during a cluster upgrade. |
| ClusterUpgradeProgressObject | Information about a cluster upgrade. |
| CodePackageEntryPoint | Information about setup or main entry point of a code package deployed on a Service Fabric node. |
| CodePackageEntryPointStatistics | Statistics about setup or main entry point of a code package deployed on a Service Fabric node. |
| ComposeDeploymentStatusInfo | Information about a Service Fabric compose deployment. |
| ComposeDeploymentUpgradeDescription | Describes the parameters for a compose deployment upgrade. |
| ComposeDeploymentUpgradeProgressInfo | Describes the parameters for a compose deployment upgrade. |
| CreateComposeDeploymentDescription | Defines description for creating a Service Fabric compose deployment. |
| CurrentUpgradeDomainProgressInfo | Information about the current in-progress upgrade domain. |
| DeactivationIntentDescription | Describes the intent or reason for deactivating the node. |
| DeltaNodesCheckHealthEvaluation | Represents health evaluation for delta nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned during cluster upgrade when the aggregated health state of the cluster is Warning or Error. |
| DeployedApplicationHealth | Information about the health of an application deployed on a Service Fabric node. |
| DeployedApplicationHealthEvaluation | Represents health evaluation for a deployed application, containing information about the data and the algorithm used by the health store to evaluate health. |
| DeployedApplicationHealthState | Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state. |
| DeployedApplicationHealthStateChunk | Represents the health state chunk of a deployed application, which contains the node where the application is deployed, the aggregated health state and any deployed service packages that respect the chunk query description filters. |
| DeployedApplicationHealthStateChunkList | The list of deployed application health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query. |
| DeployedApplicationHealthStateFilter | Defines matching criteria to determine whether a deployed application should be included as a child of an application in the cluster health chunk. The deployed applications are only returned if the parent application matches a filter specified in the cluster health chunk query description. One filter can match zero, one or multiple deployed applications, depending on its properties. |
| DeployedApplicationInfo | Information about application deployed on the node. |
| DeployedApplicationsHealthEvaluation | Represents health evaluation for deployed applications, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning. |
| DeployedCodePackageInfo | Information about code package deployed on a Service Fabric node. |
| DeployedServicePackageHealth | Information about the health of a service package for a specific application deployed on a Service Fabric node. |
| DeployedServicePackageHealthEvaluation | Represents health evaluation for a deployed service package, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning. |
| DeployedServicePackageHealthState | Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state. |
| DeployedServicePackageHealthStateChunk | Represents the health state chunk of a deployed service package, which contains the service manifest name and the service package aggregated health state. |
| DeployedServicePackageHealthStateChunkList | The list of deployed service package health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query. |
| DeployedServicePackageHealthStateFilter | Defines matching criteria to determine whether a deployed service package should be included as a child of a deployed application in the cluster health chunk. The deployed service packages are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent deployed application and its parent application must be included in the cluster health chunk. One filter can match zero, one or multiple deployed service packages, depending on its properties. |
| DeployedServicePackageInfo | Information about service package deployed on a Service Fabric node. |
| DeployedServicePackagesHealthEvaluation | Represents health evaluation for deployed service packages, containing health evaluations for each unhealthy deployed service package that impacted current aggregated health state. Can be returned when evaluating deployed application health and the aggregated health state is either Error or Warning. |
| DeployedServiceReplicaDetailInfo | Information about a Service Fabric service replica deployed on a node. |
| DeployedServiceReplicaInfo | Information about a Service Fabric service replica deployed on a node. |
| DeployedServiceTypeInfo | Information about service type deployed on a node, information such as the status of the service type registration on a node. |
| DeployedStatefulServiceReplicaDetailInfo | Information about a stateful replica running in a code package. Please note DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and replicaId. |
| DeployedStatefulServiceReplicaInfo | Information about a stateful service replica deployed on a node. |
| DeployedStatelessServiceInstanceDetailInfo | Information about a stateless instance running in a code package. Please note that DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and InstanceId. |
| DeployedStatelessServiceInstanceInfo | Information about a stateless service instance deployed on a node. |
| DeployServicePackageToNodeDescription | Defines description for downloading packages associated with a service manifest to image cache on a Service Fabric node. |
| EnsureAvailabilitySafetyCheck | Safety check that waits to ensure the availability of the partition. It waits until there are replicas available such that bringing down this replica will not cause availability loss for the partition. |
| EnsurePartitionQurumSafetyCheck | Safety check that ensures that a quorum of replicas are not lost for a partition. |
| EntityHealth | Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation. |
| EntityHealthState | A base type for the health state of various entities in the cluster. It contains the aggregated health state. |
| EntityHealthStateChunk | A base type for the health state chunk of various entities in the cluster. It contains the aggregated health state. |
| EntityHealthStateChunkList | A base type for the list of health state chunks found in the cluster. It contains the total number of health states that match the input filters. |
| EntityKindHealthStateCount | Represents health state count for entities of the specified entity kind. |
| Epoch | An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica. |
| EventHealthEvaluation | Represents health evaluation of a HealthEvent that was reported on the entity. The health evaluation is returned when evaluating health of an entity results in Error or Warning. |
| ExecutingFaultsChaosEvent | Describes a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings. |
| FabricCodeVersionInfo | Information about a Service Fabric code version. |
| FabricConfigVersionInfo | Information about a Service Fabric config version. |
| FabricError | The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful. |
| FabricError_Error | Error object containing error code and error message. |
| FailedUpgradeDomainProgressObject | The detailed upgrade progress for nodes in the current upgrade domain at the point of failure. |
| FailureUpgradeDomainProgressInfo | Information about the upgrade domain progress at the time of upgrade failure. |
| FileInfo | Information about a image store file. |
| FileVersion | Information about the version of image store file. |
| FolderInfo | Information about a image store folder. It inclues how many files this folder contains and its image store relative path. |
| HealthEvaluation | Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity. |
| HealthEvaluationWrapper | Wrapper object for health evaluation. |
| HealthEvent | Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager. |
| HealthInformation | 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. |
| HealthStateCount | Represents information about how many health entities are in Ok, Warning and Error health state. |
| HealthStatistics | 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 include health state counts for all children types of the current entity. For example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages. For partition, the health statistics include health counts for replicas. |
| ImageStoreContent | Information about the image store content. |
| ImageStoreCopyDescription | Information about how to copy image store content from one image store relative path to another image store relative path. |
| Int64RangePartitionInformation | Describes the partition information for the integer range that is based on partition schemes. |
| InvokeDataLossResult | Represents information about an operation in a terminal state (Completed or Faulted). |
| InvokeQuorumLossResult | Represents information about an operation in a terminal state (Completed or Faulted). |
| KeyValueStoreReplicaStatus | Key value store related information for the replica. |
| LoadMetricReport | Represents the load metric report which contains the time metric was reported, its name and value. |
| LoadMetricReportInfo | Information about load reported by replica. |
| MonitoringPolicyDescription | Describes the parameters for monitoring an upgrade in Monitored mode. |
| NamedPartitionInformation | Describes the partition information for the name as a string that is based on partition schemes. |
| NamedPartitionSchemeDescription | Describes the named partition scheme of the service. |
| NodeDeactivationInfo | Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated. |
| NodeDeactivationTask | The task representing the deactivation operation on the node. |
| NodeDeactivationTaskId | Identity of the task related to deactivation operation on the node. |
| NodeHealth | Information about the health of a Service Fabric node. |
| NodeHealthEvaluation | Represents health evaluation for a node, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning. |
| NodeHealthState | Represents the health state of a node, which contains the node identifier and its aggregated health state. |
| NodeHealthStateChunk | Represents the health state chunk of a node, which contains the node name and its aggregated health state. |
| NodeHealthStateChunkList | The list of node health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query. |
| NodeHealthStateFilter | Defines matching criteria to determine whether a node should be included in the returned cluster health chunk. One filter can match zero, one or multiple nodes, depending on its properties. Can be specified in the cluster health chunk query description. |
| NodeId | An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name. |
| NodeImpact | Describes the expected impact of a repair to a particular node. This type supports the Service Fabric platform; it is not meant to be used directly from your code. |
| NodeInfo | Information about a node in Service Fabric cluster. |
| NodeLoadInfo | Information about load on a Service Fabric node. It holds a summary of all metrics and their load on a node. |
| NodeLoadMetricInformation | Represents data structure that contains load information for a certain metric on a node. |
| NodeRepairImpactDescription | Describes the expected impact of a repair on a set of nodes. This type supports the Service Fabric platform; it is not meant to be used directly from your code. |
| NodeRepairTargetDescription | Describes the list of nodes targeted by a repair action. This type supports the Service Fabric platform; it is not meant to be used directly from your code. |
| NodeResult | Contains information about a node that was targeted by a user-induced operation. |
| NodesHealthEvaluation | Represents health evaluation for nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health and the aggregated health state is either Error or Warning. |
| NodeTransitionProgress | Information about an NodeTransition operation. This class contains an OperationState and a NodeTransitionResult. The NodeTransitionResult is not valid until OperationState is Completed or Faulted. |
| NodeTransitionResult | Represents information about an operation in a terminal state (Completed or Faulted). |
| NodeUpgradeProgressInfo | Information about the upgrading node and its status |
| OperationStatus | Contains the OperationId, OperationState, and OperationType for user-induced operations. |
| PackageSharingPolicyInfo | Represents a policy for the package sharing. |
| PagedApplicationInfoList | The list of applications 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 executing the same query with the continuation token provided in this list. |
| PagedApplicationTypeInfoList | The list of application types that are provisioned or being provisioned 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 executing the same query with the continuation token provided in this list. |
| PagedComposeDeploymentStatusInfoList | The list of compose deployments 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 executing the same query with the continuation token provided in this list. |
| PagedNodeInfoList | 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 executing the same query with the continuation token provided in this list. |
| PagedReplicaInfoList | The list of replicas in the cluster for a given partition. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list. |
| PagedServiceInfoList | The list of services in the cluster for an application. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list. |
| PagedServicePartitionInfoList | 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 obtained by executing the same query with the continuation token provided in this list. |
| PartitionDataLossProgress | Information about a partition data loss user-induced operation. |
| PartitionHealth | Information about the health of a Service Fabric partition. |
| PartitionHealthEvaluation | Represents health evaluation for a partition, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning. |
| PartitionHealthState | Represents the health state of a partition, which contains the partition identifier and its aggregated health state. |
| PartitionHealthStateChunk | Represents the health state chunk of a partition, which contains the partition id, its aggregated health state and any replicas that respect the filters in the cluster health chunk query description. |
| PartitionHealthStateChunkList | The list of partition health state chunks that respect the input filters in the chunk query description. Returned by get cluster health state chunks query as part of the parent application hierarchy. |
| PartitionHealthStateFilter | Defines matching criteria to determine whether a partition should be included as a child of a service in the cluster health chunk. The partitions are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent service and application must be included in the cluster health chunk. One filter can match zero, one or multiple partitions, depending on its properties. |
| PartitionInformation | Information about the partition identity, partitioning scheme and keys supported by it. |
| PartitionLoadInformation | Represents load information for a partition, which contains the primary and secondary reported load metrics. In case there is no load reported, PartitionLoadInformation will contain the default load for the service of the partition. For default loads, LoadMetricReport's LastReportedUtc is set to 0. |
| PartitionQuorumLossProgress | Information about a partition quorum loss user-induced operation. |
| PartitionRestartProgress | Information about a partition restart user-induced operation. |
| PartitionSchemeDescription | Describes how the service is partitioned. |
| PartitionsHealthEvaluation | Represents health evaluation for the partitions of a service, containing health evaluations for each unhealthy partition that impacts current aggregated health state. Can be returned when evaluating service health and the aggregated health state is either Error or Warning. |
| PrimaryReplicatorStatus | |
| ProvisionFabricDescription | Describes the parameters for provisioning a cluster. |
| ReconfigurationInformation | Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time. |
| RegistryCredential | Credential information to connect to container registry. |
| RemoteReplicatorAcknowledgementDetail | Provides various statistics of the acknowledgements that are being received from the remote replicator. |
| RemoteReplicatorAcknowledgementStatus | Provides details about the remote replicators from the primary replicator's point of view. |
| RemoteReplicatorStatus | Represents the state of the secondary replicator from the primary replicator’s point of view. |
| RepairImpactDescriptionBase | Describes the expected impact of executing a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code. |
| RepairTargetDescriptionBase | Describes the entities targeted by a repair action. This type supports the Service Fabric platform; it is not meant to be used directly from your code. |
| RepairTask | Represents a repair task, which includes information about what kind of repair was requested, what its progress is, and what its final result was. This type supports the Service Fabric platform; it is not meant to be used directly from your code. |
| RepairTaskApproveDescription | Describes a request for forced approval of a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code. |
| RepairTaskCancelDescription | Describes a request to cancel a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code. |
| RepairTaskDeleteDescription | Describes a request to delete a completed repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code. |
| RepairTaskHistory | A record of the times when the repair task entered each state. This type supports the Service Fabric platform; it is not meant to be used directly from your code. |
| RepairTaskUpdateHealthPolicyDescription | Describes a request to update the health policy of a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code. |
| RepairTaskUpdateInfo | Describes the result of an operation that created or updated a repair task. This type supports the Service Fabric platform; it is not meant to be used directly from your code. |
| ReplicaHealth | Represents a base class for stateful service replica or stateless service instance health. Contains the replica aggregated health state, the health events and the unhealthy evaluations. |
| ReplicaHealthEvaluation | Represents health evaluation for a replica, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning. |
| ReplicaHealthState | Represents a base class for stateful service replica or stateless service instance health state. |
| ReplicaHealthStateChunk | Represents the health state chunk of a stateful service replica or a stateless service instance. The replica health state contains the replica ID and its aggregated health state. |
| ReplicaHealthStateChunkList | The list of replica health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query. |
| ReplicaHealthStateFilter | Defines matching criteria to determine whether a replica should be included as a child of a partition in the cluster health chunk. The replicas are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent partition, service and application must be included in the cluster health chunk. One filter can match zero, one or multiple replicas, depending on its properties. |
| ReplicaInfo | Information about the identity, status, health, node name, uptime, and other details about the replica. |
| ReplicasHealthEvaluation | Represents health evaluation for replicas, containing health evaluations for each unhealthy replica that impacted current aggregated health state. Can be returned when evaluating partition health and the aggregated health state is either Error or Warning. |
| ReplicaStatusBase | Information about the replica. |
| ReplicatorQueueStatus | Provides various statistics of the queue used in the service fabric replicator. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc. Depending on the role of the replicator, the properties in this type imply different meanings. |
| ReplicatorStatus | Represents a base class for primary or secondary replicator status. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc. |
| ResolvedServiceEndpoint | Endpoint of a resolved service partition. |
| ResolvedServicePartition | Information about a service partition and its associated endpoints. |
| RestartDeployedCodePackageDescription | Defines description for restarting a deloyed code package on Service Fabric node. |
| RestartNodeDescription | Describes the parameters to restart a Service Fabric node. |
| RestartPartitionResult | Represents information about an operation in a terminal state (Completed or Faulted). |
| ResumeApplicationUpgradeDescription | Describes the parameters for resuming an unmonitored manual Service Fabric application upgrade |
| ResumeClusterUpgradeDescription | Describes the parameters for resuming a cluster upgrade. |
| RollingUpgradeUpdateDescription | Describes the parameters for updating a rolling upgrade of application or cluster. |
| SafetyCheck | Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. |
| SafetyCheckWrapper | A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. |
| SecondaryActiveReplicatorStatus | Status of the secondary replicator when it is in active mode and is part of the replica set. |
| SecondaryIdleReplicatorStatus | Status of the secondary replicator when it is in idle mode and is being built by the primary. |
| SeedNodeSafetyCheck | Represents a safety check for the seed nodes being performed by service fabric before continuing with node level operations. |
| SelectedPartition | This class returns information about the partition that the user-induced operation acted upon. |
| ServiceCorrelationDescription | Creates a particular correlation between services. |
| ServiceDescription | A ServiceDescription contains all of the information necessary to create a service. |
| ServiceFromTemplateDescription | Defines description for creating a Service Fabric service from a template defined in the application manifest. |
| ServiceHealth | Information about the health of a Service Fabric service. |
| ServiceHealthEvaluation | Represents health evaluation for a service, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning. |
| ServiceHealthState | Represents the health state of a service, which contains the service identifier and its aggregated health state. |
| ServiceHealthStateChunk | Represents the health state chunk of a service, which contains the service name, its aggregated health state and any partitions that respect the filters in the cluster health chunk query description. |
| ServiceHealthStateChunkList | The list of service health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query. |
| ServiceHealthStateFilter | Defines matching criteria to determine whether a service should be included as a child of an application in the cluster health chunk. The services are only returned if the parent application matches a filter specified in the cluster health chunk query description. One filter can match zero, one or multiple services, depending on its properties. |
| ServiceInfo | Information about a Service Fabric service. |
| ServiceLoadMetricDescription | Specifies a metric to load balance a service during runtime. |
| ServiceNameInfo | Information about the service name. |
| ServicePartitionInfo | Information about a partition of a Service Fabric service. |
| ServicePlacementInvalidDomainPolicyDescription | Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service. |
| ServicePlacementNonPartiallyPlaceServicePolicyDescription | Describes the policy to be used for placement of a Service Fabric service where all replicas must be able to be placed in order for any replicas to be created. |
| ServicePlacementPolicyDescription | Describes the policy to be used for placement of a Service Fabric service. |
| ServicePlacementPreferPrimaryDomainPolicyDescription | Describes the policy to be used for placement of a Service Fabric service where the service's Primary replicas should optimally be placed in a particular domain. This placement policy is usually used with fault domains in scenarios where the Service Fabric cluster is geographically distributed in order to indicate that a service�s primary replica should be located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional or datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica may not end up located in this domain due to failures, capacity limits, or other constraints. |
| ServicePlacementRequiredDomainPolicyDescription | Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain |
| ServicePlacementRequireDomainDistributionPolicyDescription | Describes the policy to be used for placement of a Service Fabric service where two replicas from the same partition should never be placed in the same fault or upgrade domain. While this is not common it can expose the service to an increased risk of concurrent failures due to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider a case where replicas are deployed across different data center, with one replica per location. In the event that one of the datacenters goes offline, normally the replica that was placed in that datacenter will be packed into one of the remaining datacenters. If this is not desirable then this policy should be set. |
| ServicesHealthEvaluation | Represents health evaluation for services of a certain service type belonging to an application, containing health evaluations for each unhealthy service that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning. |
| ServiceTypeDescription | Describes a service type defined in the service manifest of a provisioned application type. The properties the the ones defined in the service manifest. |
| ServiceTypeExtensionDescription | Describes extension of a service type defined in the service manifest. |
| ServiceTypeHealthPolicy | Represents the health policy used to evaluate the health of services belonging to a service type. |
| ServiceTypeHealthPolicyMapItem | Defines an item in ServiceTypeHealthPolicyMap. |
| ServiceTypeInfo | Information about a service type that is defined in a service manifest of a provisioned application type. |
| ServiceTypeManifest | Contains the manifest describing a service type registered as part of an application in a Service Fabric cluster. |
| ServiceUpdateDescription | A ServiceUpdateDescription contains all of the information necessary to update a service. |
| SingletonPartitionInformation | Information about a partition that is singleton. The services with singletone partitioning scheme are effectively non-partitioned. They only have one partition. |
| SingletonPartitionSchemeDescription | Describes the partition scheme of a singleton-partitioned, or non-partitioned service. |
| StartClusterUpgradeDescription | Describes the parameters for starting a cluster upgrade. |
| StartedChaosEvent | Describes a Chaos event that gets generated when Chaos is started. |
| StatefulServiceDescription | Describes a stateful service. |
| StatefulServiceInfo | Information about a stateful Service Fabric service. |
| StatefulServicePartitionInfo | Information about a partition of a stateful Service Fabric service.. |
| StatefulServiceReplicaHealth | Represents the health of the stateful service replica. Contains the replica aggregated health state, the health events and the unhealthy evaluations. |
| StatefulServiceReplicaHealthState | Represents the health state of the stateful service replica, which contains the replica id and the aggregated health state. |
| StatefulServiceReplicaInfo | Represents a stateful service replica. This includes information about the identity, role, status, health, node name, uptime, and other details about the replica. |
| StatefulServiceTypeDescription | Describes a stateful service type defined in the service manifest of a provisioned application type. |
| StatefulServiceUpdateDescription | Describes an update for a stateful service. |
| StatelessServiceDescription | Describes a stateless service. |
| StatelessServiceInfo | Information about a stateless Service Fabric service. |
| StatelessServiceInstanceHealth | Represents the health of the statelss service instance. Contains the instance aggregated health state, the health events and the unhealthy evaluations. |
| StatelessServiceInstanceHealthState | Represents the health state of the stateless service instance, which contains the instance id and the aggregated health state. |
| StatelessServiceInstanceInfo | Represents a stateless service instance. This includes information about the identity, status, health, node name, uptime, and other details about the instance. |
| StatelessServicePartitionInfo | Information about a partition of a stateless Service Fabric service. |
| StatelessServiceTypeDescription | Describes a stateless service type defined in the service manifest of a provisioned application type. |
| StatelessServiceUpdateDescription | Describes an update for a stateless service. |
| StoppedChaosEvent | Describes a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up. |
| SystemApplicationHealthEvaluation | Represents health evaluation for the fabric:/System application, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state of the cluster is either Error or Warning. |
| TestErrorChaosEvent | Describes a Chaos event that gets generated when an unexpected event occurs in the Chaos engine. For example, due to the cluster snapshot being inconsistent, while faulting a faultable entity, Chaos found that the entity was alreay faulted -- which would be an unexpected event. |
| UniformInt64RangePartitionSchemeDescription | Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions. |
| UnprovisionFabricDescription | Describes the parameters for unprovisioning a cluster. |
| UpdateClusterUpgradeDescription | Parameters for updating a cluster upgrade. |
| UpgradeDomainDeltaNodesCheckHealthEvaluation | Represents health evaluation for delta unhealthy cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned during cluster upgrade when cluster aggregated health state is Warning or Error. |
| UpgradeDomainInfo | Information about an upgrade domain. |
| UpgradeDomainNodesHealthEvaluation | Represents health evaluation for cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health during cluster upgrade and the aggregated health state is either Error or Warning. |
| ValidationFailedChaosEvent | Chaos event corresponding to a failure during validation. |
| WaitForInbuildReplicaSafetyCheck | Safety check that waits for the replica build operation to finish. This indiciates that there is a replica that is going through the copy or is providing data for building another replica. Bring the node down will abort this copy operation which are typoically expensive involving data movements. |
| WaitForPrimaryPlacementSafetyCheck | Safety check that waits for the primary replica that was moved out of the node due to upgrade to be placed back again on that node. |
| WaitForPrimarySwapSafetyCheck | Safety check that waits for the primary replica to be moved out of the node before starting an upgrade to ensure the availability of the primary replica for the partition. |
| WaitForReconfigurationSafetyCheck | Safety check that waits for the current reconfiguration of the partition to be completed before starting an upgrade. |
| WaitingChaosEvent | Describes a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish. |