AlertsOperations interface

Package:

@azure/arm-alertsmanagement

Interface representing a Alerts operations.

Properties

changeState	Change the state of an alert. If scope is a deleted resource then please use scope as parent resource of the delete resource. For example if my alert id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' and 'vm1' is deleted then if you want to change state of this particular alert then use parent resource of scope. So in this example change state call will look like this: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}'.
changeStateTenant	Change the state of an alert.
getAll	List all existing alerts, where the results can be filtered on the basis of multiple parameters (e.g. time range). The results can then be sorted on the basis specific fields, with the default being lastModifiedDateTime.
getAllTenant	List all existing alerts, where the results can be filtered on the basis of multiple parameters (e.g. time range). The results can then be sorted on the basis specific fields, with the default being lastModifiedDateTime.
getById	Get information related to a specific alert. If scope is a deleted resource then please use scope as parent resource of the delete resource. For example if my alert id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' and 'vm1' is deleted then if you want to get alert by id then use parent resource of scope. So in this example get alert by id call will look like this: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}'.
getByIdTenant	Get information related to a specific alert.
getEnrichments	Get the enrichments of an alert. It returns a collection of one object named default.
getHistory	Get the history of an alert, which captures any monitor condition changes (Fired/Resolved), alert state changes (New/Acknowledged/Closed) and applied action rules for that particular alert. If scope is a deleted resource then please use scope as parent resource of the delete resource. For example if my alert id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' and 'vm1' is deleted then if you want to get history of this particular alert then use parent resource of scope. So in this example get history call will look like this: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history'.
getHistoryTenant	Get the history of an alert, which captures any monitor condition changes (Fired/Resolved), alert state changes (New/Acknowledged/Closed) and applied action rules for that particular alert.
getSummary	Get a summarized count of your alerts grouped by various parameters (e.g. grouping by 'Severity' returns the count of alerts for each severity).
metaData	List alerts meta data information based on value of identifier parameter.

Property Details

changeState

Change the state of an alert. If scope is a deleted resource then please use scope as parent resource of the delete resource. For example if my alert id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' and 'vm1' is deleted then if you want to change state of this particular alert then use parent resource of scope. So in this example change state call will look like this: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}'.

changeState: (scope: string, alertId: string, newState: string, options?: AlertsChangeStateOptionalParams) => Promise<Alert>

Property Value

(scope: string, alertId: string, newState: string, options?: AlertsChangeStateOptionalParams) => Promise<Alert>

changeStateTenant

Change the state of an alert.

changeStateTenant: (alertId: string, newState: string, options?: AlertsChangeStateTenantOptionalParams) => Promise<Alert>

Property Value

(alertId: string, newState: string, options?: AlertsChangeStateTenantOptionalParams) => Promise<Alert>

getAll

List all existing alerts, where the results can be filtered on the basis of multiple parameters (e.g. time range). The results can then be sorted on the basis specific fields, with the default being lastModifiedDateTime.

getAll: (scope: string, options?: AlertsGetAllOptionalParams) => PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

Property Value

(scope: string, options?: AlertsGetAllOptionalParams) => PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

getAllTenant

List all existing alerts, where the results can be filtered on the basis of multiple parameters (e.g. time range). The results can then be sorted on the basis specific fields, with the default being lastModifiedDateTime.

getAllTenant: (options?: AlertsGetAllTenantOptionalParams) => PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

Property Value

(options?: AlertsGetAllTenantOptionalParams) => PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

getById

Get information related to a specific alert. If scope is a deleted resource then please use scope as parent resource of the delete resource. For example if my alert id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' and 'vm1' is deleted then if you want to get alert by id then use parent resource of scope. So in this example get alert by id call will look like this: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}'.

getById: (scope: string, alertId: string, options?: AlertsGetByIdOptionalParams) => Promise<Alert>

Property Value

(scope: string, alertId: string, options?: AlertsGetByIdOptionalParams) => Promise<Alert>

getByIdTenant

Get information related to a specific alert.

getByIdTenant: (alertId: string, options?: AlertsGetByIdTenantOptionalParams) => Promise<Alert>

Property Value

(alertId: string, options?: AlertsGetByIdTenantOptionalParams) => Promise<Alert>

getEnrichments

Get the enrichments of an alert. It returns a collection of one object named default.

getEnrichments: (scope: string, alertId: string, options?: AlertsGetEnrichmentsOptionalParams) => PagedAsyncIterableIterator<AlertEnrichmentResponse, AlertEnrichmentResponse[], PageSettings>

Property Value

(scope: string, alertId: string, options?: AlertsGetEnrichmentsOptionalParams) => PagedAsyncIterableIterator<AlertEnrichmentResponse, AlertEnrichmentResponse[], PageSettings>

getHistory

Get the history of an alert, which captures any monitor condition changes (Fired/Resolved), alert state changes (New/Acknowledged/Closed) and applied action rules for that particular alert. If scope is a deleted resource then please use scope as parent resource of the delete resource. For example if my alert id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' and 'vm1' is deleted then if you want to get history of this particular alert then use parent resource of scope. So in this example get history call will look like this: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history'.

getHistory: (scope: string, alertId: string, options?: AlertsGetHistoryOptionalParams) => Promise<AlertModification>

Property Value

(scope: string, alertId: string, options?: AlertsGetHistoryOptionalParams) => Promise<AlertModification>

getHistoryTenant

Get the history of an alert, which captures any monitor condition changes (Fired/Resolved), alert state changes (New/Acknowledged/Closed) and applied action rules for that particular alert.

getHistoryTenant: (alertId: string, options?: AlertsGetHistoryTenantOptionalParams) => Promise<AlertModification>

Property Value

(alertId: string, options?: AlertsGetHistoryTenantOptionalParams) => Promise<AlertModification>

getSummary

Get a summarized count of your alerts grouped by various parameters (e.g. grouping by 'Severity' returns the count of alerts for each severity).

getSummary: (scope: string, groupby: string, options?: AlertsGetSummaryOptionalParams) => Promise<AlertsSummary>

Property Value

(scope: string, groupby: string, options?: AlertsGetSummaryOptionalParams) => Promise<AlertsSummary>

metaData

List alerts meta data information based on value of identifier parameter.

metaData: (identifier: string, options?: AlertsMetaDataOptionalParams) => Promise<AlertsMetaData>

Property Value

(identifier: string, options?: AlertsMetaDataOptionalParams) => Promise<AlertsMetaData>