AlertsGetAllOptionalParams interface
Optional parameters.
- Extends
Properties
| alert |
Filter by specific alert rule. Default value is to select all. |
| alert |
Filter by state of the alert instance. Default value is to select all. |
| custom |
Filter by custom time range in the format <start-time>/<end-time> where time is in (ISO-8601 format)'. Permissible values is within 30 days from query time. Either timeRange or customTimeRange could be used but not both. Default is none. |
| include |
Include context which has contextual data specific to the monitor service. Default value is false' |
| include |
Include egress config which would be used for displaying the content in portal. Default value is 'false'. |
| monitor |
Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all. |
| monitor |
Filter by monitor service which generates the alert instance. Default value is select all. |
| page |
Determines number of alerts returned per page in response. Permissible value is between 1 to 250. When the "includeContent" filter is selected, maximum value allowed is 25. Default value is 25. |
| select | This filter allows to selection of the fields(comma separated) which would be part of the essential section. This would allow to project only the required fields rather than getting entire content. Default is to fetch all the fields in the essentials section. |
| severity | Filter by severity. Default value is select all. |
| smart |
Filter the alerts list by the Smart Group Id. Default value is none. |
| sort |
Sort the query results by input field, Default value is 'lastModifiedDateTime'. |
| sort |
Sort the query results order in either ascending or descending. Default value is 'desc' for time fields and 'asc' for others. |
| target |
Filter by target resource( which is full ARM ID) Default value is select all. |
| target |
Filter by target resource group name. Default value is select all. |
| target |
Filter by target resource type. Default value is select all. |
| time |
Filter by time range by below listed values. Default value is 1 day. |
Inherited Properties
| abort |
The signal which can be used to abort requests. |
| on |
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times. |
| request |
Options used when creating and sending HTTP requests for this operation. |
| tracing |
Options used when tracing is enabled. |
Property Details
alertRule
Filter by specific alert rule. Default value is to select all.
alertRule?: stringProperty Value
string
alertState
Filter by state of the alert instance. Default value is to select all.
alertState?: stringProperty Value
string
customTimeRange
Filter by custom time range in the format <start-time>/<end-time> where time is in (ISO-8601 format)'. Permissible values is within 30 days from query time. Either timeRange or customTimeRange could be used but not both. Default is none.
customTimeRange?: stringProperty Value
string
includeContext
Include context which has contextual data specific to the monitor service. Default value is false'
includeContext?: booleanProperty Value
boolean
includeEgressConfig
Include egress config which would be used for displaying the content in portal. Default value is 'false'.
includeEgressConfig?: booleanProperty Value
boolean
monitorCondition
Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all.
monitorCondition?: stringProperty Value
string
monitorService
Filter by monitor service which generates the alert instance. Default value is select all.
monitorService?: stringProperty Value
string
pageCount
Determines number of alerts returned per page in response. Permissible value is between 1 to 250. When the "includeContent" filter is selected, maximum value allowed is 25. Default value is 25.
pageCount?: numberProperty Value
number
select
This filter allows to selection of the fields(comma separated) which would be part of the essential section. This would allow to project only the required fields rather than getting entire content. Default is to fetch all the fields in the essentials section.
select?: stringProperty Value
string
severity
Filter by severity. Default value is select all.
severity?: stringProperty Value
string
smartGroupId
Filter the alerts list by the Smart Group Id. Default value is none.
smartGroupId?: stringProperty Value
string
sortBy
Sort the query results by input field, Default value is 'lastModifiedDateTime'.
sortBy?: stringProperty Value
string
sortOrder
Sort the query results order in either ascending or descending. Default value is 'desc' for time fields and 'asc' for others.
sortOrder?: stringProperty Value
string
targetResource
Filter by target resource( which is full ARM ID) Default value is select all.
targetResource?: stringProperty Value
string
targetResourceGroup
Filter by target resource group name. Default value is select all.
targetResourceGroup?: stringProperty Value
string
targetResourceType
Filter by target resource type. Default value is select all.
targetResourceType?: stringProperty Value
string
timeRange
Filter by time range by below listed values. Default value is 1 day.
timeRange?: stringProperty Value
string
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLikeProperty Value
Inherited From OperationOptions.abortSignal
onResponse
A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
onResponse?: RawResponseCallbackProperty Value
Inherited From OperationOptions.onResponse
requestOptions
Options used when creating and sending HTTP requests for this operation.
requestOptions?: OperationRequestOptionsProperty Value
Inherited From OperationOptions.requestOptions
tracingOptions
Options used when tracing is enabled.
tracingOptions?: OperationTracingOptionsProperty Value
Inherited From OperationOptions.tracingOptions
