ApplicationTypeInfo

  • Article

Information about an application type.

Properties

Name Type Required
Name string No
Version string No
DefaultParameterList array of ApplicationParameter No
Status string (enum) No
StatusDetails string No
ApplicationTypeDefinitionKind string (enum) No
ApplicationTypeMetadata ApplicationTypeMetadata No

Name

Type: string
Required: No

The application type name as defined in the application manifest.

Version

Type: string
Required: No

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

DefaultParameterList

Type: array of ApplicationParameter
Required: No

List of application type parameters that can be overridden when creating or updating the application.

Status

Type: string (enum)
Required: No

The status of the application type.

Possible values are:

  • Invalid - Indicates the application type status is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
  • Provisioning - Indicates that the application type is being provisioned in the cluster. The value is 1.
  • Available - Indicates that the application type is fully provisioned and is available for use. An application of this type and version can be created. The value is 2.
  • Unprovisioning - Indicates that the application type is in process of being unprovisioned from the cluster. The value is 3.
  • Failed - Indicates that the application type provisioning failed and it is unavailable for use. The failure details can be obtained from the application type information query. The failed application type information remains in the cluster until it is unprovisioned or reprovisioned successfully. The value is 4.

StatusDetails

Type: string
Required: No

Additional detailed information about the status of the application type.

ApplicationTypeDefinitionKind

Type: string (enum)
Required: No

The mechanism used to define a Service Fabric application type.

Possible values are:

  • Invalid - Indicates the application type definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 0.
  • ServiceFabricApplicationPackage - Indicates the application type is defined and created by a Service Fabric application package provided by the user. The value is 1.
  • Compose - Indicates the application type is defined and created implicitly as part of a compose deployment. The value is 2.

ApplicationTypeMetadata

Type: ApplicationTypeMetadata
Required: No

Metadata associated with a specific application type.