AlertsOperations interface

Package:

@azure/arm-security

Interface representing a Alerts operations.

Properties

beginSimulate
beginSimulateAndWait
getResourceGroupLevel	Get an alert that is associated a resource group or a resource in a resource group
getSubscriptionLevel	Get an alert that is associated with a subscription
list	List all the alerts that are associated with the subscription
listByResourceGroup	List all the alerts that are associated with the resource group
listResourceGroupLevelByRegion	List all the alerts that are associated with the resource group that are stored in a specific location
listSubscriptionLevelByRegion	List all the alerts that are associated with the subscription that are stored in a specific location
simulate	Simulate security alerts
updateResourceGroupLevelStateToActivate	Update the alert's state
updateResourceGroupLevelStateToDismiss	Update the alert's state
updateResourceGroupLevelStateToInProgress	Update the alert's state
updateResourceGroupLevelStateToResolve	Update the alert's state
updateSubscriptionLevelStateToActivate	Update the alert's state
updateSubscriptionLevelStateToDismiss	Update the alert's state
updateSubscriptionLevelStateToInProgress	Update the alert's state
updateSubscriptionLevelStateToResolve	Update the alert's state

Property Details

beginSimulate

Warning

This API is now deprecated.

use simulate instead

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

Property Value

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

beginSimulateAndWait

Warning

This API is now deprecated.

use simulate instead

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

Property Value

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

getResourceGroupLevel

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

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

Property Value

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

getSubscriptionLevel

Get an alert that is associated with a subscription

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

Property Value

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

list

List all the alerts that are associated with the subscription

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

Property Value

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

listByResourceGroup

List all the alerts that are associated with the resource group

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

Property Value

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

listResourceGroupLevelByRegion

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

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

Property Value

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

listSubscriptionLevelByRegion

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

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

Property Value

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

simulate

Simulate security alerts

simulate: (ascLocation: string, alertSimulatorRequestBody: AlertSimulatorRequestBody, options?: AlertsSimulateOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(ascLocation: string, alertSimulatorRequestBody: AlertSimulatorRequestBody, options?: AlertsSimulateOptionalParams) => PollerLike<OperationState<void>, void>

updateResourceGroupLevelStateToActivate

Update the alert's state

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

Property Value

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

updateResourceGroupLevelStateToDismiss

Update the alert's state

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

Property Value

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

updateResourceGroupLevelStateToInProgress

Update the alert's state

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

Property Value

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

updateResourceGroupLevelStateToResolve

Update the alert's state

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

Property Value

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

updateSubscriptionLevelStateToActivate

Update the alert's state

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

Property Value

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

updateSubscriptionLevelStateToDismiss

Update the alert's state

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

Property Value

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

updateSubscriptionLevelStateToInProgress

Update the alert's state

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

Property Value

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

updateSubscriptionLevelStateToResolve

Update the alert's state

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

Property Value

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