Partilhar via

Get-ServiceFabricApplication

  • Referência
Módulo:
ServiceFabric

Obtém o(s) aplicativo(s) 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 o(s) aplicativo(s) no cluster do Service Fabric. Por padrão, não há restrições sobre o número de resultados de consulta que podem ser retornados por essa consulta, independentemente da configuração de tamanho máximo de mensagem; embora esta seja uma consulta paginada, ao contrário das chamadas equivalentes a REST ou C#, o comportamento padrão dessa consulta é percorrer 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 todas as aplicações

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

Este comando obtém todos os aplicativos no cluster.

Exemplo 2: Obter aplicação 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     : {}

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

Exemplo 3: Obter o nome do aplicativo por tipo

PS C:\>Get-ServiceFabricApplication -ApplicationTypeName PersistentQueueApp

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

Este comando obtém o(s) aplicativo(s) do Service Fabric cujo nome de tipo é PersistentQueueApp.

Exemplo 4: Obter aplicação 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     : {}

Este comando obtém o(s) aplicativo(s) do Service Fabric que são definidos pela descrição do aplicativo do Service Fabric.

Exemplo 5: Obter aplicação 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

Este comando obtém todos os aplicativos do Service Fabric no cluster que cabem 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 cabem 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:

Este comando obtém o(s) aplicativo(s) do Service Fabric que respeitam o token de continuação fornecido que cabem em uma única página. O token de continuação fornecido a esta consulta é o mesmo retornado do exemplo acima. A opção "Verbose" 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     : {}

Este comando obtém o aplicativo Service Fabric que corresponde ao nome do aplicativo fornecido. Como visto no exemplo 5, este aplicativo tem parâmetros de aplicativo, mas é excluído do(s) resultado(s) retornado(s) 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 bitwise em membros de ApplicationDefinitionKindFilter. Somente os aplicativos que correspondem ao filtro são retornados. No máximo, um de ApplicationName, ApplicationTypeName ou ApplicationDefinitionKindFilter pode ser especificado. Se nenhum filtro for especificado, todos os aplicativos serão retornados.

Tipo:ApplicationDefinitionKindFilter
Valores aceites:Default, ServiceFabricApplicationDescription, Compose, MeshApplicationDescription, All
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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 de ApplicationName, ApplicationTypeName ou ApplicationDefinitionKindFilter pode ser especificado. Se nenhum filtro for especificado, todos os aplicativos serão retornados.

Tipo:Uri
Position:0
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-ApplicationTypeName

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

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais: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 explicar isso, 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 significado apenas para a consulta em si. Esse valor deve ser gerado a partir da 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
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ExcludeApplicationParameters

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

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-GetSinglePage

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

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais: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 encaixar no máximo 1000 itens retornados de acordo com as restrições de tamanho máximo de mensagem definidas na configuração e o valor MaxResults estiver definido como 2000, apenas 1000 resultados serão retornados, mesmo que 2000 itens de resultado correspondam à descrição da consulta. Esse valor requer a seleção do sinalizador GetSinglePage; caso contrário, será ignorado.

Tipo:Int64
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-TimeoutSec

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

Tipo:Int32
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

System.Uri

System.String

Saídas

System.Object