Get-ServiceFabricDeployedApplication

Syntax

Get-ServiceFabricDeployedApplication
   [-NodeName] <String>
   [[-ApplicationName] <Uri>]
   [-UsePaging]
   [-GetSinglePage]
   [-IncludeHealthState]
   [-MaxResults <Int64>]
   [-ContinuationToken <String>]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]

Get-ServiceFabricDeployedApplication
   [-NodeName] <String>
   [[-ApplicationName] <Uri>]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]

Description

The Get-ServiceFabricDeployedApplication cmdlet gets the Service Fabric application(s) deployed on a specified node.

Service Fabric creates work, log, and temporary directories on the node for each deployed application. Because the directory names include the application ID, the directory names cannot be guessed. When the DeployedApplicationStatus is Active, Get-ServiceFabricDeployedApplication returns the directory names in the WorkDirectory, LogDirectory, and TempDirectory return values. When the DeployedApplicationStatus is Downloading, the WorkDirectory, LogDirectory, and TempDirectory values are null.

The deployed application services store their persisted data in the WorkDirectory. For debugging or diagnostic purposes a different application or process may need to know the location of the WorkDirectory.

The deployed application services should store their log in the LogDirectory created by Service Fabric. A custom uploader of the log files may need to know the location. The location of the LogDirectory may be needed for diagnostic purposes as well when an application on a particular node is not working as expected.

By default, this query returns a number of results limited to the max message size configuration. SDKs and clusters versions 6.1 or newer supports paging functionality which removes this restriction; the new behavior will be to return the results regardless of max message size configuration because this query loops through all returned pages transparently. To use paging and other new functionalities, see the parameter set "UsePagedAPI". Selecting any new filters signals to the query to use paging under the hood. Otherwise, select "UsePaging" to opt into paged querying.

Before you perform any operation on a Service Fabric cluster, establish a connection to the cluster by using the Connect-ServiceFabricCluster cmdlet.

Examples

Example 1: Get application "fabric:/samples/CalcApp2"

PS C:\> Get-ServiceFabricDeployedApplication -NodeName "VIPULM4-RK01-BD01" -ApplicationName fabric:/samples/CalcApp2

ApplicationName           : fabric:/samples/CalcApp2
ApplicationTypeName       : CalculatorApp
DeployedApplicationStatus : Active
WorkDirectory             : D:\ServiceFabric\Data\VIPULM4-RK01-BD01\Fabric\work\Applications\CalculatorApp_App5\work
LogDirectory              : D:\ServiceFabric\Data\VIPULM4-RK01-BD01\Fabric\work\Applications\CalculatorApp_App5\log
TempDirectory             : D:\ServiceFabric\Data\VIPULM4-RK01-BD01\Fabric\work\Applications\CalculatorApp_App5\temp
HealthState               : Unknown

This command returns deployed applications. In this example, the DeployedApplicationStatus is Active, and, therefore, Get-ServiceFabricDeployedApplication returns the directory names in the WorkDirectory, LogDirectory, and TempDirectory return values.

Example 2: Get application "fabric:/samples/VQueueApp2"

PS C:\> Get-ServiceFabricDeployedApplication -NodeName VIPULM4-RK01-BD01 fabric:/samples/VQueueApp2

ApplicationName           : fabric:/samples/VQueueApp2
ApplicationTypeName       : VolatileQueueApp
DeployedApplicationStatus : Downloading
HealthState               : Unknown

This command returns deployed applications. In this example, the DeployedApplicationStatus is Downloading, and, therefore, the command returns values of null for WorkDirectory, LogDirectory, and TempDirectory.

Example 3: Get application(s) with max results

PS C:\>Get-ServiceFabricDeployedApplication -NodeName _Node_1 -MaxResults 2 -GetSinglePage -Verbose

ApplicationName           : fabric:/samples/CalculatorApp
ApplicationTypeName       : CalculatorApp
DeployedApplicationStatus : Active
WorkDirectory             : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\work
LogDirectory              : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\log
TempDirectory             : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\temp
HealthState               : Unknown

ApplicationName           : fabric:/samples/PQueueApp1
ApplicationTypeName       : PersistentQueueApp
DeployedApplicationStatus : Active
WorkDirectory             : C:\SfDevCluster\Data\_App\_Node_1\PersistentQueueApp_App1\work
LogDirectory              : C:\SfDevCluster\Data\_App\_Node_1\PersistentQueueApp_App1\log
TempDirectory             : C:\SfDevCluster\Data\_App\_Node_1\PersistentQueueApp_App1\temp
HealthState               : Unknown

VERBOSE: Continuation Token: fabric:/samples/PQueueApp1

This command gets all the Service Fabric application(s) deployed on the provided node in the cluster which fit onto a page. The size of the page is further limited to two items, as configured by the MaxResults parameter. Because we selected the "GetSinglePage" option, this query will return only one page of results. MaxResults cannot be used without this option. Selecting "Verbose" prints the returned continuation token value. This value can be used in a subsequent query to get the next page of results. You can also access the returned continuation token by saving the returned results and accessing the "ContinuationToken" property. The "ContinuationToken" property is null is there is no returned continuation token.

Example 4: Get application with continuation token

PS C:\>Get-ServiceFabricDeployedApplication -NodeName _Node_1 -ContinuationToken fabric:/samples/PQueueApp1 -UsePaging

ApplicationName           : fabric:/samples/VQueueApp1
ApplicationTypeName       : VolatileQueueApp
DeployedApplicationStatus : Active
WorkDirectory             : C:\SfDevCluster\Data\_App\_Node_1\VolatileQueueApp_App2\work
LogDirectory              : C:\SfDevCluster\Data\_App\_Node_1\VolatileQueueApp_App2\log
TempDirectory             : C:\SfDevCluster\Data\_App\_Node_1\VolatileQueueApp_App2\temp
HealthState               : Unknown

This command gets the Service Fabric application(s) which respect the provided continuation token which fit into a single page. The continuation token provided to this query is the same one returned from the example above. In this example cluster, there is only one item which respects the continuation token. If there are too many applications which respect the provided continuation token on the node to fit into one page of results, then this query configuration will return a compilation of all returned pages, looping through them transparently; the query will then return a vector of all the results. To get only one page of results, select the "GetSinglePage" option.

Example 5: Get application with health state

PS C:\>Get-ServiceFabricDeployedApplication -NodeName _Node_1 -ApplicationName fabric:/samples/CalculatorApp -IncludeHealthState

ApplicationName           : fabric:/samples/CalculatorApp
ApplicationTypeName       : CalculatorApp
DeployedApplicationStatus : Active
WorkDirectory             : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\work
LogDirectory              : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\log
TempDirectory             : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\temp
HealthState               : Ok

This command gets the Service Fabric application which matches the provided application name and includes its health state.

Parameters

-ApplicationName

-ContinuationToken

-GetSinglePage

-IncludeHealthState

-MaxResults

-NodeName

-TimeoutSec

-UsePaging

Inputs

System.String

System.Uri

Outputs

System.Object

Related Links

• Connect-ServiceFabricCluster
• Get-ServiceFabricClusterConnection
• Get-ServiceFabricApplication