AlertsImpl | @azure/arm-security

Class containing Alerts operations.

Hierarchy

AlertsImpl

Implements

Alerts

Index

Constructors

constructor

Methods

Constructors

constructor

new AlertsImpl(client: SecurityCenter): AlertsImpl

- Defined in operations/alerts.ts:54
Initialize a new instance of the class Alerts class.

Parameters
- client: SecurityCenter
  
  Reference to the service client
Returns AlertsImpl

Methods

beginSimulate

beginSimulate(ascLocation: string, alertSimulatorRequestBody: AlertSimulatorRequestBody, options?: AlertsSimulateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of Alerts.beginSimulate
- Defined in operations/alerts.ts:561
Simulate security alerts

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
- Optional options: AlertsSimulateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginSimulateAndWait

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

Implementation of Alerts.beginSimulateAndWait
- Defined in operations/alerts.ts:626
Simulate security alerts

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
- Optional options: AlertsSimulateOptionalParams
  
  The options parameters.
Returns Promise<void>

getResourceGroupLevel

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

Implementation of Alerts.getResourceGroupLevel
- Defined in operations/alerts.ts:386
Get an alert that is associated a resource group or a resource in a resource group

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
- Optional options: AlertsGetResourceGroupLevelOptionalParams
  
  The options parameters.
Returns Promise<AlertsGetResourceGroupLevelResponse>

getSubscriptionLevel

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

Implementation of Alerts.getSubscriptionLevel
- Defined in operations/alerts.ts:366
Get an alert that is associated with a subscription

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
- Optional options: AlertsGetSubscriptionLevelOptionalParams
  
  The options parameters.
Returns Promise<AlertsGetSubscriptionLevelResponse>

list

list(options?: AlertsListOptionalParams): PagedAsyncIterableIterator<Alert>

Implementation of Alerts.list
- Defined in operations/alerts.ts:68
List all the alerts that are associated with the subscription

Parameters
- Optional options: AlertsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Alert>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: AlertsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Alert>

Implementation of Alerts.listByResourceGroup
- Defined in operations/alerts.ts:112
List all the alerts that are associated with the resource group

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription. The name is case insensitive.
- Optional options: AlertsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Alert>

listResourceGroupLevelByRegion

listResourceGroupLevelByRegion(ascLocation: string, resourceGroupName: string, options?: AlertsListResourceGroupLevelByRegionOptionalParams): PagedAsyncIterableIterator<Alert>

Implementation of Alerts.listResourceGroupLevelByRegion
- Defined in operations/alerts.ts:232
List all the alerts that are associated with the resource group that are stored in a specific location

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.
- Optional options: AlertsListResourceGroupLevelByRegionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Alert>

listSubscriptionLevelByRegion

listSubscriptionLevelByRegion(ascLocation: string, options?: AlertsListSubscriptionLevelByRegionOptionalParams): PagedAsyncIterableIterator<Alert>

Implementation of Alerts.listSubscriptionLevelByRegion
- Defined in operations/alerts.ts:166
List all the alerts that are associated with the subscription that are stored in a specific location

Parameters
- ascLocation: string
  
  The location where ASC stores the data of the subscription. can be retrieved from Get locations
- Optional options: AlertsListSubscriptionLevelByRegionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Alert>

updateResourceGroupLevelStateToActivate

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

Implementation of Alerts.updateResourceGroupLevelStateToActivate
- Defined in operations/alerts.ts:521
Update the alert's state

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
- Optional options: AlertsUpdateResourceGroupLevelStateToActivateOptionalParams
  
  The options parameters.
Returns Promise<void>

updateResourceGroupLevelStateToDismiss

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

Implementation of Alerts.updateResourceGroupLevelStateToDismiss
- Defined in operations/alerts.ts:500
Update the alert's state

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
- Optional options: AlertsUpdateResourceGroupLevelStateToDismissOptionalParams
  
  The options parameters.
Returns Promise<void>

updateResourceGroupLevelStateToInProgress

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

Implementation of Alerts.updateResourceGroupLevelStateToInProgress
- Defined in operations/alerts.ts:542
Update the alert's state

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
- Optional options: AlertsUpdateResourceGroupLevelStateToInProgressOptionalParams
  
  The options parameters.
Returns Promise<void>

updateResourceGroupLevelStateToResolve

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

Implementation of Alerts.updateResourceGroupLevelStateToResolve
- Defined in operations/alerts.ts:479
Update the alert's state

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
- Optional options: AlertsUpdateResourceGroupLevelStateToResolveOptionalParams
  
  The options parameters.
Returns Promise<void>

updateSubscriptionLevelStateToActivate

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

Implementation of Alerts.updateSubscriptionLevelStateToActivate
- Defined in operations/alerts.ts:441
Update the alert's state

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
- Optional options: AlertsUpdateSubscriptionLevelStateToActivateOptionalParams
  
  The options parameters.
Returns Promise<void>

updateSubscriptionLevelStateToDismiss

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

Implementation of Alerts.updateSubscriptionLevelStateToDismiss
- Defined in operations/alerts.ts:405
Update the alert's state

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
- Optional options: AlertsUpdateSubscriptionLevelStateToDismissOptionalParams
  
  The options parameters.
Returns Promise<void>

updateSubscriptionLevelStateToInProgress

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

Implementation of Alerts.updateSubscriptionLevelStateToInProgress
- Defined in operations/alerts.ts:459
Update the alert's state

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
- Optional options: AlertsUpdateSubscriptionLevelStateToInProgressOptionalParams
  
  The options parameters.
Returns Promise<void>

updateSubscriptionLevelStateToResolve

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

Implementation of Alerts.updateSubscriptionLevelStateToResolve
- Defined in operations/alerts.ts:423
Update the alert's state

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
- Optional options: AlertsUpdateSubscriptionLevelStateToResolveOptionalParams
  
  The options parameters.
Returns Promise<void>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: SecurityCenter

Returns AlertsImpl

Methods

beginSimulate

Parameters

ascLocation: string

alertSimulatorRequestBody: AlertSimulatorRequestBody

Optional options: AlertsSimulateOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginSimulateAndWait

Parameters

ascLocation: string

alertSimulatorRequestBody: AlertSimulatorRequestBody

Optional options: AlertsSimulateOptionalParams

Returns Promise<void>

getResourceGroupLevel

Parameters

resourceGroupName: string

ascLocation: string

alertName: string

Optional options: AlertsGetResourceGroupLevelOptionalParams

Returns Promise<AlertsGetResourceGroupLevelResponse>

getSubscriptionLevel

Parameters

ascLocation: string

alertName: string

Optional options: AlertsGetSubscriptionLevelOptionalParams

Returns Promise<AlertsGetSubscriptionLevelResponse>

list

Parameters

Optional options: AlertsListOptionalParams

Returns PagedAsyncIterableIterator<Alert>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: AlertsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<Alert>

listResourceGroupLevelByRegion

Parameters

ascLocation: string

resourceGroupName: string

Optional options: AlertsListResourceGroupLevelByRegionOptionalParams

Returns PagedAsyncIterableIterator<Alert>

listSubscriptionLevelByRegion

Parameters

ascLocation: string

Optional options: AlertsListSubscriptionLevelByRegionOptionalParams

Returns PagedAsyncIterableIterator<Alert>

updateResourceGroupLevelStateToActivate

Parameters

resourceGroupName: string

ascLocation: string

alertName: string

Optional options: AlertsUpdateResourceGroupLevelStateToActivateOptionalParams

Returns Promise<void>

updateResourceGroupLevelStateToDismiss

Parameters

resourceGroupName: string

ascLocation: string

alertName: string

Optional options: AlertsUpdateResourceGroupLevelStateToDismissOptionalParams

Returns Promise<void>

updateResourceGroupLevelStateToInProgress

Parameters

resourceGroupName: string

ascLocation: string

alertName: string

Optional options: AlertsUpdateResourceGroupLevelStateToInProgressOptionalParams

Returns Promise<void>

updateResourceGroupLevelStateToResolve

Parameters

resourceGroupName: string