AlertIncidents interface

Package:

@azure/arm-authorization

Interface representing a AlertIncidents.

Methods

get(string, string, string, AlertIncidentsGetOptionalParams)	Get the specified alert incident.
listForScope(string, string, AlertIncidentsListForScopeOptionalParams)	Gets alert incidents for a resource scope.
remediate(string, string, string, AlertIncidentsRemediateOptionalParams)	Remediate an alert incident.

Method Details

get(string, string, string, AlertIncidentsGetOptionalParams)

Get the specified alert incident.

function get(scope: string, alertId: string, alertIncidentId: string, options?: AlertIncidentsGetOptionalParams): Promise<AlertIncident>

Parameters

scope

string

The scope of the alert incident. The scope can be any REST resource instance. For example, use '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/' for a subscription, '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.

alertId

string

The name of the alert.

alertIncidentId

string

The name of the alert incident to get.

options

AlertIncidentsGetOptionalParams

The options parameters.

Returns

Promise<AlertIncident>

listForScope(string, string, AlertIncidentsListForScopeOptionalParams)

Gets alert incidents for a resource scope.

function listForScope(scope: string, alertId: string, options?: AlertIncidentsListForScopeOptionalParams): PagedAsyncIterableIterator<AlertIncident, AlertIncident[], PageSettings>

Parameters

scope

string

The scope of the alert incident.

alertId

string

The name of the alert.

options

AlertIncidentsListForScopeOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AlertIncident, AlertIncident[], PageSettings>

remediate(string, string, string, AlertIncidentsRemediateOptionalParams)

Remediate an alert incident.

function remediate(scope: string, alertId: string, alertIncidentId: string, options?: AlertIncidentsRemediateOptionalParams): Promise<void>

Parameters

scope

string

The scope of the alert incident.

alertId

string

The name of the alert.

alertIncidentId

string

The name of the alert incident to remediate.

options

AlertIncidentsRemediateOptionalParams

The options parameters.

Returns

Promise<void>