Alerts interface
Interface representing a Alerts.
Methods
Method Details
getResourceGroupLevel(string, string, string, AlertsGetResourceGroupLevelOptionalParams)
Get an alert that is associated a resource group or a resource in a resource group
function getResourceGroupLevel(ascLocation: string, alertName: string, resourceGroupName: string, options?: AlertsGetResourceGroupLevelOptionalParams): 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
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
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
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
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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
The options parameters.
Returns
simulate(string, AlertSimulatorRequestBody, AlertsSimulateOptionalParams)
Simulate security alerts
function simulate(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>
updateResourceGroupLevelStateToActivate(string, string, string, AlertsUpdateResourceGroupLevelStateToActivateOptionalParams)
Update the alert's state
function updateResourceGroupLevelStateToActivate(ascLocation: string, alertName: string, resourceGroupName: string, options?: AlertsUpdateResourceGroupLevelStateToActivateOptionalParams): 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
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
The options parameters.
Returns
Promise<void>
updateResourceGroupLevelStateToDismiss(string, string, string, AlertsUpdateResourceGroupLevelStateToDismissOptionalParams)
Update the alert's state
function updateResourceGroupLevelStateToDismiss(ascLocation: string, alertName: string, resourceGroupName: string, options?: AlertsUpdateResourceGroupLevelStateToDismissOptionalParams): 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
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
The options parameters.
Returns
Promise<void>
updateResourceGroupLevelStateToResolve(string, string, string, AlertsUpdateResourceGroupLevelStateToResolveOptionalParams)
Update the alert's state
function updateResourceGroupLevelStateToResolve(ascLocation: string, alertName: string, resourceGroupName: string, options?: AlertsUpdateResourceGroupLevelStateToResolveOptionalParams): 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
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
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
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
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
The options parameters.
Returns
Promise<void>