Get-ServiceFabricApplication
取得 Service Fabric 叢集上的應用程式 () 。
Syntax
Get-ServiceFabricApplication
[[-ApplicationName] <Uri>]
[-ApplicationTypeName <String>]
[-ExcludeApplicationParameters]
[-ContinuationToken <String>]
[-ApplicationDefinitionKindFilter <ApplicationDefinitionKindFilter>]
[-TimeoutSec <Int32>]
[<CommonParameters>]
Get-ServiceFabricApplication
[[-ApplicationName] <Uri>]
[-ApplicationTypeName <String>]
[-ExcludeApplicationParameters]
[-GetSinglePage]
[-ContinuationToken <String>]
[-MaxResults <Int64>]
[-ApplicationDefinitionKindFilter <ApplicationDefinitionKindFilter>]
[-TimeoutSec <Int32>]
[<CommonParameters>]
Description
Get-ServiceFabricApplication Cmdlet 會取得 Service Fabric 叢集上應用程式 () 。 根據預設,不論訊息大小上限設定為何,此查詢都可以傳回的查詢結果數目沒有任何限制;雖然這是分頁查詢,但不同于 REST 或 C# 對等呼叫,此查詢的預設行為是透明地迴圈查看所有傳回的頁面。 GetSinglePage 選項會設定此查詢以傳回單一頁面。
在 Service Fabric 叢集上執行任何作業之前,請先使用 Connect-ServiceFabricCluster Cmdlet 建立叢集的連線。
範例
範例 1:取得所有應用程式
PS C:\> Get-ServiceFabricApplication
ApplicationName : fabric:/samples/CalculatorApp
ApplicationTypeName : CalculatorApp
ApplicationTypeVersion : 1.0
ApplicationStatus : Ready
HealthState : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters : {}
ApplicationName : fabric:/samples/CalculatorAppWithAppParameters
ApplicationTypeName : CalculatorApp
ApplicationTypeVersion : 2.0
ApplicationStatus : Ready
HealthState : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters : { "ServiceInstanceCount" = "4" }
ApplicationName : fabric:/samples/PQueueApp1
ApplicationTypeName : PersistentQueueApp
ApplicationTypeVersion : 1.0
ApplicationStatus : Ready
HealthState : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters : {}
ApplicationName : fabric:/VQueueApp1
ApplicationTypeName : Compose_0
ApplicationTypeVersion : v0
ApplicationStatus : Ready
HealthState : Ok
ApplicationDefinitionKind : Compose
ApplicationParameters : {}
此命令會取得叢集中的所有應用程式。
範例 2:依名稱取得應用程式
PS C:\> Get-ServiceFabricApplication -ApplicationName fabric:/samples/PQueueApp1
ApplicationName : fabric:/samples/PQueueApp1
ApplicationTypeName : PersistentQueueApp
ApplicationTypeVersion : 1.0
ApplicationStatus : Ready
HealthState : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters : {}
此命令會取得名稱為 fabric:/samples/PQueueApp1 的特定應用程式。
範例 3:依類型名稱取得應用程式
PS C:\>Get-ServiceFabricApplication -ApplicationTypeName PersistentQueueApp
ApplicationName : fabric:/samples/PQueueApp1
ApplicationTypeName : PersistentQueueApp
ApplicationTypeVersion : 1.0
ApplicationStatus : Ready
HealthState : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters : {}
此命令會取得 Service Fabric 應用程式 (類型名稱為 PersistentQueueApp 的) 。
範例 4:依定義種類取得應用程式
PS C:\>Get-ServiceFabricApplication -ApplicationDefinitionKindFilter Compose
ApplicationName : fabric:/VQueueApp1
ApplicationTypeName : Compose_0
ApplicationTypeVersion : v0
ApplicationStatus : Ready
HealthState : Ok
ApplicationDefinitionKind : Compose
ApplicationParameters : {}
此命令會取得 Service Fabric 應用程式 (service Fabric 應用程式描述所定義的) 。
範例 5:取得具有最大結果的應用程式
PS C:\>Get-ServiceFabricApplication -MaxResults 2 -GetSinglePage -Verbose
ApplicationName : fabric:/samples/CalculatorApp
ApplicationTypeName : CalculatorApp
ApplicationTypeVersion : 1.0
ApplicationStatus : Ready
HealthState : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters : {}
ApplicationName : fabric:/samples/CalculatorAppWithAppParameters
ApplicationTypeName : CalculatorApp
ApplicationTypeVersion : 2.0
ApplicationStatus : Ready
HealthState : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters : "ServiceInstanceCount" = "4"
VERBOSE: Continuation Token: fabric:/samples/CalculatorAppWithAppParameters
此命令會取得叢集中符合頁面的所有 Service Fabric 應用程式 () 。 雖然叢集中有更多應用程式,但 MaxResults 參數只會傳回兩個結果。 因為有不符合頁面的結果,所以會傳回接續權杖值,指出後續頁面是否存在。
範例 6:使用接續權杖取得應用程式
PS C:\>Get-ServiceFabricApplication -ContinuationToken fabric:/samples/CalculatorAppWithAppParameters -GetSinglePage -Verbose
ApplicationName : fabric:/samples/PQueueApp1
ApplicationTypeName : PersistentQueueApp
ApplicationTypeVersion : 1.0
ApplicationStatus : Ready
HealthState : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters : {}
ApplicationName : fabric:/VQueueApp1
ApplicationTypeName : Compose_0
ApplicationTypeVersion : v0
ApplicationStatus : Ready
HealthState : Ok
ApplicationDefinitionKind : Compose
ApplicationParameters : {}
VERBOSE: Continuation Token:
此命令會取得 Service Fabric 應用程式 () ,其會採用符合單一頁面的提供的接續權杖。 提供給此查詢的接續權杖與上述範例傳回的接續權杖相同。 [詳細資訊] 選項不會顯示任何接續標記,並表示沒有其他頁面可供使用。
範例 7:依名稱取得應用程式,同時排除應用程式參數
PS C:\>Get-ServiceFabricApplication -ApplicationName fabric:/samples/CalculatorAppWithAppParameters -ExcludeApplicationParameters
ApplicationName : fabric:/samples/CalculatorAppWithAppParameters
ApplicationTypeName : CalculatorApp
ApplicationTypeVersion : 2.0
ApplicationStatus : Ready
HealthState : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters : {}
此命令會取得符合所提供應用程式名稱的 Service Fabric 應用程式。 如範例 5 所示,此應用程式具有應用程式參數,但因為 「ExcludeApplicationParameters」 旗標而從傳回的結果中排除 ()
參數
-ApplicationDefinitionKindFilter
根據應用程式的定義方式,指定 ApplicationDefinitionKindFilter 的篩選準則。 您可以從 ApplicationDefinitionKindFilter成員的成員或位運算取得值。 只會傳回符合篩選條件的應用程式。 最多可以指定 ApplicationName、ApplicationTypeName 或 ApplicationDefinitionKindFilter 的其中一個。 如果未指定任何篩選,則會傳回所有應用程式。
Type: | ApplicationDefinitionKindFilter |
Accepted values: | Default, ServiceFabricApplicationDescription, Compose, MeshApplicationDescription, All |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ApplicationName
指定 Service Fabric 應用程式的統一資源識別項 (URI) 。 Cmdlet 會取得具有指定 URI 的應用程式。 最多可以指定 ApplicationName、ApplicationTypeName 或 ApplicationDefinitionKindFilter 的其中一個。 如果未指定任何篩選,則會傳回所有應用程式。
Type: | Uri |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ApplicationTypeName
指定要查詢的應用程式類型名稱。 最多可以指定 ApplicationName、ApplicationTypeName 或 ApplicationDefinitionKindFilter 的其中一個。 如果未指定任何篩選,則會傳回所有應用程式。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ContinuationToken
指定可用來擷取下一頁查詢結果的接續權杖。
如果太多結果遵守提供的篩選準則,它們可能無法放入一則訊息中。 分頁是用來將傳回結果的集合分割成不同的頁面,以考慮此問題。 接續標記是用來知道上一頁離開的位置,只對查詢本身具有重要性。 此值應該從執行此查詢產生,而且可以傳入下一個查詢要求,以取得後續的頁面。 只有在有後續頁面時,才會傳回非 Null 接續權杖值做為結果的一部分。 如果提供這個值時沒有 -GetSinglePage 選項,則查詢會傳回從接續權杖值開始的所有頁面。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExcludeApplicationParameters
指定是否將應用程式參數從結果中排除。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GetSinglePage
指定查詢會傳回具有接續標記值的一頁查詢結果,還是所有合併成一份結果清單的頁面。 如果選取此選項,則查詢的呼叫端必須負責檢查後續頁面。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MaxResults
指定每個頁面可傳回的結果專案數目上限。 這會定義傳回的結果數目上限,而不是最小值。 例如,如果頁面根據組態中定義的訊息大小限制,最多符合 1000 個傳回的專案,而且 MaxResults 值設定為 2000,則即使 2000 個結果專案符合查詢描述,仍只會傳回 1000 個結果。 此值需要選取 GetSinglePage 旗標;否則會忽略它。
Type: | Int64 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TimeoutSec
指定作業的逾時期間,以秒為單位。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
輸入
System.Uri
System.String
輸出
System.Object