Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListLogAnalyticsEntitiesRequest

example

Click here to see how to use ListLogAnalyticsEntitiesRequest.

Properties

Optional cloudResourceId

cloudResourceId: undefined | string

A filter to return only log analytics entities whose cloudResourceId matches the cloudResourceId given.

compartmentId

compartmentId: string

The ID of the compartment in which to list resources.

Optional creationSourceDetails

creationSourceDetails: undefined | string

A filter to return only log analytics entities whose auto-creation source details contains the specified string.

Optional creationSourceType

creationSourceType: Array<CreationSourceType>

A filter to return only those log analytics entities with the specified auto-creation source.

Optional definedTagEquals

definedTagEquals: Array<string>

A list of tag filters to apply. Only entities with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".

Optional definedTagExists

definedTagExists: Array<string>

A list of tag existence filters to apply. Only entities for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".

Optional entityTypeName

entityTypeName: Array<string>

A filter to return only log analytics entities whose entityTypeName matches the entire log analytics entity type name of one of the entityTypeNames given in the list. The match is case-insensitive.

Optional freeformTagEquals

freeformTagEquals: Array<string>

A list of tag filters to apply. Only entities with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".

Optional freeformTagExists

freeformTagExists: Array<string>

A list of tag existence filters to apply. Only entities for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".

Optional hostname

hostname: undefined | string

A filter to return only log analytics entities whose hostname matches the entire hostname given.

Optional hostnameContains

hostnameContains: undefined | string

A filter to return only log analytics entities whose hostname contains the substring given. The match is case-insensitive.

Optional isManagementAgentIdNull

isManagementAgentIdNull: IsManagementAgentIdNull

A filter to return only those log analytics entities whose managementAgentId is null or is not null.

Optional isShowAssociatedSourcesCount

isShowAssociatedSourcesCount: undefined | false | true

Option to return count of associated log sources for log analytics entity(s).

Optional lifecycleDetailsContains

lifecycleDetailsContains: undefined | string

A filter to return only log analytics entities whose lifecycleDetails contains the specified string.

Optional lifecycleState

lifecycleState: model.EntityLifecycleStates

A filter to return only those log analytics entities with the specified lifecycle state. The state value is case-insensitive.

Optional limit

limit: undefined | number

The maximum number of items to return.

Optional metadataEquals

metadataEquals: Array<string>

A filter to return only log analytics entities whose metadata name, value and type matches the specified string. Each item in the array has the format "{name}:{value}:{type}". All inputs are case-insensitive.

Optional name

name: undefined | string

A filter to return only log analytics entities whose name matches the entire name given. The match is case-insensitive.

Optional nameContains

nameContains: undefined | string

A filter to return only log analytics entities whose name contains the name given. The match is case-insensitive.

namespaceName

namespaceName: string

The Logging Analytics namespace used for the request.

Optional opcRequestId

opcRequestId: undefined | string

The client request ID for tracing.

Optional page

page: undefined | string

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional sortBy

sortBy: SortBy

The field to sort entities by. Only one sort order may be provided. Default order for timeCreated and timeUpdated is descending. Default order for entity name is ascending. If no value is specified timeCreated is default.

Optional sortOrder

sortOrder: SortOrder

The sort order to use, either ascending ({@code ASC}) or descending ({@code DESC}).

Optional sourceId

sourceId: undefined | string

A filter to return only log analytics entities whose sourceId matches the sourceId given.