Get-ServiceFabricApplication

  • Ссылка
Модуль:
ServiceFabric

Возвращает приложения в кластере Service Fabric.

Синтаксис

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

Описание

Командлет Get-ServiceFabricApplication получает приложения в кластере Service Fabric. По умолчанию нет ограничений на количество результатов запроса, которые могут быть возвращены этим запросом, независимо от конфигурации максимального размера сообщения; Хотя это страничный запрос, в отличие от эквивалентных вызовов REST или C#, поведение этого запроса по умолчанию заключается в том, чтобы циклически выполнять все возвращаемые страницы прозрачно. Параметр GetSinglePage настраивает этот запрос для возврата одной страницы.

Перед выполнением любой операции в кластере Service Fabric установите подключение к кластеру с помощью командлета Connect-ServiceFabricCluster .

Примеры

Пример 1. Получение всех приложений

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

Эта команда получает все приложения в кластере.

Пример 2. Получение приложения по имени

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

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

Эта команда возвращает конкретное приложение с именем fabric:/samples/PQueueApp1.

Пример 3. Получение приложения по имени типа

PS C:\>Get-ServiceFabricApplication -ApplicationTypeName PersistentQueueApp

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

Эта команда возвращает приложения Service Fabric, имя типа которого — PersistentQueueApp.

Пример 4. Получение приложения по типу определения

PS C:\>Get-ServiceFabricApplication -ApplicationDefinitionKindFilter Compose

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

Эта команда получает приложения Service Fabric, определенные с помощью описания приложения Service Fabric.

Пример 5. Получение приложения с максимальными результатами

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

Эта команда получает все приложения Service Fabric в кластере, которые помещаются на страницу. Хотя в кластере есть больше приложений, в параметре MaxResults возвращаются только два результата. Поскольку на странице отсутствуют результаты, возвращается значение маркера продолжения, указывающее наличие последующих страниц.

Пример 6. Получение приложения с маркером продолжения

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:

Эта команда получает приложения Service Fabric, которые учитывают предоставленный маркер продолжения, который помещается на одну страницу. Маркер продолжения, предоставленный этому запросу, совпадает с указанным выше примером. Параметр "Подробный" не показывает маркер продолжения, символизируя отсутствие доступных страниц.

Пример 7. Получение приложения по имени при исключении параметров приложения

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

Эта команда возвращает приложение Service Fabric, соответствующее указанному имени приложения. Как видно из примера 5, это приложение имеет параметры приложения, но исключается из возвращаемых результатов из-за флага ExcludeApplicationParameters

Параметры

-ApplicationDefinitionKindFilter

Указывает фильтр для ApplicationDefinitionKindFilter на основе определения приложения. Значение можно получить из членов или побитовых операций с элементами ApplicationDefinitionKindFilter. Возвращаются только те приложения, которые соответствуют заданному фильтру. Можно указать не более одного из ApplicationName, ApplicationTypeName или ApplicationDefinitionKindFilter. Если фильтр не указан, возвращаются все приложения.

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

Указывает универсальный код ресурса (URI) приложения Service Fabric. Командлет получает приложение с указанным универсальным кодом ресурса (URI). Можно указать не более одного из ApplicationName, ApplicationTypeName или ApplicationDefinitionKindFilter. Если фильтр не указан, возвращаются все приложения.

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

-ApplicationTypeName

Указывает имя типа приложения, используемое для фильтрации приложений для запроса. Можно указать не более одного из ApplicationName, ApplicationTypeName или ApplicationDefinitionKindFilter. Если фильтр не указан, возвращаются все приложения.

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

-ContinuationToken

Указывает маркер продолжения, который можно использовать для получения следующей страницы результатов запроса.

Если слишком много результатов учитывают предоставленные фильтры, они могут не помещаться в одно сообщение. Подкачки используются для учета этого путем разделения коллекции возвращаемых результатов на отдельные страницы. Маркер продолжения используется для того, чтобы узнать, где слева предыдущая страница, несущая значение только для самого запроса. Это значение должно быть создано при выполнении этого запроса и может быть передано в следующий запрос запроса, чтобы получить последующие страницы. Значение маркера продолжения, отличное от NULL, возвращается в результате только в том случае, если есть следующая страница. Если это значение предоставлено без параметра -GetSinglePage, запрос вернет все страницы, начиная со значения токена продолжения.

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

-ExcludeApplicationParameters

Указывает, будут ли исключены параметры приложения из результата.

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

-GetSinglePage

Указывает, будет ли запрос возвращать одну страницу результатов запроса со значением токена продолжения или все страницы, объединенные в один список результатов. Если этот параметр выбран, вызывающий запрос отвечает за проверку на наличие последующих страниц.

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

-MaxResults

Указывает максимальное число элементов результатов, которые можно вернуть на страницу. Это определяет верхнюю границу для числа возвращаемых результатов, а не минимума. Например, если страница помещается не более 1000 возвращаемых элементов в соответствии с ограничениями максимального размера сообщения, определенными в конфигурации, а значение MaxResults равно 2000, возвращается только 1000 результатов, даже если 2000 элементов результатов соответствуют описанию запроса. Для этого значения требуется выбрать флаг GetSinglePage; В противном случае он будет игнорироваться.

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

-TimeoutSec

Указывает период времени ожидания (в секундах) для операции.

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

Входные данные

System.Uri

System.String

Выходные данные

System.Object