ServiceFabricClientGetApplicationInfoListOptionalParams

Optional Parameters.

Hierarchy

any
- ServiceFabricClientGetApplicationInfoListOptionalParams

Index

Properties

Optional applicationDefinitionKindFilter

applicationDefinitionKindFilter: undefined | number

Used to filter on ApplicationDefinitionKind, which is the mechanism used to define a Service Fabric application.

Default - Default value, which performs the same function as selecting "All". The value is

All - Filter that matches input with any ApplicationDefinitionKind value. The value is

65535.

ServiceFabricApplicationDescription - Filter that matches input with ApplicationDefinitionKind value ServiceFabricApplicationDescription. The value is 1.
Compose - Filter that matches input with ApplicationDefinitionKind value Compose. The value is 2. Default value: 0.

Optional applicationTypeName

applicationTypeName: undefined | string

The application type name used to filter the applications to query for. This value should not contain the application type version.

Optional continuationToken

continuationToken: undefined | string

The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.

Optional excludeApplicationParameters

excludeApplicationParameters: undefined | false | true

The flag that specifies whether application parameters will be excluded from the result. Default value: false.

Optional maxResults

maxResults: undefined | number

The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. Default value: 0.

Optional timeoutParameter

timeoutParameter: undefined | number

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. Default value: 60.