Compartilhar via

Get-ServiceFabricApplication

  • Referência
Módulo:
ServiceFabric

Obtém os aplicativos no cluster do 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

O cmdlet Get-ServiceFabricApplication obtém os aplicativos no cluster do Service Fabric. Por padrão, não há restrições sobre o número de resultados da consulta que podem ser retornados por essa consulta, independentemente da configuração de tamanho máximo da mensagem; embora essa seja uma consulta de página, ao contrário das chamadas equivalentes REST ou C#, o comportamento padrão dessa consulta é fazer loop em todas as páginas retornadas de forma transparente. A opção GetSinglePage configura essa consulta para retornar uma única página.

Antes de executar qualquer operação em um cluster do Service Fabric, estabeleça uma conexão com o cluster usando o cmdlet Connect-ServiceFabricCluster .

Exemplos

Exemplo 1: Obter todos os aplicativos

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     : {}

Esse comando obtém todos os aplicativos no cluster.

Exemplo 2: Obter aplicativo por nome

PS C:\> Get-ServiceFabricApplication -ApplicationName fabric:/samples/PQueueApp1

ApplicationName           : fabric:/samples/PQueueApp1
ApplicationTypeName       : PersistentQueueApp
ApplicationTypeVersion    : 1.0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters     : {}

Esse comando obtém o aplicativo específico com o nome fabric:/samples/PQueueApp1.

Exemplo 3: Obter aplicativo por nome de tipo

PS C:\>Get-ServiceFabricApplication -ApplicationTypeName PersistentQueueApp

ApplicationName           : fabric:/samples/PQueueApp1
ApplicationTypeName       : PersistentQueueApp
ApplicationTypeVersion    : 1.0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : ServiceFabricApplicationDescription
ApplicationParameters     : {}

Esse comando obtém os aplicativos do Service Fabric cujo nome de tipo é PersistentQueueApp.

Exemplo 4: obter aplicativo por tipo de definição

PS C:\>Get-ServiceFabricApplication -ApplicationDefinitionKindFilter Compose

ApplicationName           : fabric:/VQueueApp1
ApplicationTypeName       : Compose_0
ApplicationTypeVersion    : v0
ApplicationStatus         : Ready
HealthState               : Ok
ApplicationDefinitionKind : Compose
ApplicationParameters     : {}

Esse comando obtém os aplicativos do Service Fabric definidos pela descrição do aplicativo Service Fabric.

Exemplo 5: Obter aplicativo com resultados máximos

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

Esse comando obtém todos os aplicativos do Service Fabric no cluster que se encaixam em uma página. Embora haja mais aplicativos no cluster, apenas dois resultados são retornados conforme configurado pelo parâmetro MaxResults. Como há resultados que não se encaixam na página, um valor de token de continuação é retornado, indicando a presença de páginas subsequentes.

Exemplo 6: Obter aplicativo com token de continuação

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:

Esse comando obtém os aplicativos do Service Fabric que respeitam o token de continuação fornecido que se encaixa em uma única página. O token de continuação fornecido para essa consulta é o mesmo retornado do exemplo acima. A opção "Detalhado" não mostra nenhum token de continuação, simbolizando que não há mais páginas disponíveis.

Exemplo 7: Obter aplicativo por nome, excluindo parâmetros de aplicativo

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     : {}

Esse comando obtém o aplicativo do Service Fabric que corresponde ao nome do aplicativo fornecido. Conforme visto no exemplo 5, esse aplicativo tem parâmetros de aplicativo, mas é excluído dos resultados retornados devido ao sinalizador "ExcludeApplicationParameters"

Parâmetros

-ApplicationDefinitionKindFilter

Especifica o filtro para ApplicationDefinitionKindFilter com base em como o aplicativo é definido. O valor pode ser obtido de membros ou operações bit a bit em membros do ApplicationDefinitionKindFilter. São retornados apenas aplicativos que correspondem ao filtro. No máximo um ApplicationName, ApplicationTypeName ou ApplicationDefinitionKindFilter pode ser especificado. Se nenhum filtro for especificado, todos os aplicativos serão retornados.

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

Especifica o URI (Uniform Resource Identifier) de um aplicativo do Service Fabric. O cmdlet obtém o aplicativo que tem o URI especificado. No máximo um ApplicationName, ApplicationTypeName ou ApplicationDefinitionKindFilter pode ser especificado. Se nenhum filtro for especificado, todos os aplicativos serão retornados.

Type:Uri
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ApplicationTypeName

Especifica o nome do tipo de aplicativo usado para filtrar os aplicativos para consulta. No máximo um ApplicationName, ApplicationTypeName ou ApplicationDefinitionKindFilter pode ser especificado. Se nenhum filtro for especificado, todos os aplicativos serão retornados.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ContinuationToken

Especifica o token de continuação que pode ser usado para recuperar a próxima página de resultados da consulta.

Se muitos resultados respeitarem os filtros fornecidos, eles podem não caber em uma mensagem. A paginação é usada para dar conta disso dividindo a coleção de resultados retornados em páginas separadas. O token de continuação é usado para saber onde a página anterior parou, carregando significância apenas para a própria consulta. Esse valor deve ser gerado com a execução dessa consulta e pode ser passado para a próxima solicitação de consulta para obter páginas subsequentes. Um valor de token de continuação não nulo é retornado como parte do resultado somente se houver uma página subsequente. Se esse valor for fornecido sem a opção -GetSinglePage, a consulta retornará todas as páginas a partir do valor do token de continuação.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExcludeApplicationParameters

Especifica se os parâmetros do aplicativo serão excluídos do resultado.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GetSinglePage

Especifica se a consulta retornará uma página dos resultados da consulta com um valor de token de continuação ou todas as páginas combinadas em uma lista de resultados. Se essa opção estiver selecionada, será responsabilidade do chamador da consulta verificar se há páginas subsequentes.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-MaxResults

Especifica o número máximo de itens de resultado que podem ser retornados por página. Isso define o limite superior para o número de resultados retornados, não um mínimo. Por exemplo, se a página se ajustar ao máximo 1000 itens retornados de acordo com as restrições máximas de tamanho da mensagem definidas na configuração e o valor MaxResults for definido como 2000, somente 1.000 resultados serão retornados, mesmo que 2.000 itens de resultado correspondam à descrição da consulta. Esse valor requer a seleção do sinalizador GetSinglePage; ele será ignorado caso contrário.

Type:Int64
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TimeoutSec

Especifica o período de tempo limite, em segundos, para a operação.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

System.Uri

System.String

Saídas

System.Object