Partager via

Get-ServiceFabricDeployedApplication

  • Référence
Module:
ServiceFabric

Obtient la ou les applications Service Fabric sur un nœud spécifié.

Syntaxe

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

L’applet de commande Get-ServiceFabricDeployedApplication obtient la ou les applications Service Fabric déployées sur un nœud spécifié.

Service Fabric crée des répertoires de travail, de journal et temporaires sur le nœud pour chaque application déployée. Étant donné que les noms d’annuaire incluent l’ID d’application, les noms de répertoires ne peuvent pas être devinés. Lorsque DeployApplicationStatus est actif, Get-ServiceFabricDeployedApplication retourne les noms de répertoires dans les valeurs de retour WorkDirectory, LogDirectory et TempDirectory . Lorsque DeploymentApplicationStatus est en téléchargement, les valeurs WorkDirectory, LogDirectory et TempDirectory sont null.

Les services d’application déployés stockent leurs données persistantes dans WorkDirectory. À des fins de débogage ou de diagnostic, une autre application ou processus peut avoir besoin de connaître l’emplacement du Répertoire de travail.

Les services d’application déployés doivent stocker leur journal dans logDirectory créé par Service Fabric. Un chargeur personnalisé des fichiers journaux peut avoir besoin de connaître l’emplacement. L’emplacement du LogDirectory peut également être nécessaire à des fins de diagnostic quand une application sur un nœud particulier ne fonctionne pas comme prévu.

Par défaut, cette requête retourne un certain nombre de résultats limités à la configuration de taille maximale des messages. Les kits SDK et les clusters versions 6.1 ou ultérieures prennent en charge la fonctionnalité de pagination qui supprime cette restriction ; le nouveau comportement consiste à retourner les résultats indépendamment de la configuration maximale des messages, car cette requête effectue une boucle dans toutes les pages retournées de manière transparente. Pour utiliser la pagination et d’autres nouvelles fonctionnalités, consultez le jeu de paramètres « UsePagedAPI ». La sélection de nouveaux filtres signale à la requête d’utiliser la pagination sous le capot. Sinon, sélectionnez « UsePaging » pour choisir l’interrogation paginée.

Avant d’effectuer une opération sur un cluster Service Fabric, établissez une connexion au cluster à l’aide de l’applet de commande Connect-ServiceFabricCluster .

Exemples

Exemple 1 : Obtenir l’application « 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

Cette commande retourne des applications déployées. Dans cet exemple, DeployApplicationStatus est actif et, par conséquent, Get-ServiceFabricDeployedApplication retourne les noms de répertoires dans WorkDirectory, LogDirectory et TempDirectory .

Exemple 2 : Obtenir l’application « fabric:/samples/VQueueApp2 »

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

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

Cette commande retourne des applications déployées. Dans cet exemple, deploymentApplicationStatus est en cours de téléchargement et, par conséquent, la commande retourne des valeurs null pour WorkDirectory, LogDirectory et TempDirectory.

Exemple 3 : Obtenir des applications avec un maximum de résultats

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

Cette commande obtient toutes les applications Service Fabric déployées sur le nœud fourni dans le cluster qui s’intègrent à une page. La taille de la page est limitée à deux éléments, comme configuré par le paramètre MaxResults. Étant donné que nous avons sélectionné l’option « GetSinglePage », cette requête retourne une seule page de résultats. MaxResults ne peut pas être utilisé sans cette option. La sélection de « Verbose » imprime la valeur du jeton de continuation retournée. Cette valeur peut être utilisée dans une requête suivante pour obtenir la page suivante des résultats. Vous pouvez également accéder au jeton de continuation retourné en enregistrant les résultats retournés et en accédant à la propriété « ContinuationToken ». La propriété « ContinuationToken » a la valeur Null est qu’il n’existe aucun jeton de continuation retourné.

Exemple 4 : Obtenir une application avec un jeton de continuation

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

Cette commande obtient les applications Service Fabric qui respectent le jeton de continuation fourni qui s’intègre dans une seule page. Le jeton de continuation fourni à cette requête est le même que celui retourné par l’exemple ci-dessus. Dans cet exemple de cluster, il n’existe qu’un seul élément qui respecte le jeton de continuation. S’il existe trop d’applications qui respectent le jeton de continuation fourni sur le nœud pour s’adapter à une page de résultats, cette configuration de requête retourne une compilation de toutes les pages retournées, en boucle de manière transparente; la requête retourne ensuite un vecteur de tous les résultats. Pour obtenir une seule page de résultats, sélectionnez l’option « GetSinglePage ».

Exemple 5 : Obtenir l’application avec l’état d’intégrité

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

Cette commande obtient l’application Service Fabric qui correspond au nom de l’application fournie et inclut son état d’intégrité.

Paramètres

-ApplicationName

Spécifie l’URI (Uniform Resource Identifier) d’une application Service Fabric. L’applet de commande obtient l’application déployée qui correspond au nom de l’application spécifiée. Cette requête effectue une correspondance exacte. Par exemple, l’infrastructure URI :/App ne correspond pas à fabric:/App1. Au plus un résultat est retourné si le nom de l’application est fourni. Si le nom de l’application fourni ne correspond à aucune application sur le nœud, la requête retourne null.

Type:Uri
Position:1
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ContinuationToken

Spécifie le jeton de continuation qui peut être utilisé pour récupérer la page suivante des résultats de la requête.

Si trop de résultats respectent les filtres fournis, ils peuvent ne pas tenir dans un seul message. La pagination est utilisée pour tenir compte de ce problème en fractionnant la collection de résultats retournés en pages distinctes. Le jeton de continuation est utilisé pour savoir où la page précédente s’est arrêtée, n’portant que l’importance de la requête elle-même. Cette valeur doit être générée à partir de l’exécution de cette requête et peut être transmise à la requête de requête suivante afin d’obtenir les pages suivantes. Une valeur de jeton de continuation non Null est retournée dans le cadre du résultat uniquement s’il existe une page ultérieure. Si cette valeur est fournie sans l’option -GetSinglePage, la requête retourne toutes les pages en commençant par la valeur du jeton de continuation.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-GetSinglePage

Spécifie si la requête retourne une page de résultats de requête avec une valeur de jeton de continuation ou toutes les pages combinées dans une liste de résultats. Si cette option est sélectionnée, il incombe à l’appelant de la requête de vérifier les pages suivantes.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-IncludeHealthState

Spécifie si la requête retourne l’état d’intégrité des applications déployées. Si ce paramètre n’est pas spécifié, l’état d’intégrité retourné est « Inconnu ». Quand elle est sélectionnée, la requête est en parallèle avec le nœud et le service du système d’intégrité avant la fusion des résultats. Par conséquent, la requête est plus coûteuse et peut prendre plus de temps.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-MaxResults

Spécifie le nombre maximal d’éléments de résultat qui peuvent être retournés par page. Cela définit la limite supérieure pour le nombre de résultats retournés, et non un minimum. Par exemple, si la page correspond au maximum à 1 000 éléments retournés en fonction des restrictions de taille de message maximale définies dans la configuration et que la valeur MaxResults est définie sur 2000, seuls 1 000 résultats sont retournés, même si 2 000 éléments de résultat correspondent à la description de la requête.

Cette valeur nécessite la sélection de l’indicateur GetSinglePage ; elle sera ignorée dans le cas contraire.

Type:Int64
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-NodeName

Spécifie le nom d’un nœud Service Fabric. L’applet de commande obtient les applications déployées sur le nœud que vous spécifiez.

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-TimeoutSec

Spécifie le délai d’expiration, en secondes, pour l’opération.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-UsePaging

Spécifie si la requête sera paginée. Si elle n’est pas sélectionnée, cette requête ne fonctionnera pas lorsqu’il y a trop de résultats à ajuster à une page, comme défini par la configuration de la taille maximale du message. La sélection de cette option configure cette requête pour retourner tous les résultats, quelle que soit la configuration de la taille maximale du message. Pour ce faire, vous obtenez des résultats paginés et parcourez en boucle toutes les pages de manière transparente pour le compte de l’appelant.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

System.String

System.Uri

Sorties

System.Object