Get-ServiceFabricApplication

  • Référence
Module:
ServiceFabric

Obtient la ou les applications sur le cluster 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

L’applet de commande Get-ServiceFabricApplication obtient les applications sur le cluster Service Fabric. Par défaut, il n’existe aucune restriction sur le nombre de résultats de requête qui peuvent être retournés par cette requête, quelle que soit la configuration de la taille maximale des messages ; bien qu’il s’agit d’une requête paginée, contrairement aux appels équivalents REST ou C#, le comportement par défaut de cette requête consiste à parcourir en boucle toutes les pages retournées de manière transparente. L’option GetSinglePage configure cette requête pour retourner une seule page.

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 toutes les applications

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

Cette commande obtient toutes les applications du cluster.

Exemple 2 : Obtenir l’application par nom

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

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

Cette commande obtient l’application spécifique avec le nom fabric:/samples/PQueueApp1.

Exemple 3 : Obtenir l’application par nom de type

PS C:\>Get-ServiceFabricApplication -ApplicationTypeName PersistentQueueApp

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

Cette commande obtient la ou les applications Service Fabric dont le nom de type est PersistentQueueApp.

Exemple 4 : Obtenir l’application par type de définition

PS C:\>Get-ServiceFabricApplication -ApplicationDefinitionKindFilter Compose

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

Cette commande obtient la ou les applications Service Fabric qui sont définies par la description de l’application Service Fabric.

Exemple 5 : Obtenir une application avec un maximum de résultats

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

Cette commande obtient toutes les applications Service Fabric du cluster qui s’intègrent à une page. Bien qu’il existe d’autres applications dans le cluster, seuls deux résultats sont retournés comme configurés par le paramètre MaxResults. Étant donné qu’il existe des résultats qui ne tiennent pas sur la page, une valeur de jeton de continuation est retournée, indiquant la présence de pages suivantes.

Exemple 6 : Obtenir une application avec un jeton de continuation

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:

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. L’option « Verbose » n’affiche aucun jeton de continuation, symbolisant qu’aucune autre page n’est disponible.

Exemple 7 : Obtenir l’application par nom tout en excluant les paramètres d’application

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

Cette commande obtient l’application Service Fabric qui correspond au nom de l’application fournie. Comme l’illustre l’exemple 5, cette application a des paramètres d’application, mais elle est exclue des résultats retournés en raison de l’indicateur « ExcludeApplicationParameters »

Paramètres

-ApplicationDefinitionKindFilter

Spécifie le filtre pour ApplicationDefinitionKindFilter en fonction de la façon dont l’application est définie. La valeur peut être obtenue à partir de membres ou d’opérations au niveau du bit sur les membres d’ApplicationDefinitionKindFilter. Seules les applications qui correspondent au filtre sont retournées. Au plus l’une des applications ApplicationName, ApplicationTypeName ou ApplicationDefinitionKindFilter peut être spécifiée. Si aucun filtre n’est spécifié, toutes les applications sont retournées.

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

Spécifie l’URI (Uniform Resource Identifier) d’une application Service Fabric. L’applet de commande obtient l’application qui a l’URI spécifié. Au plus l’une des applications ApplicationName, ApplicationTypeName ou ApplicationDefinitionKindFilter peut être spécifiée. Si aucun filtre n’est spécifié, toutes les applications sont retournées.

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

-ApplicationTypeName

Spécifie le nom du type d’application utilisé pour filtrer les applications à rechercher. Au plus l’une des applications ApplicationName, ApplicationTypeName ou ApplicationDefinitionKindFilter peut être spécifiée. Si aucun filtre n’est spécifié, toutes les applications sont retournées.

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

-ExcludeApplicationParameters

Spécifie si les paramètres d’application seront exclus du résultat.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters: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
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TimeoutSec

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

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

Entrées

System.Uri

System.String

Sorties

System.Object