Share via

Get-ServiceFabricDeployedApplication

  • Referência
Módulo:
ServiceFabric

Obtém os aplicativos do Service Fabric em um nó especificado.

Syntax

Get-ServiceFabricDeployedApplication
   [-NodeName] <String>
   [[-ApplicationName] <Uri>]
   [-UsePaging]
   [-GetSinglePage]
   [-IncludeHealthState]
   [-MaxResults <Int64>]
   [-ContinuationToken <String>]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]
Get-ServiceFabricDeployedApplication
   [-NodeName] <String>
   [[-ApplicationName] <Uri>]
   [-TimeoutSec <Int32>]
   [<CommonParameters>]

Description

O cmdlet Get-ServiceFabricDeployedApplication obtém os aplicativos do Service Fabric implantados em um nó especificado.

O Service Fabric cria diretórios de trabalho, log e temporários no nó para cada aplicativo implantado. Como os nomes de diretório incluem a ID do aplicativo, os nomes do diretório não podem ser adivinhados. Quando o DeployedApplicationStatus está ativo, Get-ServiceFabricDeployedApplication retorna os nomes de diretório nos valores de retorno WorkDirectory, LogDirectory e TempDirectory . Quando o DeployedApplicationStatus está sendo baixado, os valores WorkDirectory, LogDirectory e TempDirectory são nulos.

Os serviços de aplicativo implantados armazenam seus dados persistentes no WorkDirectory. Para fins de depuração ou diagnóstico, um aplicativo ou processo diferente pode precisar saber o local do WorkDirectory.

Os serviços de aplicativo implantados devem armazenar seu log no LogDirectory criado pelo Service Fabric. Um uploader personalizado dos arquivos de log pode precisar saber o local. O local do LogDirectory pode ser necessário para fins de diagnóstico também quando um aplicativo em um nó específico não está funcionando conforme o esperado.

Por padrão, essa consulta retorna vários resultados limitados à configuração de tamanho máximo da mensagem. SDKs e clusters versões 6.1 ou mais recentes dão suporte à funcionalidade de paginação que remove essa restrição; o novo comportamento será retornar os resultados independentemente da configuração de tamanho máximo da mensagem, pois essa consulta faz loops em todas as páginas retornadas de forma transparente. Para usar paginação e outras novas funcionalidades, consulte o conjunto de parâmetros "UsePagedAPI". Selecionar novos sinais de filtros para a consulta para usar paginação sob o capô. Caso contrário, selecione "UsePaging" para optar pela consulta paged.

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 o aplicativo "fabric:/samples/CalcApp2"

PS C:\> Get-ServiceFabricDeployedApplication -NodeName "VIPULM4-RK01-BD01" -ApplicationName fabric:/samples/CalcApp2

ApplicationName           : fabric:/samples/CalcApp2
ApplicationTypeName       : CalculatorApp
DeployedApplicationStatus : Active
WorkDirectory             : D:\ServiceFabric\Data\VIPULM4-RK01-BD01\Fabric\work\Applications\CalculatorApp_App5\work
LogDirectory              : D:\ServiceFabric\Data\VIPULM4-RK01-BD01\Fabric\work\Applications\CalculatorApp_App5\log
TempDirectory             : D:\ServiceFabric\Data\VIPULM4-RK01-BD01\Fabric\work\Applications\CalculatorApp_App5\temp
HealthState               : Unknown

Esse comando retorna aplicativos implantados. Neste exemplo, o DeployedApplicationStatus é Ativo e, portanto, Get-ServiceFabricDeployedApplication retorna os nomes de diretório nos valores de retorno WorkDirectory, LogDirectory e TempDirectory .

Exemplo 2: Obter o aplicativo "fabric:/samples/VQueueApp2"

PS C:\> Get-ServiceFabricDeployedApplication -NodeName VIPULM4-RK01-BD01 fabric:/samples/VQueueApp2

ApplicationName           : fabric:/samples/VQueueApp2
ApplicationTypeName       : VolatileQueueApp
DeployedApplicationStatus : Downloading
HealthState               : Unknown

Esse comando retorna aplicativos implantados. Neste exemplo, o DeployedApplicationStatus está baixando e, portanto, o comando retorna valores nulos para WorkDirectory, LogDirectory e TempDirectory.

Exemplo 3: Obter aplicativos com resultados máximos

PS C:\>Get-ServiceFabricDeployedApplication -NodeName _Node_1 -MaxResults 2 -GetSinglePage -Verbose

ApplicationName           : fabric:/samples/CalculatorApp
ApplicationTypeName       : CalculatorApp
DeployedApplicationStatus : Active
WorkDirectory             : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\work
LogDirectory              : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\log
TempDirectory             : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\temp
HealthState               : Unknown

ApplicationName           : fabric:/samples/PQueueApp1
ApplicationTypeName       : PersistentQueueApp
DeployedApplicationStatus : Active
WorkDirectory             : C:\SfDevCluster\Data\_App\_Node_1\PersistentQueueApp_App1\work
LogDirectory              : C:\SfDevCluster\Data\_App\_Node_1\PersistentQueueApp_App1\log
TempDirectory             : C:\SfDevCluster\Data\_App\_Node_1\PersistentQueueApp_App1\temp
HealthState               : Unknown

VERBOSE: Continuation Token: fabric:/samples/PQueueApp1

Esse comando obtém todos os aplicativos do Service Fabric implantados no nó fornecido no cluster que se encaixam em uma página. O tamanho da página é limitado ainda mais a dois itens, conforme configurado pelo parâmetro MaxResults. Como selecionamos a opção "GetSinglePage", essa consulta retornará apenas uma página de resultados. MaxResults não pode ser usado sem essa opção. Selecionar "Detalhado" imprime o valor do token de continuação retornado. Esse valor pode ser usado em uma consulta subsequente para obter a próxima página de resultados. Você também pode acessar o token de continuação retornado salvando os resultados retornados e acessando a propriedade "ContinuationToken". A propriedade "ContinuationToken" é nula é que não há nenhum token de continuação retornado.

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

PS C:\>Get-ServiceFabricDeployedApplication -NodeName _Node_1 -ContinuationToken fabric:/samples/PQueueApp1 -UsePaging

ApplicationName           : fabric:/samples/VQueueApp1
ApplicationTypeName       : VolatileQueueApp
DeployedApplicationStatus : Active
WorkDirectory             : C:\SfDevCluster\Data\_App\_Node_1\VolatileQueueApp_App2\work
LogDirectory              : C:\SfDevCluster\Data\_App\_Node_1\VolatileQueueApp_App2\log
TempDirectory             : C:\SfDevCluster\Data\_App\_Node_1\VolatileQueueApp_App2\temp
HealthState               : Unknown

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. Neste cluster de exemplo, há apenas um item que respeita o token de continuação. Se houver muitos aplicativos que respeitam o token de continuação fornecido no nó para caber em uma página de resultados, essa configuração de consulta retornará uma compilação de todas as páginas retornadas, fazendo um loop através delas de forma transparente; em seguida, a consulta retornará um vetor de todos os resultados. Para obter apenas uma página de resultados, selecione a opção "GetSinglePage".

Exemplo 5: Obter aplicativo com estado de integridade

PS C:\>Get-ServiceFabricDeployedApplication -NodeName _Node_1 -ApplicationName fabric:/samples/CalculatorApp -IncludeHealthState

ApplicationName           : fabric:/samples/CalculatorApp
ApplicationTypeName       : CalculatorApp
DeployedApplicationStatus : Active
WorkDirectory             : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\work
LogDirectory              : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\log
TempDirectory             : C:\SfDevCluster\Data\_App\_Node_1\CalculatorApp_App0\temp
HealthState               : Ok

Esse comando obtém o aplicativo do Service Fabric que corresponde ao nome do aplicativo fornecido e inclui seu estado de integridade.

Parâmetros

-ApplicationName

Especifica o URI (Uniform Resource Identifier) de um aplicativo do Service Fabric. O cmdlet obtém o aplicativo implantado que corresponde ao nome do aplicativo especificado. Essa consulta faz uma correspondência exata. Por exemplo, a malha do URI:/App não corresponderá à malha:/App1. No máximo um resultado será retornado se o nome do aplicativo for fornecido. Se o nome do aplicativo fornecido não corresponder a nenhum aplicativo no nó, a consulta retornará nulo.

Type:Uri
Position:1
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

-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:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeHealthState

Especifica se a consulta retornará o estado de integridade dos aplicativos implantados. Se esse parâmetro não for especificado, o estado de integridade retornado será "Desconhecido". Quando selecionada, a consulta fica paralela ao nó e ao serviço do sistema de integridade antes da mescla dos resultados. Consequentemente, a consulta é mais onerosa e pode levar mais tempo.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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

-NodeName

Especifica o nome de um nó do Service Fabric. O cmdlet obtém aplicativos implantados no nó especificado.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
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

-UsePaging

Especifica se a consulta será paginada. Se não estiver selecionada, essa consulta não funcionará quando houver muitos resultados para caber em uma página, conforme definido pela configuração de tamanho máximo da mensagem. Selecionar essa opção configura essa consulta para retornar todos os resultados, independentemente da configuração de tamanho máximo da mensagem. Ele faz isso obtendo resultados de páginas e fazendo loop em todas as páginas de forma transparente em nome do chamador.

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

Entradas

System.String

System.Uri

Saídas

System.Object