Skip to content
Logic.Monitor PowerShell Module

Get-EAIQueryField

Syntax

Section titled “Syntax”

__AllParameterSets

Section titled “__AllParameterSets”
Terminal window
Get-EAIQueryField [[-RecordType] <string>] [[-Usage] <string>] [<CommonParameters>]

Description

Section titled “Description”

Get-EAIQueryField returns the query-path field names used by Invoke-EAIRecordsQuery, Build-EAIQueryFilter, and related Edwin UI Query APIs. These names often differ from properties on objects returned by the API (for example meta.eventTimestamp vs cf.eventTime).

Use this cmdlet to discover valid -OrderField, -Field, and filter field references before building queries.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
Get-EAIQueryField

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
Get-EAIQueryField -RecordType events -Usage Order

EXAMPLE 3

Section titled “EXAMPLE 3”
Terminal window
Get-EAIQueryField -RecordType alerts -Usage Filter | Format-Table Field, Label, Type

Parameters

Section titled “Parameters”

-RecordType

Section titled “-RecordType”

Optional record table filter: events, alerts, or insights.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Usage

Section titled “-Usage”

Optional usage filter: Filter, Order, or Return (field projection).

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

Section titled “CommonParameters”

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