Alerts interface

Package:

@azure/arm-security

Interface representing a Alerts.

Methods

beginSimulate(string, AlertSimulatorRequestBody, AlertsSimulateOptionalParams)	Simulate security alerts
beginSimulateAndWait(string, AlertSimulatorRequestBody, AlertsSimulateOptionalParams)	Simulate security alerts
getResourceGroupLevel(string, string, string, AlertsGetResourceGroupLevelOptionalParams)	Get an alert that is associated a resource group or a resource in a resource group
getSubscriptionLevel(string, string, AlertsGetSubscriptionLevelOptionalParams)	Get an alert that is associated with a subscription
list(AlertsListOptionalParams)	List all the alerts that are associated with the subscription
listByResourceGroup(string, AlertsListByResourceGroupOptionalParams)	List all the alerts that are associated with the resource group
listResourceGroupLevelByRegion(string, string, AlertsListResourceGroupLevelByRegionOptionalParams)	List all the alerts that are associated with the resource group that are stored in a specific location
listSubscriptionLevelByRegion(string, AlertsListSubscriptionLevelByRegionOptionalParams)	List all the alerts that are associated with the subscription that are stored in a specific location
updateResourceGroupLevelStateToActivate(string, string, string, AlertsUpdateResourceGroupLevelStateToActivateOptionalParams)	Update the alert's state
updateResourceGroupLevelStateToDismiss(string, string, string, AlertsUpdateResourceGroupLevelStateToDismissOptionalParams)	Update the alert's state
updateResourceGroupLevelStateToInProgress(string, string, string, AlertsUpdateResourceGroupLevelStateToInProgressOptionalParams)	Update the alert's state
updateResourceGroupLevelStateToResolve(string, string, string, AlertsUpdateResourceGroupLevelStateToResolveOptionalParams)	Update the alert's state
updateSubscriptionLevelStateToActivate(string, string, AlertsUpdateSubscriptionLevelStateToActivateOptionalParams)	Update the alert's state
updateSubscriptionLevelStateToDismiss(string, string, AlertsUpdateSubscriptionLevelStateToDismissOptionalParams)	Update the alert's state
updateSubscriptionLevelStateToInProgress(string, string, AlertsUpdateSubscriptionLevelStateToInProgressOptionalParams)	Update the alert's state
updateSubscriptionLevelStateToResolve(string, string, AlertsUpdateSubscriptionLevelStateToResolveOptionalParams)	Update the alert's state

Method Details

beginSimulate(string, AlertSimulatorRequestBody, AlertsSimulateOptionalParams)

Simulate security alerts

function beginSimulate(ascLocation: string, alertSimulatorRequestBody: AlertSimulatorRequestBody, options?: AlertsSimulateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

ascLocation

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

alertSimulatorRequestBody

AlertSimulatorRequestBody

Alert Simulator Request Properties

options

AlertsSimulateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginSimulateAndWait(string, AlertSimulatorRequestBody, AlertsSimulateOptionalParams)

Simulate security alerts

function beginSimulateAndWait(ascLocation: string, alertSimulatorRequestBody: AlertSimulatorRequestBody, options?: AlertsSimulateOptionalParams): Promise<void>

Parameters

ascLocation

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

alertSimulatorRequestBody

AlertSimulatorRequestBody

Alert Simulator Request Properties

options

AlertsSimulateOptionalParams

The options parameters.

Returns

Promise<void>

getResourceGroupLevel(string, string, string, AlertsGetResourceGroupLevelOptionalParams)

Get an alert that is associated a resource group or a resource in a resource group

function getResourceGroupLevel(resourceGroupName: string, ascLocation: string, alertName: string, options?: AlertsGetResourceGroupLevelOptionalParams): Promise<Alert>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

ascLocation

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

alertName

string

Name of the alert object

options

AlertsGetResourceGroupLevelOptionalParams

The options parameters.

Returns

Promise<Alert>

getSubscriptionLevel(string, string, AlertsGetSubscriptionLevelOptionalParams)

Get an alert that is associated with a subscription

function getSubscriptionLevel(ascLocation: string, alertName: string, options?: AlertsGetSubscriptionLevelOptionalParams): Promise<Alert>

Parameters

ascLocation

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

alertName

string

Name of the alert object

options

AlertsGetSubscriptionLevelOptionalParams

The options parameters.

Returns

Promise<Alert>

list(AlertsListOptionalParams)

List all the alerts that are associated with the subscription

function list(options?: AlertsListOptionalParams): PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

Parameters

options

AlertsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

listByResourceGroup(string, AlertsListByResourceGroupOptionalParams)

List all the alerts that are associated with the resource group

function listByResourceGroup(resourceGroupName: string, options?: AlertsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

options

AlertsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

listResourceGroupLevelByRegion(string, string, AlertsListResourceGroupLevelByRegionOptionalParams)

List all the alerts that are associated with the resource group that are stored in a specific location

function listResourceGroupLevelByRegion(ascLocation: string, resourceGroupName: string, options?: AlertsListResourceGroupLevelByRegionOptionalParams): PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

Parameters

ascLocation

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

options

AlertsListResourceGroupLevelByRegionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

listSubscriptionLevelByRegion(string, AlertsListSubscriptionLevelByRegionOptionalParams)

List all the alerts that are associated with the subscription that are stored in a specific location

function listSubscriptionLevelByRegion(ascLocation: string, options?: AlertsListSubscriptionLevelByRegionOptionalParams): PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

Parameters

ascLocation

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

options

AlertsListSubscriptionLevelByRegionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Alert, Alert[], PageSettings>

updateResourceGroupLevelStateToActivate(string, string, string, AlertsUpdateResourceGroupLevelStateToActivateOptionalParams)

Update the alert's state

function updateResourceGroupLevelStateToActivate(resourceGroupName: string, ascLocation: string, alertName: string, options?: AlertsUpdateResourceGroupLevelStateToActivateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

ascLocation

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

alertName

string

Name of the alert object

options

AlertsUpdateResourceGroupLevelStateToActivateOptionalParams

The options parameters.

Returns

Promise<void>

updateResourceGroupLevelStateToDismiss(string, string, string, AlertsUpdateResourceGroupLevelStateToDismissOptionalParams)

Update the alert's state

function updateResourceGroupLevelStateToDismiss(resourceGroupName: string, ascLocation: string, alertName: string, options?: AlertsUpdateResourceGroupLevelStateToDismissOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

ascLocation

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

alertName

string

Name of the alert object

options

AlertsUpdateResourceGroupLevelStateToDismissOptionalParams

The options parameters.

Returns

Promise<void>

updateResourceGroupLevelStateToInProgress(string, string, string, AlertsUpdateResourceGroupLevelStateToInProgressOptionalParams)

Update the alert's state

function updateResourceGroupLevelStateToInProgress(resourceGroupName: string, ascLocation: string, alertName: string, options?: AlertsUpdateResourceGroupLevelStateToInProgressOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

ascLocation

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

alertName

string

Name of the alert object

options

AlertsUpdateResourceGroupLevelStateToInProgressOptionalParams

The options parameters.

Returns

Promise<void>

updateResourceGroupLevelStateToResolve(string, string, string, AlertsUpdateResourceGroupLevelStateToResolveOptionalParams)

Update the alert's state

function updateResourceGroupLevelStateToResolve(resourceGroupName: string, ascLocation: string, alertName: string, options?: AlertsUpdateResourceGroupLevelStateToResolveOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

ascLocation

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

alertName

string

Name of the alert object

options

AlertsUpdateResourceGroupLevelStateToResolveOptionalParams

The options parameters.

Returns

Promise<void>

updateSubscriptionLevelStateToActivate(string, string, AlertsUpdateSubscriptionLevelStateToActivateOptionalParams)

Update the alert's state

function updateSubscriptionLevelStateToActivate(ascLocation: string, alertName: string, options?: AlertsUpdateSubscriptionLevelStateToActivateOptionalParams): Promise<void>

Parameters

ascLocation

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

alertName

string

Name of the alert object

options

AlertsUpdateSubscriptionLevelStateToActivateOptionalParams

The options parameters.

Returns

Promise<void>

updateSubscriptionLevelStateToDismiss(string, string, AlertsUpdateSubscriptionLevelStateToDismissOptionalParams)

Update the alert's state

function updateSubscriptionLevelStateToDismiss(ascLocation: string, alertName: string, options?: AlertsUpdateSubscriptionLevelStateToDismissOptionalParams): Promise<void>

Parameters

ascLocation

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

alertName

string

Name of the alert object

options

AlertsUpdateSubscriptionLevelStateToDismissOptionalParams

The options parameters.

Returns

Promise<void>

updateSubscriptionLevelStateToInProgress(string, string, AlertsUpdateSubscriptionLevelStateToInProgressOptionalParams)

Update the alert's state

function updateSubscriptionLevelStateToInProgress(ascLocation: string, alertName: string, options?: AlertsUpdateSubscriptionLevelStateToInProgressOptionalParams): Promise<void>

Parameters

ascLocation

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

alertName

string

Name of the alert object

options

AlertsUpdateSubscriptionLevelStateToInProgressOptionalParams

The options parameters.

Returns

Promise<void>

updateSubscriptionLevelStateToResolve(string, string, AlertsUpdateSubscriptionLevelStateToResolveOptionalParams)

Update the alert's state

function updateSubscriptionLevelStateToResolve(ascLocation: string, alertName: string, options?: AlertsUpdateSubscriptionLevelStateToResolveOptionalParams): Promise<void>

Parameters

ascLocation

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

alertName

string

Name of the alert object

options

AlertsUpdateSubscriptionLevelStateToResolveOptionalParams

The options parameters.

Returns

Promise<void>