@azure/arm-alertsmanagement package

Classes

AlertsManagementClient

Interfaces

ActionStatus	Action status
ActionSuppressedDetails	model interface ActionSuppressedDetails
ActionTriggeredDetails	model interface ActionTriggeredDetails
Alert	An alert created in alert management service.
AlertEnrichmentItem	Alert enrichment item.
AlertEnrichmentProperties	Properties of the alert enrichment item.
AlertEnrichmentResponse	The alert's enrichments.
AlertModification	Alert Modification details
AlertModificationItem	Alert modification item.
AlertModificationProperties	Alert modification history properties.
AlertProperties	Alert property bag
AlertsChangeStateOptionalParams	Optional parameters.
AlertsChangeStateTenantOptionalParams	Optional parameters.
AlertsGetAllOptionalParams	Optional parameters.
AlertsGetAllTenantOptionalParams	Optional parameters.
AlertsGetByIdOptionalParams	Optional parameters.
AlertsGetByIdTenantOptionalParams	Optional parameters.
AlertsGetEnrichmentsOptionalParams	Optional parameters.
AlertsGetHistoryOptionalParams	Optional parameters.
AlertsGetHistoryTenantOptionalParams	Optional parameters.
AlertsGetSummaryOptionalParams	Optional parameters.
AlertsManagementClientOptionalParams	Optional parameters for the client.
AlertsManagementErrorResponse	An error response from the service.
AlertsMetaData	alert meta data information.
AlertsMetaDataOptionalParams	Optional parameters.
AlertsMetaDataProperties	alert meta data property bag
AlertsOperations	Interface representing a Alerts operations.
AlertsSummary	Summary of alerts based on the input filters and 'groupby' parameters.
AlertsSummaryGroup	Group the result set.
AlertsSummaryGroupItem	Alerts summary group item
ArmProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
BaseDetails	Base details class.
Comments	Change alert state reason
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ErrorResponseBody	Details of error response.
Essentials	This object contains consistent fields across different monitor services.
MonitorServiceDetails	Details of a monitor service
MonitorServiceList	Monitor service details
NotificationResult	model interface NotificationResult
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrometheusEnrichmentItem	Prometheus enrichment object.
PrometheusInstantQuery	Prometheus instant query enrichment object.
PrometheusRangeQuery	Prometheus instant query enrichment object.
PropertyChangeDetails	model interface PropertyChangeDetails
ProxyResource	An azure resource object
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
SystemData	Metadata pertaining to creation and last modification of the resource.
TriggeredRule	model interface TriggeredRule

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AlertEnrichmentItemUnion	Alias for AlertEnrichmentItemUnion
AlertModificationEvent	Reason for the modification
AlertModificationType	Type of modification details KnownAlertModificationType can be used interchangeably with AlertModificationType, this enum contains the known values that the service supports. Known values supported by the service PropertyChange: PropertyChange ActionsSuppressed: ActionsSuppressed ActionsTriggered: ActionsTriggered
AlertState	Type of AlertState
AlertsMetaDataPropertiesUnion	Alias for AlertsMetaDataPropertiesUnion
AlertsSortByFields	Type of AlertsSortByFields
AlertsSummaryGroupByFields	Type of AlertsSummaryGroupByFields
AzureSupportedClouds	The supported values for cloud setting as a string literal type
BaseDetailsUnion	Alias for BaseDetailsUnion
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
Identifier	Type of Identifier
MetadataIdentifier	Identification of the information to be retrieved by API call KnownMetadataIdentifier can be used interchangeably with MetadataIdentifier, this enum contains the known values that the service supports. Known values supported by the service MonitorServiceList: MonitorServiceList
MonitorCondition	Type of MonitorCondition
MonitorService	Type of MonitorService
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
PrometheusEnrichmentItemUnion	Alias for PrometheusEnrichmentItemUnion
ResultStatus	The status of the notification KnownResultStatus can be used interchangeably with ResultStatus, this enum contains the known values that the service supports. Known values supported by the service None: None Inline: Inline Throttled: Throttled Failed: Failed ThrottledByAlertRule: ThrottledByAlertRule ThrottledBySubscription: ThrottledBySubscription
RuleType	The rule type KnownRuleType can be used interchangeably with RuleType, this enum contains the known values that the service supports. Known values supported by the service AlertRule: AlertRule ActionRule: ActionRule
Severity	Type of Severity
SignalType	The type of signal the alert is based on, which could be metrics, logs or activity logs. KnownSignalType can be used interchangeably with SignalType, this enum contains the known values that the service supports. Known values supported by the service Metric: Metric Log: Log Unknown: Unknown
SortOrder	Type of SortOrder
Status	The status of the evaluation of the enrichment. KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Succeeded Failed: Failed
TimeRange	Type of TimeRange
Type	The enrichment type. KnownType can be used interchangeably with Type, this enum contains the known values that the service supports. Known values supported by the service PrometheusInstantQuery: PrometheusInstantQuery PrometheusRangeQuery: PrometheusRangeQuery PrometheusEnrichmentItem: PrometheusEnrichmentItem

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAlertModificationType	Type of modification details
KnownAlertState	Known values of AlertState that the service accepts.
KnownAlertsSortByFields	Known values of AlertsSortByFields that the service accepts.
KnownAlertsSummaryGroupByFields	Known values of AlertsSummaryGroupByFields that the service accepts.
KnownCreatedByType	The kind of entity that created the resource.
KnownIdentifier	Known values of Identifier that the service accepts.
KnownMetadataIdentifier	Identification of the information to be retrieved by API call
KnownMonitorCondition	Known values of MonitorCondition that the service accepts.
KnownMonitorService	Known values of MonitorService that the service accepts.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownResultStatus	The status of the notification
KnownRuleType	The rule type
KnownSeverity	Known values of Severity that the service accepts.
KnownSignalType	The type of signal the alert is based on, which could be metrics, logs or activity logs.
KnownSortOrder	Known values of SortOrder that the service accepts.
KnownStatus	The status of the evaluation of the enrichment.
KnownTimeRange	Known values of TimeRange that the service accepts.
KnownType	The enrichment type.
KnownVersions	The available API versions.