Get-OCILoganalyticsEntitiesList

SYNOPSIS

Invokes LogAnalytics service - ListLogAnalyticsEntities operation.

SYNTAX

Limit

Get-OCILoganalyticsEntitiesList -NamespaceName <String> -CompartmentId <String> [-Name <String>] [-NameContains <String>] [-EntityTypeName <System.Collections.Generic.List`1[System.String]>] [-CloudResourceId <String>] [-LifecycleState <EntityLifecycleStates>] [-LifecycleDetailsContains <String>] [-IsManagementAgentIdNull <IsManagementAgentIdNullEnum>] [-Hostname <String>] [-HostnameContains <String>] [-SourceId <String>] [-CreationSourceType <System.Collections.Generic.List`1[Oci.LoganalyticsService.Models.CreationSourceType]>] [-CreationSourceDetails <String>] [-Limit <Int32>] [-Page <String>] [-SortOrder <SortOrderEnum>] [-SortBy <SortByEnum>] [-OpcRequestId <String>] [-MetadataEquals <System.Collections.Generic.List`1[System.String]>] [-DefinedTagEquals <System.Collections.Generic.List`1[System.String]>] [-FreeformTagEquals <System.Collections.Generic.List`1[System.String]>] [-DefinedTagExists <System.Collections.Generic.List`1[System.String]>] [-FreeformTagExists <System.Collections.Generic.List`1[System.String]>] [-IsShowAssociatedSourcesCount <Boolean>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCILoganalyticsEntitiesList -NamespaceName <String> -CompartmentId <String> [-Name <String>] [-NameContains <String>] [-EntityTypeName <System.Collections.Generic.List`1[System.String]>] [-CloudResourceId <String>] [-LifecycleState <EntityLifecycleStates>] [-LifecycleDetailsContains <String>] [-IsManagementAgentIdNull <IsManagementAgentIdNullEnum>] [-Hostname <String>] [-HostnameContains <String>] [-SourceId <String>] [-CreationSourceType <System.Collections.Generic.List`1[Oci.LoganalyticsService.Models.CreationSourceType]>] [-CreationSourceDetails <String>] [-Page <String>] [-SortOrder <SortOrderEnum>] [-SortBy <SortByEnum>] [-OpcRequestId <String>] [-MetadataEquals <System.Collections.Generic.List`1[System.String]>] [-DefinedTagEquals <System.Collections.Generic.List`1[System.String]>] [-FreeformTagEquals <System.Collections.Generic.List`1[System.String]>] [-DefinedTagExists <System.Collections.Generic.List`1[System.String]>] [-FreeformTagExists <System.Collections.Generic.List`1[System.String]>] [-IsShowAssociatedSourcesCount <Boolean>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Return a list of log analytics entities.

PARAMETERS

-All

Fetches all pages of results.

Type: SwitchParameter
Parameter Sets: AllPages
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AuthType

Type of authentication to use for making API requests. Default is Key based Authentication.

Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken

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

-CloudResourceId

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

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CompartmentId

The ID of the compartment in which to list resources.

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ConfigFile

The path to the config file.

Type: String
Parameter Sets: (All)
Aliases: None

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

-CreationSourceDetails

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

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CreationSourceType

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

Type: System.Collections.Generic.List`1[Oci.LoganalyticsService.Models.CreationSourceType]
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, EmBridge, BulkDiscovery, ServiceConnectorHub, Discovery, LoggingAnalytics, None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DefinedTagEquals

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".

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DefinedTagExists

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".

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Endpoint

The value to use as the service endpoint, including any required API version path.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-EntityTypeName

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.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-FreeformTagEquals

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".

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-FreeformTagExists

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".

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-FullResponse

Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Hostname

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

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-HostnameContains

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

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IsManagementAgentIdNull

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

Type: IsManagementAgentIdNullEnum
Parameter Sets: (All)
Aliases: None
Accepted values: True, False

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IsShowAssociatedSourcesCount

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

Type: Boolean
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-LifecycleDetailsContains

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

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-LifecycleState

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

Type: EntityLifecycleStates
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Active, Deleted

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Limit

The maximum number of items to return.

Type: Int32
Parameter Sets: Limit
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-MetadataEquals

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.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

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

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NameContains

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

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NamespaceName

The Logging Analytics namespace used for the request.

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NoRetry

Disable retry logic for calls to services.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

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

-OpcRequestId

The client request ID for tracing.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Page

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

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Profile

The profile in the config file to load.

Type: String
Parameter Sets: (All)
Aliases: None

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

-Region

Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

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

Type: SortByEnum
Parameter Sets: (All)
Aliases: None
Accepted values: TimeCreated, TimeUpdated, Name

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SortOrder

The sort order to use, either ascending (`ASC`) or descending (`DESC`).

Type: SortOrderEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Asc, Desc

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SourceId

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

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TimeOutInMillis

Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).

Type: Int32
Parameter Sets: (All)
Aliases: None

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

OUTPUTS

• Oci.LoganalyticsService.Models.LogAnalyticsEntityCollection
• Oci.LoganalyticsService.Responses.ListLogAnalyticsEntitiesResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples