Share via

ApplicationInfo

  • Article

Information about a Service Fabric application.

Properties

Name Type Required
Id string No
Name string No
TypeName string No
TypeVersion string No
Status string (enum) No
Parameters array of ApplicationParameter No
HealthState string (enum) No
ApplicationDefinitionKind string (enum) No
ManagedApplicationIdentity ManagedApplicationIdentityDescription No
ApplicationMetadata ApplicationMetadata 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.

Possible values are:

  • Invalid - Indicates the application status is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
  • Ready - Indicates the application status is ready. The value is 1.
  • Upgrading - Indicates the application status is upgrading. The value is 2.
  • Creating - Indicates the application status is creating. The value is 3.
  • Deleting - Indicates the application status is deleting. The value is 4.
  • Failed - Indicates the creation or deletion of application was terminated due to persistent failures. Another create/delete request can be accepted to resume a failed application. The value is 5.

Parameters

Type: array of ApplicationParameter
Required: No

List of application parameters with overridden values from their default values specified in the application manifest.

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.

ApplicationDefinitionKind

Type: string (enum)
Required: No

The mechanism used to define a Service Fabric application.

Possible values are:

  • Invalid - Indicates the application definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 65535.
  • ServiceFabricApplicationDescription - Indicates the application is defined by a Service Fabric application description. The value is 0.
  • Compose - Indicates the application is defined by compose file(s). The value is 1.

ManagedApplicationIdentity

Type: ManagedApplicationIdentityDescription
Required: No

Managed application identity description.

ApplicationMetadata

Type: ApplicationMetadata
Required: No

Metadata associated with a specific application.