AlertRules interface

Package:

@azure/arm-securityinsight

Interface representing a AlertRules.

Methods

createOrUpdate(string, string, string, AlertRuleUnion, AlertRulesCreateOrUpdateOptionalParams)	Creates or updates the alert rule.
delete(string, string, string, AlertRulesDeleteOptionalParams)	Delete the alert rule.
get(string, string, string, AlertRulesGetOptionalParams)	Gets the alert rule.
list(string, string, AlertRulesListOptionalParams)	Gets all alert rules.

Method Details

createOrUpdate(string, string, string, AlertRuleUnion, AlertRulesCreateOrUpdateOptionalParams)

Creates or updates the alert rule.

function createOrUpdate(resourceGroupName: string, workspaceName: string, ruleId: string, alertRule: AlertRuleUnion, options?: AlertRulesCreateOrUpdateOptionalParams): Promise<AlertRuleUnion>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

ruleId

string

Alert rule ID

alertRule

AlertRuleUnion

The alert rule

options

AlertRulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<AlertRuleUnion>

delete(string, string, string, AlertRulesDeleteOptionalParams)

Delete the alert rule.

function delete(resourceGroupName: string, workspaceName: string, ruleId: string, options?: AlertRulesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

ruleId

string

Alert rule ID

options

AlertRulesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, AlertRulesGetOptionalParams)

Gets the alert rule.

function get(resourceGroupName: string, workspaceName: string, ruleId: string, options?: AlertRulesGetOptionalParams): Promise<AlertRuleUnion>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

ruleId

string

Alert rule ID

options

AlertRulesGetOptionalParams

The options parameters.

Returns

Promise<AlertRuleUnion>

list(string, string, AlertRulesListOptionalParams)

Gets all alert rules.

function list(resourceGroupName: string, workspaceName: string, options?: AlertRulesListOptionalParams): PagedAsyncIterableIterator<AlertRuleUnion, AlertRuleUnion[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

options

AlertRulesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AlertRuleUnion, AlertRuleUnion[], PageSettings>