Get-ServiceFabricApplication

  • Reference
Modul:
ServiceFabric

Získá aplikace v clusteru Service Fabric.

Syntaxe

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

Rutina Get-ServiceFabricApplication získá aplikace v clusteru Service Fabric. Ve výchozím nastavení neexistují žádná omezení počtu výsledků dotazu, které může tento dotaz vrátit bez ohledu na konfiguraci maximální velikosti zprávy; i když se jedná o stránkovaný dotaz, na rozdíl od ekvivalentních volání REST nebo C#, výchozím chováním tohoto dotazu je transparentní procházení všech vrácených stránek. Možnost GetSinglePage nakonfiguruje tento dotaz tak, aby vrátil jednu stránku.

Před provedením jakékoli operace v clusteru Service Fabric vytvořte připojení ke clusteru pomocí rutiny Connect-ServiceFabricCluster.

Příklady

Příklad 1: Získání všech aplikací

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

Tento příkaz získá všechny aplikace v clusteru.

Příklad 2: Získání aplikace podle názvu

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

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

Tento příkaz získá konkrétní aplikaci s názvem fabric:/samples/PQueueApp1.

Příklad 3: Získání aplikace podle názvu typu

PS C:\>Get-ServiceFabricApplication -ApplicationTypeName PersistentQueueApp

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

Tento příkaz získá aplikace Service Fabric, jejichž název typu je PersistentQueueApp.

Příklad 4: Získání aplikace podle typu definice

PS C:\>Get-ServiceFabricApplication -ApplicationDefinitionKindFilter Compose

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

Tento příkaz získá aplikace Service Fabric definované popisem aplikace Service Fabric.

Příklad 5: Získání aplikace s maximálními výsledky

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

Tento příkaz získá všechny aplikace Service Fabric v clusteru, které se vejdou na stránku. V clusteru je sice více aplikací, ale parametr MaxResults vrátí pouze dva výsledky. Vzhledem k tomu, že se výsledky nevejdou na stránku, vrátí se hodnota tokenu pokračování označující přítomnost následujících stránek.

Příklad 6: Získání aplikace s tokenem pokračování

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:

Tento příkaz získá aplikace Service Fabric, které respektují poskytnutý token pro pokračování, který se vejde na jednu stránku. Token pro pokračování poskytnutý pro tento dotaz je stejný jako v předchozím příkladu. Možnost Podrobné zobrazení neobsahuje token pro pokračování, který symbolizuje, že nejsou k dispozici žádné další stránky.

Příklad 7: Získání aplikace podle názvu při vyloučení parametrů aplikace

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

Tento příkaz získá aplikaci Service Fabric, která odpovídá zadanému názvu aplikace. Jak je vidět z příkladu 5, tato aplikace má parametry aplikace, ale je vyloučena z vrácených výsledků kvůli příznaku ExcludeApplicationParameters.

Parametry

-ApplicationDefinitionKindFilter

Určuje filtr pro ApplicationDefinitionKindFilter na základě toho, jak je aplikace definována. Hodnotu lze získat ze členů nebo bitové operace u členů ApplicationDefinitionKindFilter. Vrátí se jenom aplikace, které odpovídají filtru. Je možné zadat maximálně jeden z ApplicationName, ApplicationTypeName nebo ApplicationDefinitionKindFilter. Pokud není zadán žádný filtr, vrátí se všechny aplikace.

Typ:ApplicationDefinitionKindFilter
Přípustné hodnoty:Default, ServiceFabricApplicationDescription, Compose, MeshApplicationDescription, All
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-ApplicationName

Určuje identifikátor URI (Uniform Resource Identifier) aplikace Service Fabric. Rutina získá aplikaci, která má zadaný identifikátor URI. Je možné zadat maximálně jeden z ApplicationName, ApplicationTypeName nebo ApplicationDefinitionKindFilter. Pokud není zadán žádný filtr, vrátí se všechny aplikace.

Typ:Uri
Position:0
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ApplicationTypeName

Určuje název typu aplikace, který se používá k filtrování aplikací pro dotazování. Je možné zadat maximálně jeden z ApplicationName, ApplicationTypeName nebo ApplicationDefinitionKindFilter. Pokud není zadán žádný filtr, vrátí se všechny aplikace.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ContinuationToken

Určuje token pokračování, který lze použít k načtení další stránky výsledků dotazu.

Pokud je zadaných filtrů respektuje příliš mnoho výsledků, nemusí se vejít do jedné zprávy. Stránkování se používá k tomuto nastavení rozdělením kolekce vrácených výsledků na samostatné stránky. Token pro pokračování se používá ke zjištění, kde předchozí stránka skončila, což má význam pouze pro samotný dotaz. Tato hodnota by měla být vygenerována spuštěním tohoto dotazu a lze ji předat do dalšího požadavku dotazu, aby bylo možné získat další stránky. Hodnota tokenu pokračování, která není null, se vrátí jako součást výsledku pouze v případě, že existuje další stránka. Pokud je tato hodnota zadaná bez možnosti -GetSinglePage, dotaz vrátí všechny stránky počínaje hodnotou tokenu pokračování.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-ExcludeApplicationParameters

Určuje, zda budou parametry aplikace vyloučeny z výsledku.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-GetSinglePage

Určuje, jestli dotaz vrátí jednu stránku výsledků dotazu s hodnotou tokenu pokračování nebo všechny stránky zkombinované do jednoho seznamu výsledků. Pokud je tato možnost vybraná, zodpovídá volající dotaz, aby zkontroloval další stránky.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-MaxResults

Určuje maximální počet výsledných položek, které lze vrátit na stránku. Tím se definuje horní mez počtu vrácených výsledků, nikoli minimálně. Pokud například stránka vyhovuje maximálně 1 000 vrácených položek podle maximálního omezení velikosti zprávy definované v konfiguraci a hodnota MaxResults je nastavená na 2000, vrátí se pouze 1 000 výsledků, i když 2000 výsledků odpovídá popisu dotazu. Tato hodnota vyžaduje výběr příznaku GetSinglePage; jinak se bude ignorovat.

Typ:Int64
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-TimeoutSec

Určuje časový limit operace v sekundách.

Typ:Int32
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

System.Uri

System.String

Výstupy

System.Object