Get-ServiceFabricApplication
获取 Service Fabric 群集上的应用程序。
语法
AllPages (默认值)
Get-ServiceFabricApplication
[[-ApplicationName] <Uri>]
[-ApplicationTypeName <String>]
[-ExcludeApplicationParameters]
[-ContinuationToken <String>]
[-ApplicationDefinitionKindFilter <ApplicationDefinitionKindFilter>]
[-TimeoutSec <Int32>]
[<CommonParameters>]
SinglePage
Get-ServiceFabricApplication
[[-ApplicationName] <Uri>]
[-ApplicationTypeName <String>]
[-ExcludeApplicationParameters]
[-GetSinglePage]
[-ContinuationToken <String>]
[-MaxResults <Int64>]
[-ApplicationDefinitionKindFilter <ApplicationDefinitionKindFilter>]
[-TimeoutSec <Int32>]
[<CommonParameters>]
说明
Get-ServiceFabricApplication cmdlet 获取 Service Fabric 群集上的应用程序。 默认情况下,无论最大消息大小配置如何,此查询可以返回的查询结果数没有限制;虽然这是一个分页查询,但与 REST 或 C# 等效调用不同,此查询的默认行为是透明地循环遍历所有返回的页面。 GetSinglePage 选项将此查询配置为返回单个页面。
在 Service Fabric Cluster 上执行任何操作之前,请使用 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 : {}
此命令获取类型名称为 PersistentQueueApp 的 Service Fabric 应用程序。
示例 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 中的一个。 如果未指定筛选器,则返回所有应用程序。
参数属性
| 类型: | ApplicationDefinitionKindFilter |
| 默认值: | None |
| 接受的值: | Default, ServiceFabricApplicationDescription, Compose, MeshApplicationDescription, All |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ApplicationName
指定 Service Fabric 应用程序的统一资源标识符 (URI)。 cmdlet 获取具有指定 URI 的应用程序。 最多可以指定 ApplicationName、ApplicationTypeName 或 ApplicationDefinitionKindFilter 中的一个。 如果未指定筛选器,则返回所有应用程序。
参数属性
| 类型: | Uri |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 0 |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-ApplicationTypeName
指定用于筛选要查询的应用程序的应用程序类型名称。 最多可以指定 ApplicationName、ApplicationTypeName 或 ApplicationDefinitionKindFilter 中的一个。 如果未指定筛选器,则返回所有应用程序。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-ContinuationToken
指定可用于检索查询结果的下一页的延续令牌。
如果太多结果遵循提供的筛选器,则它们可能不适合一条消息。 分页用于通过将返回结果的集合拆分为单独的页面来解决这个问题。 延续令牌用于知道上一页的中断位置,仅对查询本身具有重要意义。 此值应从运行此查询生成,并且可以传递到下一个查询请求中以获取后续页面。 仅当存在后续页面时,才会将非空延续令牌值作为结果的一部分返回。 如果在没有 -GetSinglePage 选项的情况下提供此值,则查询将返回从延续令牌值开始的所有页面。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ExcludeApplicationParameters
指定是否从结果中排除应用程序参数。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-GetSinglePage
指定查询是返回一页带有延续标记值的查询结果,还是将所有页面合并到一个结果列表中。 如果选择此选项,则查询的调用方负责检查后续页面。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
SinglePage
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-MaxResults
指定每页可返回的最大结果项数。 这定义了返回的结果数的上限,而不是最小值。 例如,如果根据配置中定义的最大消息大小限制,页面最多适合 1000 个返回的项目,并且 MaxResults 值设置为 2000,则即使 2000 个结果项与查询描述匹配,也只返回 1000 个结果。 此值需要选择 GetSinglePage 标志;否则将被忽略。
参数属性
| 类型: | Int64 |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
SinglePage
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-TimeoutSec
指定作的超时时间(以秒为单位)。
参数属性
| 类型: | Int32 |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。