Get-ServiceFabricApplication

  • Referencia
Módulo:
ServiceFabric

Obtiene las aplicaciones del clúster de Service Fabric.

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

Description

El cmdlet Get-ServiceFabricApplication obtiene las aplicaciones del clúster de Service Fabric. De forma predeterminada, no hay restricciones en el número de resultados de la consulta que puede devolver esta consulta, independientemente de la configuración de tamaño máximo del mensaje; aunque se trata de una consulta paginada, a diferencia de las llamadas equivalentes de REST o C#, el comportamiento predeterminado de esta consulta es recorrer en bucle todas las páginas devueltas de forma transparente. La opción GetSinglePage configura esta consulta para devolver una sola página.

Antes de realizar cualquier operación en un clúster de Service Fabric, establezca una conexión con el clúster mediante el cmdlet Connect-ServiceFabricCluster .

Ejemplos

Ejemplo 1: Obtener todas las aplicaciones

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

Este comando obtiene todas las aplicaciones del clúster.

Ejemplo 2: Obtener la aplicación por nombre

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

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

Este comando obtiene la aplicación específica con el nombre fabric:/samples/PQueueApp1.

Ejemplo 3: Obtener la aplicación por nombre de tipo

PS C:\>Get-ServiceFabricApplication -ApplicationTypeName PersistentQueueApp

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

Este comando obtiene las aplicaciones de Service Fabric cuyo nombre de tipo es PersistentQueueApp.

Ejemplo 4: Obtener la aplicación por tipo de definición

PS C:\>Get-ServiceFabricApplication -ApplicationDefinitionKindFilter Compose

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

Este comando obtiene las aplicaciones de Service Fabric definidas por la descripción de la aplicación de Service Fabric.

Ejemplo 5: Obtención de la aplicación con resultados máximos

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

Este comando obtiene todas las aplicaciones de Service Fabric del clúster que caben en una página. Aunque hay más aplicaciones en el clúster, solo se devuelven dos resultados según lo configurado por el parámetro MaxResults. Dado que hay resultados que no caben en la página, se devuelve un valor de token de continuación, lo que indica la presencia de páginas posteriores.

Ejemplo 6: Obtención de la aplicación con token de continuació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:

Este comando obtiene las aplicaciones de Service Fabric que respetan el token de continuación proporcionado que cabe en una sola página. El token de continuación proporcionado a esta consulta es el mismo devuelto por el ejemplo anterior. La opción "Detallado" no muestra ningún token de continuación, lo que indica que no hay más páginas disponibles.

Ejemplo 7: Obtención de la aplicación por nombre al excluir los parámetros de la aplicación

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

Este comando obtiene la aplicación de Service Fabric que coincide con el nombre de aplicación proporcionado. Como se ve en el ejemplo 5, esta aplicación tiene parámetros de aplicación, pero se excluye de los resultados devueltos debido a la marca "ExcludeApplicationParameters".

Parámetros

-ApplicationDefinitionKindFilter

Especifica el filtro para ApplicationDefinitionKindFilter en función de cómo se define la aplicación. El valor se puede obtener de miembros o operaciones bit a bit en miembros de ApplicationDefinitionKindFilter. Solo se devuelven las aplicaciones que coinciden con el filtro. Como máximo, se puede especificar ApplicationName, ApplicationTypeName o ApplicationDefinitionKindFilter. Si no se especifica ningún filtro, se devuelven todas las aplicaciones.

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

Especifica el identificador uniforme de recursos (URI) de una aplicación de Service Fabric. El cmdlet obtiene la aplicación que tiene el URI especificado. Como máximo, se puede especificar ApplicationName, ApplicationTypeName o ApplicationDefinitionKindFilter. Si no se especifica ningún filtro, se devuelven todas las aplicaciones.

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

-ApplicationTypeName

Especifica el nombre del tipo de aplicación utilizado para filtrar las aplicaciones para las que se va a consultar. Como máximo, se puede especificar ApplicationName, ApplicationTypeName o ApplicationDefinitionKindFilter. Si no se especifica ningún filtro, se devuelven todas las aplicaciones.

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

-ContinuationToken

Especifica el token de continuación que se puede usar para recuperar la página siguiente de los resultados de la consulta.

Si hay demasiados resultados que respetan los filtros proporcionados, es posible que no se ajusten a un mensaje. La paginación se usa para tener en cuenta esto dividiendo la colección de resultados devueltos en páginas independientes. El token de continuación se usa para saber dónde se dejó la página anterior, llevando la importancia solo a la propia consulta. Este valor se debe generar a partir de la ejecución de esta consulta y se puede pasar a la siguiente solicitud de consulta para obtener páginas posteriores. Un valor de token de continuación que no es NULL se devuelve como parte del resultado solo si hay una página posterior. Si este valor se proporciona sin la opción -GetSinglePage, la consulta devolverá todas las páginas a partir del valor del token de continuación.

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

-ExcludeApplicationParameters

Especifica si los parámetros de aplicación se excluirán del resultado.

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

-GetSinglePage

Especifica si la consulta devolverá una página de resultados de consulta con un valor de token de continuación o todas las páginas combinadas en una lista de resultados. Si se selecciona esta opción, es responsabilidad del autor de la llamada de la consulta comprobar si hay páginas posteriores.

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

-MaxResults

Especifica el número máximo de elementos de resultado que se pueden devolver por página. Esto define el límite superior para el número de resultados devueltos, no como mínimo. Por ejemplo, si la página se ajusta como máximo a 1000 elementos devueltos según las restricciones de tamaño máximo de mensaje definidas en la configuración, y el valor MaxResults se establece en 2000, solo se devuelven 1000 resultados, incluso si 2000 elementos de resultado coinciden con la descripción de la consulta. Este valor requiere la selección de la marca GetSinglePage; de lo contrario, se omitirá.

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

-TimeoutSec

Especifica el período de tiempo de espera, en segundos, para la operación.

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

Entradas

System.Uri

System.String

Salidas

System.Object