Get-ServiceFabricApplication

  • Odwołanie
Moduł:
ServiceFabric

Pobiera aplikacje w klastrze usługi Service Fabric.

Składnia

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

Opis

Polecenie cmdlet Get-ServiceFabricApplication pobiera aplikacje w klastrze usługi Service Fabric. Domyślnie nie ma żadnych ograniczeń dotyczących liczby wyników zapytania, które mogą być zwracane przez to zapytanie, niezależnie od konfiguracji maksymalnego rozmiaru komunikatu; chociaż jest to zapytanie stronicowane, w przeciwieństwie do wywołań równoważnych REST lub C#, domyślnym zachowaniem tego zapytania jest pętla przez wszystkie zwrócone strony w sposób niewidoczny. Opcja GetSinglePage konfiguruje to zapytanie w celu zwrócenia jednej strony.

Przed wykonaniem dowolnej operacji w klastrze usługi Service Fabric ustanów połączenie z klastrem przy użyciu polecenia cmdlet Connect-ServiceFabricCluster .

Przykłady

Przykład 1. Pobieranie wszystkich aplikacji

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

To polecenie pobiera wszystkie aplikacje w klastrze.

Przykład 2. Pobieranie aplikacji według nazwy

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

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

To polecenie pobiera konkretną aplikację o nazwie fabric:/samples/PQueueApp1.

Przykład 3. Pobieranie aplikacji według nazwy typu

PS C:\>Get-ServiceFabricApplication -ApplicationTypeName PersistentQueueApp

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

To polecenie pobiera aplikacje usługi Service Fabric, których nazwa typu to PersistentQueueApp.

Przykład 4. Pobieranie aplikacji według rodzaju definicji

PS C:\>Get-ServiceFabricApplication -ApplicationDefinitionKindFilter Compose

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

To polecenie pobiera aplikacje usługi Service Fabric zdefiniowane przez opis aplikacji usługi Service Fabric.

Przykład 5. Pobieranie aplikacji z maksymalnymi wynikami

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

To polecenie pobiera wszystkie aplikacje usługi Service Fabric w klastrze, które mieszczą się na stronie. Chociaż w klastrze jest więcej aplikacji, tylko dwa wyniki są zwracane zgodnie z konfiguracją parametru MaxResults. Ponieważ istnieją wyniki, które nie mieszczą się na stronie, zwracana jest wartość tokenu kontynuacji wskazująca obecność kolejnych stron.

Przykład 6. Pobieranie aplikacji z tokenem kontynuacji

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:

To polecenie pobiera aplikacje usługi Service Fabric, które szanują podany token kontynuacji, który mieści się w jednej stronie. Token kontynuacji dostarczony do tego zapytania jest taki sam, który został zwrócony z powyższego przykładu. Opcja "Pełne" nie pokazuje tokenu kontynuacji, co oznacza, że nie są dostępne żadne strony.

Przykład 7. Pobieranie aplikacji według nazwy podczas wykluczania parametrów aplikacji

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

To polecenie pobiera aplikację usługi Service Fabric zgodną z podaną nazwą aplikacji. Jak widać na przykładzie 5, ta aplikacja ma parametry aplikacji, ale jest wykluczona z zwróconych wyników z powodu flagi "ExcludeApplicationParameters"

Parametry

-ApplicationDefinitionKindFilter

Określa filtr parametru ApplicationDefinitionKindFilter na podstawie sposobu definiowania aplikacji. Wartość można uzyskać z elementów członkowskich lub operacji bitowych na elementach członkowskich ApplicationDefinitionKindFilter. Zwracane są tylko aplikacje zgodne z filtrem. Można określić co najwyżej jedną z parametrów ApplicationName, ApplicationTypeName lub ApplicationDefinitionKindFilter. Jeśli nie określono żadnego filtru, zwracane są wszystkie aplikacje.

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

Określa identyfikator URI (Uniform Resource Identifier) aplikacji usługi Service Fabric. Polecenie cmdlet pobiera aplikację z określonym identyfikatorem URI. Można określić co najwyżej jedną z parametrów ApplicationName, ApplicationTypeName lub ApplicationDefinitionKindFilter. Jeśli nie określono żadnego filtru, zwracane są wszystkie aplikacje.

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

-ApplicationTypeName

Określa nazwę typu aplikacji używaną do filtrowania aplikacji do wykonywania zapytań. Można określić co najwyżej jedną z parametrów ApplicationName, ApplicationTypeName lub ApplicationDefinitionKindFilter. Jeśli nie określono żadnego filtru, zwracane są wszystkie aplikacje.

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

-ContinuationToken

Określa token kontynuacji, który może służyć do pobierania następnej strony wyników zapytania.

Jeśli zbyt wiele wyników szanuje podane filtry, mogą nie mieścić się w jednym komunikacie. Stronicowanie jest używane do tego celu przez podzielenie kolekcji zwróconych wyników na oddzielne strony. Token kontynuacji służy do poznania miejsca, w którym została przerwana poprzednia strona, niosąc znaczenie tylko dla samego zapytania. Ta wartość powinna być generowana na podstawie uruchamiania tego zapytania i może zostać przekazana do następnego żądania zapytania, aby uzyskać kolejne strony. Wartość tokenu kontynuacji innej niż null jest zwracana w ramach wyniku tylko wtedy, gdy istnieje kolejna strona. Jeśli ta wartość zostanie podana bez opcji -GetSinglePage, zapytanie zwróci wszystkie strony rozpoczynające się od wartości tokenu kontynuacji.

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

-ExcludeApplicationParameters

Określa, czy parametry aplikacji zostaną wykluczone z wyniku.

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

-GetSinglePage

Określa, czy zapytanie zwróci jedną stronę wyników zapytania z wartością tokenu kontynuacji, czy wszystkie strony połączone w jedną listę wyników. Jeśli ta opcja jest zaznaczona, odpowiedzialność za obiekt wywołujący zapytanie jest odpowiedzialny za sprawdzenie kolejnych stron.

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

-MaxResults

Określa maksymalną liczbę elementów wyników, które można zwrócić na stronę. Definiuje górną granicę liczby zwróconych wyników, a nie minimum. Jeśli na przykład strona pasuje do maksymalnie 1000 zwróconych elementów zgodnie z maksymalnymi ograniczeniami rozmiaru komunikatów zdefiniowanymi w konfiguracji, a wartość MaxResults jest ustawiona na 2000, zwracane są tylko 1000 wyników, nawet jeśli 2000 elementów wyników jest zgodne z opisem zapytania. Ta wartość wymaga wybrania flagi GetSinglePage; zostanie zignorowana w przeciwnym razie.

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

-TimeoutSec

Określa limit czasu dla operacji w sekundach.

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

Dane wejściowe

System.Uri

System.String

Dane wyjściowe

System.Object