Get-ServiceFabricApplication

  • Referenz
Modul:
ServiceFabric

Ruft die Anwendung(n) im Service Fabric-Cluster ab.

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>]

Beschreibung

Das Cmdlet "Get-ServiceFabricApplication " ruft die Anwendung(en) im Service Fabric-Cluster ab. Standardmäßig gibt es keine Einschränkungen für die Anzahl der Abfrageergebnisse, die von dieser Abfrage zurückgegeben werden können, unabhängig von der Konfiguration der maximalen Nachrichtengröße; Während dies eine seitenseitige Abfrage ist, im Gegensatz zu den REST- oder C#-äquivalenten Aufrufen, besteht das Standardverhalten dieser Abfrage darin, alle zurückgegebenen Seiten transparent zu durchlaufen. Mit der Option "GetSinglePage" wird diese Abfrage so konfiguriert, dass eine einzelne Seite zurückgegeben wird.

Bevor Sie einen Vorgang in einem Service Fabric-Cluster ausführen, stellen Sie mithilfe des Cmdlets Connect-ServiceFabricCluster eine Verbindung mit dem Cluster her.

Beispiele

Beispiel 1: Abrufen aller Anwendungen

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

Dieser Befehl ruft alle Anwendungen im Cluster ab.

Beispiel 2: Anwendung nach Name abrufen

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

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

Dieser Befehl ruft die spezifische Anwendung mit dem Namen fabric:/samples/PQueueApp1 ab.

Beispiel 3: Abrufen der Anwendung nach Typname

PS C:\>Get-ServiceFabricApplication -ApplicationTypeName PersistentQueueApp

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

Dieser Befehl ruft die Service Fabric-Anwendung(n) ab, deren Typname persistentQueueApp ist.

Beispiel 4: Abrufen der Anwendung nach Definitionsart

PS C:\>Get-ServiceFabricApplication -ApplicationDefinitionKindFilter Compose

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

Dieser Befehl ruft die Service Fabric-Anwendung(n) ab, die durch die Beschreibung der Service Fabric-Anwendung definiert wird.

Beispiel 5: Abrufen der Anwendung mit maximalen Ergebnissen

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

Dieser Befehl ruft alle Service Fabric-Anwendungen im Cluster ab, die auf eine Seite passen. Es gibt zwar mehr Anwendungen im Cluster, aber nur zwei Ergebnisse werden vom Parameter MaxResults wie konfiguriert zurückgegeben. Da ergebnisse vorhanden sind, die nicht auf die Seite passen, wird ein Fortsetzungstokenwert zurückgegeben, der die Anwesenheit der nachfolgenden Seiten angibt.

Beispiel 6: Anwendung mit Fortsetzungstoken abrufen

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:

Dieser Befehl ruft die Service Fabric-Anwendung ab, die das bereitgestellte Fortsetzungstoken respektiert, das in eine einzelne Seite passt. Das für diese Abfrage bereitgestellte Fortsetzungstoken ist dieselbe, die aus dem obigen Beispiel zurückgegeben wird. Die Option "Verbose" zeigt kein Fortsetzungstoken an, das symbolisiert, dass keine weiteren Seiten verfügbar sind.

Beispiel 7: Abrufen der Anwendung nach Name beim Ausschließen von Anwendungsparametern

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

Dieser Befehl ruft die Service Fabric-Anwendung ab, die dem angegebenen Anwendungsnamen entspricht. Wie in Beispiel 5 gezeigt, verfügt diese Anwendung über Anwendungsparameter, wird jedoch aufgrund des Flags "ExcludeApplicationParameters" aus den zurückgegebenen Ergebnissen ausgeschlossen.

Parameter

-ApplicationDefinitionKindFilter

Gibt den Filter für ApplicationDefinitionKindFilter basierend auf der Definition der Anwendung an. Der Wert kann von Mitgliedern oder bitweisen Vorgängen für Mitglieder von ApplicationDefinitionKindFilter abgerufen werden. Es werden nur Anwendungen zurückgegeben, die dem Filter entsprechen. Die meisten Anwendungen, ApplicationTypeName oder ApplicationDefinitionKindFilter können angegeben werden. Wenn kein Filter angegeben ist, werden alle Anwendungen zurückgegeben.

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

Gibt den URI (Uniform Resource Identifier) einer Service Fabric-Anwendung an. Das Cmdlet ruft die Anwendung ab, die den angegebenen URI aufweist. Die meisten Anwendungen, ApplicationTypeName oder ApplicationDefinitionKindFilter können angegeben werden. Wenn kein Filter angegeben ist, werden alle Anwendungen zurückgegeben.

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

-ApplicationTypeName

Gibt den Anwendungstypnamen an, der verwendet wird, um die Zuabfragen der Anwendungen zu filtern. Die meisten Anwendungen, ApplicationTypeName oder ApplicationDefinitionKindFilter können angegeben werden. Wenn kein Filter angegeben ist, werden alle Anwendungen zurückgegeben.

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

-ContinuationToken

Gibt das Fortsetzungstoken an, mit dem die nächste Seite der Abfrageergebnisse abgerufen werden kann.

Wenn zu viele Ergebnisse die bereitgestellten Filter respektieren, passen sie möglicherweise nicht in eine Nachricht. Paging wird verwendet, um dies zu berücksichtigen, indem die Sammlung zurückgegebener Ergebnisse in separate Seiten aufgeteilt wird. Das Fortsetzungstoken wird verwendet, um zu wissen, wo die vorherige Seite weggelassen wurde, wobei nur die Bedeutung für die Abfrage selbst besteht. Dieser Wert sollte aus der Ausführung dieser Abfrage generiert werden und kann an die nächste Abfrageanforderung übergeben werden, um nachfolgende Seiten abzurufen. Ein Nicht-Null-Fortsetzungstokenwert wird nur als Teil des Ergebnisses zurückgegeben, wenn eine nachfolgende Seite vorhanden ist. Wenn dieser Wert ohne die Option "-GetSinglePage" bereitgestellt wird, gibt die Abfrage alle Seiten zurück, die vom Fortsetzungstokenwert beginnen.

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

-ExcludeApplicationParameters

Gibt an, ob Anwendungsparameter aus dem Ergebnis ausgeschlossen werden.

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

-GetSinglePage

Gibt an, ob die Abfrage eine Seite von Abfrageergebnissen mit einem Fortsetzungstokenwert zurückgibt, oder ob alle Seiten in einer Liste der Ergebnisse kombiniert werden. Wenn diese Option ausgewählt ist, ist dies die Verantwortung des Aufrufers der Abfrage, um nach nachfolgenden Seiten zu suchen.

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

-MaxResults

Gibt die maximale Anzahl von Ergebniselementen an, die pro Seite zurückgegeben werden können. Dadurch wird die obere Grenze für die Anzahl der zurückgegebenen Ergebnisse definiert, nicht mindestens. Wenn die Seite beispielsweise maximal 1000 zurückgegebene Elemente entsprechend den in der Konfiguration definierten Einschränkungen für die Maximale Nachrichtengröße passt und der MaxResults-Wert auf 2000 festgelegt ist, werden nur 1000 Ergebnisse zurückgegeben, auch wenn 2000 Ergebniselemente der Abfragebeschreibung entsprechen. Dieser Wert erfordert die Auswahl des GetSinglePage-Flags; andernfalls wird sie ignoriert.

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

-TimeoutSec

Gibt den Timeoutzeitraum in Sekunden für den Vorgang an.

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

Eingaben

System.Uri

System.String

Ausgaben

System.Object