Get-ServiceFabricApplication

  • Referência
Módulo:
ServiceFabric

Obtém os aplicativos no cluster do Service Fabric.

Sintaxe

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 paginada, 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 name fabric:/samples/PQueueApp1.

Exemplo 3: obter o 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 o 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 do Service Fabric.

Exemplo 5: Obter o 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 ao excluir 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 de ApplicationDefinitionKindFilter. Somente os aplicativos que correspondem ao filtro são retornados. No máximo um ApplicationName, ApplicationTypeName ou ApplicationDefinitionKindFilter pode ser especificado. Se nenhum filtro for especificado, todos os aplicativos serão retornados.

Tipo:ApplicationDefinitionKindFilter
Valores aceitos:Default, ServiceFabricApplicationDescription, Compose, MeshApplicationDescription, All
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga: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.

Tipo:Uri
Cargo:0
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ApplicationTypeName

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

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga: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 poderão não se encaixar em uma mensagem. A paginação é usada para considerar isso dividindo a coleção de resultados retornados em páginas separadas. O token de continuação é usado para saber de onde a página anterior parou, carregando significância apenas para a consulta em si. 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.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ExcludeApplicationParameters

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

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga: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.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga: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 no 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, apenas 1000 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.

Tipo:Int64
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-TimeoutSec

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

Tipo:Int32
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

System.Uri

System.String

Saídas

System.Object