Share via

Get-ServiceFabricDeployedServicePackage

Module:
ServiceFabric Module

Gets the Service Fabric service packages on a node.

Syntax

UsePagedAPI (Default) 

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

UseUnpagedAPI 

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

Description

The Get-ServiceFabricDeployedServicePackage cmdlet gets the Service Fabric deployed service packages on a specified node.

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 all deployed service packages

PS C:\> Get-ServiceFabricDeployedServicePackage -NodeName "Node01" -ApplicationName fabric:/MyApplication

This command gets all deployed service packages for application fabric:/MyApplication on node Node01.

Example 2: Get deployed service package for service manifest

PS C:\> Get-ServiceFabric DeployedServicePackage -NodeName "Node01" -ApplicationName fabric:/MyApplication -ServiceManifestName "CalcServicePackage"

This command gets deployed service package for application fabric:/MyApplication on node Node01 for service manifest CalcServicePackage.

Parameters

-ApplicationName

Specifies the Uniform Resource Identifier (URI) of a Service Fabric application. The cmdlet gets the service package for the application that you specify.

Parameter properties

Type:Uri
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ContinuationToken

Specifies the continuation token which can be used to retrieve the next page of query results.

If too many results respect the provided filters, they may not fit into one message. Paging is used to account for this by splitting the collection of returned results into separate pages. The continuation token is used to know where the previous page left off, carrying significance only to the query itself. This value should be generated from running this query, and can be passed into the next query request in order to get subsequent pages. A non-null continuation token value is returned as part of the result only if there is a subsequent page. If this value is provided without the -GetSinglePage option, the query will return all pages starting from the continuation token value.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UsePagedAPI
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-GetSinglePage

Specifies whether the query will return one page of query results with a continuation token value, or all pages combined into one list of results. If this option is selected, then it is the responsibility of the caller of the query to check for subsequent pages.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UsePagedAPI
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IncludeHealthState

Include the health state of an entity. If this parameter is false or not specified, then the health state returned is Unknown. When set to true, the query goes in parallel to the node and the health system service before the results are merged. As a result, the query is more expensive and may take a longer time.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UsePagedAPI
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxResults

Specifies the max number of result items that can be returned per page. This defines the upper bound for the number of results returned, not a minimum. For example, if the page fits at most 1000 returned items according to max message size restrictions defined in the configuration, and the MaxResults value is set to 2000, then only 1000 results are returned, even if 2000 result items match the query description. This value requires selection of the GetSinglePage flag; it will be ignored otherwise.

Parameter properties

Type:Int64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UsePagedAPI
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NodeName

Specifies the name of a Service Fabric node. The cmdlet gets service packages for the node that you specify.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ServiceManifestName

Specifies the name of a Service Fabric service manifest. The cmdlet gets service packages for the service manifest that you specify.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-TimeoutSec

Specifies the time-out period, in seconds, for the operation.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UsePaging

Specifies whether to use a paged version of this query.

If this query is unpaged, the number of returned results is restricted by the max message size configuration. If not specified and there are too many application types to fit into a message, the query fails. No results are returned to the user. If the query is paged, then results are not dropped due to message size contraints because the results are broken up into pages when needed and looped through. Paging is done internally by the query, and no additional steps are required.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

UsePagedAPI
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.String

System.Uri

Outputs

System.Object