MetricAlerts interface

Package:

@azure/arm-monitor

Interface representing a MetricAlerts.

Methods

createOrUpdate(string, string, MetricAlertResource, MetricAlertsCreateOrUpdateOptionalParams)	Create or update an metric alert definition.
delete(string, string, MetricAlertsDeleteOptionalParams)	Delete an alert rule definition.
get(string, string, MetricAlertsGetOptionalParams)	Retrieve an alert rule definition.
listByResourceGroup(string, MetricAlertsListByResourceGroupOptionalParams)	Retrieve alert rule definitions in a resource group.
listBySubscription(MetricAlertsListBySubscriptionOptionalParams)	Retrieve alert rule definitions in a subscription.
update(string, string, MetricAlertResourcePatch, MetricAlertsUpdateOptionalParams)	Update an metric alert definition.

Method Details

createOrUpdate(string, string, MetricAlertResource, MetricAlertsCreateOrUpdateOptionalParams)

Create or update an metric alert definition.

function createOrUpdate(resourceGroupName: string, ruleName: string, parameters: MetricAlertResource, options?: MetricAlertsCreateOrUpdateOptionalParams): Promise<MetricAlertResource>

Parameters

resourceGroupName

string

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

ruleName

string

The name of the rule.

parameters

MetricAlertResource

The parameters of the rule to create or update.

options

MetricAlertsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<MetricAlertResource>

delete(string, string, MetricAlertsDeleteOptionalParams)

Delete an alert rule definition.

function delete(resourceGroupName: string, ruleName: string, options?: MetricAlertsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

ruleName

string

The name of the rule.

options

MetricAlertsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, MetricAlertsGetOptionalParams)

Retrieve an alert rule definition.

function get(resourceGroupName: string, ruleName: string, options?: MetricAlertsGetOptionalParams): Promise<MetricAlertResource>

Parameters

resourceGroupName

string

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

ruleName

string

The name of the rule.

options

MetricAlertsGetOptionalParams

The options parameters.

Returns

Promise<MetricAlertResource>

listByResourceGroup(string, MetricAlertsListByResourceGroupOptionalParams)

Retrieve alert rule definitions in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: MetricAlertsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<MetricAlertResource, MetricAlertResource[], PageSettings>

Parameters

resourceGroupName

string

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

options

MetricAlertsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MetricAlertResource, MetricAlertResource[], PageSettings>

listBySubscription(MetricAlertsListBySubscriptionOptionalParams)

Retrieve alert rule definitions in a subscription.

function listBySubscription(options?: MetricAlertsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<MetricAlertResource, MetricAlertResource[], PageSettings>

Parameters

options

MetricAlertsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MetricAlertResource, MetricAlertResource[], PageSettings>

update(string, string, MetricAlertResourcePatch, MetricAlertsUpdateOptionalParams)

Update an metric alert definition.

function update(resourceGroupName: string, ruleName: string, parameters: MetricAlertResourcePatch, options?: MetricAlertsUpdateOptionalParams): Promise<MetricAlertResource>

Parameters

resourceGroupName

string

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

ruleName

string

The name of the rule.

parameters

MetricAlertResourcePatch

The parameters of the rule to update.

options

MetricAlertsUpdateOptionalParams

The options parameters.

Returns

Promise<MetricAlertResource>