Get-ServiceFabricApplication

  • Referenz
Modul:
ServiceFabric

Ruft die Anwendung(en) 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 es sich bei dieser Abfrage um eine seitenseitige Abfrage handelt, 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 auf 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 anhand des Namens 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 einer 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(en) ab, die von der Dienst Fabric-Anwendungsbeschreibung definiert sind.

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 wie vom MaxResults-Parameter konfiguriert zurückgegeben. Da es Ergebnisse gibt, die nicht auf die Seite passen, wird ein Fortsetzungstokenwert zurückgegeben, der angibt, dass nachfolgende Seiten vorhanden sind.

Beispiel 6: Abrufen einer Anwendung mit Fortsetzungstoken

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(en) ab, die das bereitgestellte Fortsetzungstoken respektieren, 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 und zeigt an, dass keine weiteren Seiten verfügbar sind.

Beispiel 7: Abrufen der Anwendung anhand des Namens 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, weist diese Anwendung Anwendungsparameter auf, ist jedoch aufgrund des Flags "ExcludeApplicationParameters" vom zurückgegebenen Ergebnis ausgeschlossen.

Parameter

-ApplicationDefinitionKindFilter

Gibt den Filter für ApplicationDefinitionKindFilter basierend auf der Definition der Anwendung an. Der Wert kann aus Membern oder bitweisen Vorgängen für Elemente von ApplicationDefinitionKindFilterabgerufen werden. Es werden nur Anwendungen zurückgegeben, die dem Filter entsprechen. Mindestens einer von ApplicationName, ApplicationTypeName oder ApplicationDefinitionKindFilter kann angegeben werden. Wenn kein Filter angegeben ist, werden alle Anwendungen zurückgegeben.

Typ:ApplicationDefinitionKindFilter
Zulässige Werte:Default, ServiceFabricApplicationDescription, Compose, MeshApplicationDescription, All
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ApplicationName

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

Typ:Uri
Position:0
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ApplicationTypeName

Gibt den Anwendungstypnamen an, der zum Filtern der abzufragenden Anwendungen verwendet wird. Mindestens einer von ApplicationName, ApplicationTypeName oder ApplicationDefinitionKindFilter kann angegeben werden. Wenn kein Filter angegeben ist, werden alle Anwendungen zurückgegeben.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ContinuationToken

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

Wenn zu viele Ergebnisse die bereitgestellten Filter berücksichtigen, passen sie möglicherweise nicht in eine Nachricht. Paging wird verwendet, um dies zu berücksichtigen, indem die Sammlung der zurückgegebenen Ergebnisse in separate Seiten aufgeteilt wird. Das Fortsetzungstoken wird verwendet, um zu wissen, wo die vorherige Seite aufgehört hat, wobei nur die Abfrage selbst von Bedeutung ist. 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 ab dem Fortsetzungstokenwert zurück.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ExcludeApplicationParameters

Gibt an, ob Anwendungsparameter vom Ergebnis ausgeschlossen werden.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-GetSinglePage

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

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren: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 gemäß den in der Konfiguration definierten Einschränkungen für die maximale Nachrichtengröße einpasst und der MaxResults-Wert auf 2000 festgelegt ist, werden nur 1000 Ergebnisse zurückgegeben, auch wenn 2000 Ergebniselemente der Abfragebeschreibung entsprechen. Für diesen Wert ist die Auswahl des GetSinglePage-Flags erforderlich; andernfalls wird sie ignoriert.

Typ:Int64
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-TimeoutSec

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

Typ:Int32
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

System.Uri

System.String

Ausgaben

System.Object