Package version:

Interface Alerts

Interface representing a Alerts.

Hierarchy

Alerts

Index

Methods

beginSimulate beginSimulateAndWait getResourceGroupLevel getSubscriptionLevel list listByResourceGroup listResourceGroupLevelByRegion listSubscriptionLevelByRegion updateResourceGroupLevelStateToActivate updateResourceGroupLevelStateToDismiss updateResourceGroupLevelStateToInProgress updateResourceGroupLevelStateToResolve updateSubscriptionLevelStateToActivate updateSubscriptionLevelStateToDismiss updateSubscriptionLevelStateToInProgress updateSubscriptionLevelStateToResolve

Methods

beginSimulate

beginSimulate(ascLocation: string, alertSimulatorRequestBody: AlertSimulatorRequestBody, options?: AlertsSimulateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
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>>
- Defined in operationsInterfaces/alerts.ts:217

beginSimulateAndWait

beginSimulateAndWait(ascLocation: string, alertSimulatorRequestBody: AlertSimulatorRequestBody, options?: AlertsSimulateOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/alerts.ts:229

getResourceGroupLevel

getResourceGroupLevel(resourceGroupName: string, ascLocation: string, alertName: string, options?: AlertsGetResourceGroupLevelOptionalParams): Promise<Alert>
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<Alert>
- Defined in operationsInterfaces/alerts.ts:96

getSubscriptionLevel

getSubscriptionLevel(ascLocation: string, alertName: string, options?: AlertsGetSubscriptionLevelOptionalParams): Promise<Alert>
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<Alert>
- Defined in operationsInterfaces/alerts.ts:82

list

list(options?: AlertsListOptionalParams): PagedAsyncIterableIterator<Alert>
List all the alerts that are associated with the subscription
Parameters
- Optional options: AlertsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Alert>
- Defined in operationsInterfaces/alerts.ts:40

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: AlertsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Alert>
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>
- Defined in operationsInterfaces/alerts.ts:47

listResourceGroupLevelByRegion

listResourceGroupLevelByRegion(ascLocation: string, resourceGroupName: string, options?: AlertsListResourceGroupLevelByRegionOptionalParams): PagedAsyncIterableIterator<Alert>
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>
- Defined in operationsInterfaces/alerts.ts:70

listSubscriptionLevelByRegion

listSubscriptionLevelByRegion(ascLocation: string, options?: AlertsListSubscriptionLevelByRegionOptionalParams): PagedAsyncIterableIterator<Alert>
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>
- Defined in operationsInterfaces/alerts.ts:57

updateResourceGroupLevelStateToActivate

updateResourceGroupLevelStateToActivate(resourceGroupName: string, ascLocation: string, alertName: string, options?: AlertsUpdateResourceGroupLevelStateToActivateOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/alerts.ts:189

updateResourceGroupLevelStateToDismiss

updateResourceGroupLevelStateToDismiss(resourceGroupName: string, ascLocation: string, alertName: string, options?: AlertsUpdateResourceGroupLevelStateToDismissOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/alerts.ts:174

updateResourceGroupLevelStateToInProgress

updateResourceGroupLevelStateToInProgress(resourceGroupName: string, ascLocation: string, alertName: string, options?: AlertsUpdateResourceGroupLevelStateToInProgressOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/alerts.ts:204

updateResourceGroupLevelStateToResolve

updateResourceGroupLevelStateToResolve(resourceGroupName: string, ascLocation: string, alertName: string, options?: AlertsUpdateResourceGroupLevelStateToResolveOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/alerts.ts:159

updateSubscriptionLevelStateToActivate

updateSubscriptionLevelStateToActivate(ascLocation: string, alertName: string, options?: AlertsUpdateSubscriptionLevelStateToActivateOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/alerts.ts:133

updateSubscriptionLevelStateToDismiss

updateSubscriptionLevelStateToDismiss(ascLocation: string, alertName: string, options?: AlertsUpdateSubscriptionLevelStateToDismissOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/alerts.ts:109

updateSubscriptionLevelStateToInProgress

updateSubscriptionLevelStateToInProgress(ascLocation: string, alertName: string, options?: AlertsUpdateSubscriptionLevelStateToInProgressOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/alerts.ts:145

updateSubscriptionLevelStateToResolve

updateSubscriptionLevelStateToResolve(ascLocation: string, alertName: string, options?: AlertsUpdateSubscriptionLevelStateToResolveOptionalParams): Promise<void>
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>
- Defined in operationsInterfaces/alerts.ts:121

Interface Alerts

Hierarchy

Index

Methods

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<Alert>

getSubscriptionLevel

Parameters

ascLocation: string

alertName: string

Optional options: AlertsGetSubscriptionLevelOptionalParams

Returns Promise<Alert>

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

ascLocation: string

alertName: string

Optional options: AlertsUpdateResourceGroupLevelStateToResolveOptionalParams

Returns Promise<void>

updateSubscriptionLevelStateToActivate

Parameters

`Optional` options: AlertsSimulateOptionalParams

`Optional` options: AlertsSimulateOptionalParams

`Optional` options: AlertsGetResourceGroupLevelOptionalParams

`Optional` options: AlertsGetSubscriptionLevelOptionalParams

`Optional` options: AlertsListOptionalParams

`Optional` options: AlertsListByResourceGroupOptionalParams

`Optional` options: AlertsListResourceGroupLevelByRegionOptionalParams

`Optional` options: AlertsListSubscriptionLevelByRegionOptionalParams

`Optional` options: AlertsUpdateResourceGroupLevelStateToActivateOptionalParams

`Optional` options: AlertsUpdateResourceGroupLevelStateToDismissOptionalParams

`Optional` options: AlertsUpdateResourceGroupLevelStateToInProgressOptionalParams

`Optional` options: AlertsUpdateResourceGroupLevelStateToResolveOptionalParams

`Optional` options: AlertsUpdateSubscriptionLevelStateToActivateOptionalParams

`Optional` options: AlertsUpdateSubscriptionLevelStateToDismissOptionalParams

`Optional` options: AlertsUpdateSubscriptionLevelStateToInProgressOptionalParams

`Optional` options: AlertsUpdateSubscriptionLevelStateToResolveOptionalParams