DeployedApplicationInfo

  • Article

Information about application deployed on the node.

Properties

Name Type Required
Id string No
Name string No
TypeName string No
TypeVersion string No
Status string (enum) No
WorkDirectory string No
LogDirectory string No
TempDirectory string No
HealthState string (enum) No

Id

Type: string
Required: No

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. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.

Name

Type: string
Required: No

The name of the application, including the 'fabric:' URI scheme.

TypeName

Type: string
Required: No

The application type name as defined in the application manifest.

TypeVersion

Type: string
Required: No

The version of the application type as defined in the application manifest.

Status

Type: string (enum)
Required: No

The status of the application deployed on the node. Following are the possible values.

Possible values are:

  • Invalid - Indicates that deployment status is not valid. All Service Fabric enumerations have the invalid type. The value is zero.
  • Downloading - Indicates that the package is downloading from the ImageStore. The value is 1.
  • Activating - Indicates that the package is activating. The value is 2.
  • Active - Indicates that the package is active. The value is 3.
  • Upgrading - Indicates that the package is upgrading. The value is 4.
  • Deactivating - Indicates that the package is deactivating. The value is 5.

WorkDirectory

Type: string
Required: No

The work directory of the application on the node. The work directory can be used to store application data.

LogDirectory

Type: string
Required: No

The log directory of the application on the node. The log directory can be used to store application logs.

TempDirectory

Type: string
Required: No

The temp directory of the application on the node. The code packages belonging to the application are forked with this directory set as their temporary directory.

HealthState

Type: string (enum)
Required: No

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.

Possible values are:

  • Invalid - Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
  • Ok - Indicates the health state is okay. The value is 1.
  • Warning - Indicates the health state is at a warning level. The value is 2.
  • Error - Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.
  • Unknown - Indicates an unknown health status. The value is 65535.